Class protos.google.cloud.speech.v2.OperationMetadata (5.3.1)

Represents an OperationMetadata.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.speech.v2.IOperationMetadata);

Constructs a new OperationMetadata.

Parameter

Name	Description
`properties`	`IOperationMetadata` Properties to set

Properties

batchRecognizeMetadata

public batchRecognizeMetadata?: (google.cloud.speech.v2.IBatchRecognizeMetadata|null);

OperationMetadata batchRecognizeMetadata.

batchRecognizeRequest

public batchRecognizeRequest?: (google.cloud.speech.v2.IBatchRecognizeRequest|null);

OperationMetadata batchRecognizeRequest.

createCustomClassRequest

public createCustomClassRequest?: (google.cloud.speech.v2.ICreateCustomClassRequest|null);

OperationMetadata createCustomClassRequest.

createPhraseSetRequest

public createPhraseSetRequest?: (google.cloud.speech.v2.ICreatePhraseSetRequest|null);

OperationMetadata createPhraseSetRequest.

createRecognizerRequest

public createRecognizerRequest?: (google.cloud.speech.v2.ICreateRecognizerRequest|null);

OperationMetadata createRecognizerRequest.

createTime

public createTime?: (google.protobuf.ITimestamp|null);

OperationMetadata createTime.

deleteCustomClassRequest

public deleteCustomClassRequest?: (google.cloud.speech.v2.IDeleteCustomClassRequest|null);

OperationMetadata deleteCustomClassRequest.

deletePhraseSetRequest

public deletePhraseSetRequest?: (google.cloud.speech.v2.IDeletePhraseSetRequest|null);

OperationMetadata deletePhraseSetRequest.

deleteRecognizerRequest

public deleteRecognizerRequest?: (google.cloud.speech.v2.IDeleteRecognizerRequest|null);

OperationMetadata deleteRecognizerRequest.

kmsKeyName

public kmsKeyName: string;

OperationMetadata kmsKeyName.

kmsKeyVersionName

public kmsKeyVersionName: string;

OperationMetadata kmsKeyVersionName.

metadata

public metadata?: "batchRecognizeMetadata";

OperationMetadata metadata.

method

public method: string;

OperationMetadata method.

progressPercent

public progressPercent: number;

OperationMetadata progressPercent.

request

public request?: ("batchRecognizeRequest"|"createRecognizerRequest"|"updateRecognizerRequest"|"deleteRecognizerRequest"|"undeleteRecognizerRequest"|"createCustomClassRequest"|"updateCustomClassRequest"|"deleteCustomClassRequest"|"undeleteCustomClassRequest"|"createPhraseSetRequest"|"updatePhraseSetRequest"|"deletePhraseSetRequest"|"undeletePhraseSetRequest"|"updateConfigRequest");

OperationMetadata request.

resource

public resource: string;

OperationMetadata resource.

undeleteCustomClassRequest

public undeleteCustomClassRequest?: (google.cloud.speech.v2.IUndeleteCustomClassRequest|null);

OperationMetadata undeleteCustomClassRequest.

undeletePhraseSetRequest

public undeletePhraseSetRequest?: (google.cloud.speech.v2.IUndeletePhraseSetRequest|null);

OperationMetadata undeletePhraseSetRequest.

undeleteRecognizerRequest

public undeleteRecognizerRequest?: (google.cloud.speech.v2.IUndeleteRecognizerRequest|null);

OperationMetadata undeleteRecognizerRequest.

updateConfigRequest

public updateConfigRequest?: (google.cloud.speech.v2.IUpdateConfigRequest|null);

OperationMetadata updateConfigRequest.

updateCustomClassRequest

public updateCustomClassRequest?: (google.cloud.speech.v2.IUpdateCustomClassRequest|null);

OperationMetadata updateCustomClassRequest.

updatePhraseSetRequest

public updatePhraseSetRequest?: (google.cloud.speech.v2.IUpdatePhraseSetRequest|null);

OperationMetadata updatePhraseSetRequest.

updateRecognizerRequest

public updateRecognizerRequest?: (google.cloud.speech.v2.IUpdateRecognizerRequest|null);

OperationMetadata updateRecognizerRequest.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

OperationMetadata updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.speech.v2.IOperationMetadata): google.cloud.speech.v2.OperationMetadata;

Creates a new OperationMetadata instance using the specified properties.

Parameter

Name	Description
`properties`	`IOperationMetadata` Properties to set

Returns

Type	Description
`google.cloud.speech.v2.OperationMetadata`	OperationMetadata instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.speech.v2.OperationMetadata;

Decodes an OperationMetadata message from the specified reader or buffer.

Parameters

Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns

Type	Description
`google.cloud.speech.v2.OperationMetadata`	OperationMetadata

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.speech.v2.OperationMetadata;

Decodes an OperationMetadata message from the specified reader or buffer, length delimited.

Parameter

Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
`google.cloud.speech.v2.OperationMetadata`	OperationMetadata

encode(message, writer)

public static encode(message: google.cloud.speech.v2.IOperationMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified OperationMetadata message. Does not implicitly messages.

Parameters

Name	Description
`message`	`IOperationMetadata` OperationMetadata message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
`$protobuf.Writer`	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.speech.v2.IOperationMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
`message`	`IOperationMetadata` OperationMetadata message or plain object to encode
`writer`	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
`$protobuf.Writer`	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.speech.v2.OperationMetadata;

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

Parameter

Name	Description
`object`	`{ [k: string]: any }` Plain object

Returns

Type	Description
`google.cloud.speech.v2.OperationMetadata`	OperationMetadata

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for OperationMetadata

Parameter

Name	Description
`typeUrlPrefix`	`string` your custom typeUrlPrefix(default "type.googleapis.com")

Returns

Type	Description
`string`	The default type url

toJSON()

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

Converts this OperationMetadata to JSON.

Returns

Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
`message`	`google.cloud.speech.v2.OperationMetadata` OperationMetadata
`options`	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
`{ [k: string]: any }`	Plain object

verify(message)

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

Verifies an OperationMetadata message.

Parameter

Name	Description
`message`	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
`(string\|null)`	`null` if valid, otherwise the reason why it is not