Class protos.google.cloud.translation.v3.BatchTranslateDocumentRequest

Represents a BatchTranslateDocumentRequest.

Package

@google-cloud/translate

Constructors

(constructor)(properties)

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

Constructs a new BatchTranslateDocumentRequest.

Parameter
NameDescription
properties IBatchTranslateDocumentRequest

Properties to set

Properties

formatConversions

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

BatchTranslateDocumentRequest formatConversions.

glossaries

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

BatchTranslateDocumentRequest glossaries.

inputConfigs

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

BatchTranslateDocumentRequest inputConfigs.

models

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

BatchTranslateDocumentRequest models.

outputConfig

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

BatchTranslateDocumentRequest outputConfig.

parent

public parent: string;

BatchTranslateDocumentRequest parent.

sourceLanguageCode

public sourceLanguageCode: string;

BatchTranslateDocumentRequest sourceLanguageCode.

targetLanguageCodes

public targetLanguageCodes: string[];

BatchTranslateDocumentRequest targetLanguageCodes.

Methods

create(properties)

public static create(properties?: google.cloud.translation.v3.IBatchTranslateDocumentRequest): google.cloud.translation.v3.BatchTranslateDocumentRequest;

Creates a new BatchTranslateDocumentRequest instance using the specified properties.

Parameter
NameDescription
properties IBatchTranslateDocumentRequest

Properties to set

Returns
TypeDescription
google.cloud.translation.v3.BatchTranslateDocumentRequest

BatchTranslateDocumentRequest instance

decode(reader, length)

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

Decodes a BatchTranslateDocumentRequest 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.cloud.translation.v3.BatchTranslateDocumentRequest

BatchTranslateDocumentRequest

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.translation.v3.BatchTranslateDocumentRequest

BatchTranslateDocumentRequest

encode(message, writer)

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

Encodes the specified BatchTranslateDocumentRequest message. Does not implicitly messages.

Parameters
NameDescription
message IBatchTranslateDocumentRequest

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

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

Parameters
NameDescription
message IBatchTranslateDocumentRequest

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

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

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

Plain object

Returns
TypeDescription
google.cloud.translation.v3.BatchTranslateDocumentRequest

BatchTranslateDocumentRequest

toJSON()

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

Converts this BatchTranslateDocumentRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.translation.v3.BatchTranslateDocumentRequest

BatchTranslateDocumentRequest

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