Class protos.google.cloud.speech.v2.BatchRecognizeRequest (6.3.0)

Represents a BatchRecognizeRequest.

Package

@google-cloud/speech

Constructors

(constructor)(properties)

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

Constructs a new BatchRecognizeRequest.

Parameter
NameDescription
properties IBatchRecognizeRequest

Properties to set

Properties

config

public config?: (google.cloud.speech.v2.IRecognitionConfig|null);

BatchRecognizeRequest config.

configMask

public configMask?: (google.protobuf.IFieldMask|null);

BatchRecognizeRequest configMask.

files

public files: google.cloud.speech.v2.IBatchRecognizeFileMetadata[];

BatchRecognizeRequest files.

processingStrategy

public processingStrategy: (google.cloud.speech.v2.BatchRecognizeRequest.ProcessingStrategy|keyof typeof google.cloud.speech.v2.BatchRecognizeRequest.ProcessingStrategy);

BatchRecognizeRequest processingStrategy.

recognitionOutputConfig

public recognitionOutputConfig?: (google.cloud.speech.v2.IRecognitionOutputConfig|null);

BatchRecognizeRequest recognitionOutputConfig.

recognizer

public recognizer: string;

BatchRecognizeRequest recognizer.

Methods

create(properties)

public static create(properties?: google.cloud.speech.v2.IBatchRecognizeRequest): google.cloud.speech.v2.BatchRecognizeRequest;

Creates a new BatchRecognizeRequest instance using the specified properties.

Parameter
NameDescription
properties IBatchRecognizeRequest

Properties to set

Returns
TypeDescription
BatchRecognizeRequest

BatchRecognizeRequest instance

decode(reader, length)

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

Decodes a BatchRecognizeRequest message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
BatchRecognizeRequest

BatchRecognizeRequest

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
BatchRecognizeRequest

BatchRecognizeRequest

encode(message, writer)

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

Encodes the specified BatchRecognizeRequest message. Does not implicitly messages.

Parameters
NameDescription
message IBatchRecognizeRequest

BatchRecognizeRequest 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.cloud.speech.v2.IBatchRecognizeRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IBatchRecognizeRequest

BatchRecognizeRequest 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.cloud.speech.v2.BatchRecognizeRequest;

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

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

Plain object

Returns
TypeDescription
BatchRecognizeRequest

BatchRecognizeRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BatchRecognizeRequest

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 BatchRecognizeRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message BatchRecognizeRequest

BatchRecognizeRequest

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