Class protos.google.cloud.translation.v3.BatchTranslateTextRequest (8.5.0)

Represents a BatchTranslateTextRequest.

Package

@google-cloud/translate

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.translation.v3.IBatchTranslateTextRequest);

Constructs a new BatchTranslateTextRequest.

Parameter
Name Description
properties IBatchTranslateTextRequest

Properties to set

Properties

glossaries

public glossaries: { [k: string]: google.cloud.translation.v3.ITranslateTextGlossaryConfig };

BatchTranslateTextRequest glossaries.

inputConfigs

public inputConfigs: google.cloud.translation.v3.IInputConfig[];

BatchTranslateTextRequest inputConfigs.

labels

public labels: { [k: string]: string };

BatchTranslateTextRequest labels.

models

public models: { [k: string]: string };

BatchTranslateTextRequest models.

outputConfig

public outputConfig?: (google.cloud.translation.v3.IOutputConfig|null);

BatchTranslateTextRequest outputConfig.

parent

public parent: string;

BatchTranslateTextRequest parent.

sourceLanguageCode

public sourceLanguageCode: string;

BatchTranslateTextRequest sourceLanguageCode.

targetLanguageCodes

public targetLanguageCodes: string[];

BatchTranslateTextRequest targetLanguageCodes.

Methods

create(properties)

public static create(properties?: google.cloud.translation.v3.IBatchTranslateTextRequest): google.cloud.translation.v3.BatchTranslateTextRequest;

Creates a new BatchTranslateTextRequest instance using the specified properties.

Parameter
Name Description
properties IBatchTranslateTextRequest

Properties to set

Returns
Type Description
BatchTranslateTextRequest

BatchTranslateTextRequest instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.translation.v3.BatchTranslateTextRequest;

Decodes a BatchTranslateTextRequest message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
BatchTranslateTextRequest

BatchTranslateTextRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.translation.v3.BatchTranslateTextRequest;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
BatchTranslateTextRequest

BatchTranslateTextRequest

encode(message, writer)

public static encode(message: google.cloud.translation.v3.IBatchTranslateTextRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified BatchTranslateTextRequest message. Does not implicitly messages.

Parameters
Name Description
message IBatchTranslateTextRequest

BatchTranslateTextRequest 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.translation.v3.IBatchTranslateTextRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IBatchTranslateTextRequest

BatchTranslateTextRequest 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.translation.v3.BatchTranslateTextRequest;

Creates a BatchTranslateTextRequest 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
BatchTranslateTextRequest

BatchTranslateTextRequest

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BatchTranslateTextRequest

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

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message BatchTranslateTextRequest

BatchTranslateTextRequest

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 a BatchTranslateTextRequest 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