Class protos.google.api.servicecontrol.v2.CheckRequest (2.2.0)

Represents a CheckRequest.

Package

@google-cloud/service-control

Constructors

(constructor)(properties)

constructor(properties?: google.api.servicecontrol.v2.ICheckRequest);

Constructs a new CheckRequest.

Parameter
NameDescription
properties google.api.servicecontrol.v2.ICheckRequest

Properties to set

Properties

attributes

public attributes?: (google.rpc.context.IAttributeContext|null);

CheckRequest attributes.

flags

public flags: string;

CheckRequest flags.

resources

public resources: google.api.servicecontrol.v2.IResourceInfo[];

CheckRequest resources.

serviceConfigId

public serviceConfigId: string;

CheckRequest serviceConfigId.

serviceName

public serviceName: string;

CheckRequest serviceName.

Methods

create(properties)

public static create(properties?: google.api.servicecontrol.v2.ICheckRequest): google.api.servicecontrol.v2.CheckRequest;

Creates a new CheckRequest instance using the specified properties.

Parameter
NameDescription
properties google.api.servicecontrol.v2.ICheckRequest

Properties to set

Returns
TypeDescription
google.api.servicecontrol.v2.CheckRequest

CheckRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.servicecontrol.v2.CheckRequest;

Decodes a CheckRequest message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.api.servicecontrol.v2.CheckRequest

CheckRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.servicecontrol.v2.CheckRequest;

Decodes a CheckRequest message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.api.servicecontrol.v2.CheckRequest

CheckRequest

encode(message, writer)

public static encode(message: google.api.servicecontrol.v2.ICheckRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CheckRequest message. Does not implicitly messages.

Parameters
NameDescription
message google.api.servicecontrol.v2.ICheckRequest

CheckRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.api.servicecontrol.v2.ICheckRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CheckRequest message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message google.api.servicecontrol.v2.ICheckRequest

CheckRequest message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.api.servicecontrol.v2.CheckRequest;

Creates a CheckRequest message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.api.servicecontrol.v2.CheckRequest

CheckRequest

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for CheckRequest

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this CheckRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.api.servicecontrol.v2.CheckRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a CheckRequest message. Also converts values to other types if specified.

Parameters
NameDescription
message google.api.servicecontrol.v2.CheckRequest

CheckRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a CheckRequest message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not