Class protos.google.longrunning.CancelOperationRequest (3.0.2)

Represents a CancelOperationRequest.

Package

@google-cloud/documentai!

Constructors

(constructor)(properties)

constructor(properties?: google.longrunning.ICancelOperationRequest);

Constructs a new CancelOperationRequest.

Parameter
NameDescription
properties google.longrunning.ICancelOperationRequest

Properties to set

Properties

name

public name: string;

CancelOperationRequest name.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.longrunning.ICancelOperationRequest): google.longrunning.CancelOperationRequest;

Creates a new CancelOperationRequest instance using the specified properties.

Parameter
NameDescription
properties google.longrunning.ICancelOperationRequest

Properties to set

Returns
TypeDescription
google.longrunning.CancelOperationRequest

CancelOperationRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.longrunning.CancelOperationRequest;

Decodes a CancelOperationRequest 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.longrunning.CancelOperationRequest

CancelOperationRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.longrunning.CancelOperationRequest;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.longrunning.CancelOperationRequest

CancelOperationRequest

encode(message, writer)

public static encode(message: google.longrunning.ICancelOperationRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CancelOperationRequest message. Does not implicitly messages.

Parameters
NameDescription
message google.longrunning.ICancelOperationRequest

CancelOperationRequest 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.longrunning.ICancelOperationRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message google.longrunning.ICancelOperationRequest

CancelOperationRequest 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.longrunning.CancelOperationRequest;

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

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

Plain object

Returns
TypeDescription
google.longrunning.CancelOperationRequest

CancelOperationRequest

toJSON()

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

Converts this CancelOperationRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.longrunning.CancelOperationRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.longrunning.CancelOperationRequest

CancelOperationRequest

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 CancelOperationRequest 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