Class protos.google.cloud.translation.v3beta1.TranslateDocumentRequest

Represents a TranslateDocumentRequest.

Package

@google-cloud/translate

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.translation.v3beta1.ITranslateDocumentRequest);

Constructs a new TranslateDocumentRequest.

Parameter
NameDescription
properties ITranslateDocumentRequest

Properties to set

Properties

documentInputConfig

public documentInputConfig?: (google.cloud.translation.v3beta1.IDocumentInputConfig|null);

TranslateDocumentRequest documentInputConfig.

documentOutputConfig

public documentOutputConfig?: (google.cloud.translation.v3beta1.IDocumentOutputConfig|null);

TranslateDocumentRequest documentOutputConfig.

glossaryConfig

public glossaryConfig?: (google.cloud.translation.v3beta1.ITranslateTextGlossaryConfig|null);

TranslateDocumentRequest glossaryConfig.

labels

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

TranslateDocumentRequest labels.

model

public model: string;

TranslateDocumentRequest model.

parent

public parent: string;

TranslateDocumentRequest parent.

sourceLanguageCode

public sourceLanguageCode: string;

TranslateDocumentRequest sourceLanguageCode.

targetLanguageCode

public targetLanguageCode: string;

TranslateDocumentRequest targetLanguageCode.

Methods

create(properties)

public static create(properties?: google.cloud.translation.v3beta1.ITranslateDocumentRequest): google.cloud.translation.v3beta1.TranslateDocumentRequest;

Creates a new TranslateDocumentRequest instance using the specified properties.

Parameter
NameDescription
properties ITranslateDocumentRequest

Properties to set

Returns
TypeDescription
google.cloud.translation.v3beta1.TranslateDocumentRequest

TranslateDocumentRequest instance

decode(reader, length)

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

Decodes a TranslateDocumentRequest 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.v3beta1.TranslateDocumentRequest

TranslateDocumentRequest

decodeDelimited(reader)

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

Decodes a TranslateDocumentRequest 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.v3beta1.TranslateDocumentRequest

TranslateDocumentRequest

encode(message, writer)

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

Encodes the specified TranslateDocumentRequest message. Does not implicitly messages.

Parameters
NameDescription
message ITranslateDocumentRequest

TranslateDocumentRequest 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.v3beta1.ITranslateDocumentRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ITranslateDocumentRequest

TranslateDocumentRequest 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.v3beta1.TranslateDocumentRequest;

Creates a TranslateDocumentRequest 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.v3beta1.TranslateDocumentRequest

TranslateDocumentRequest

toJSON()

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

Converts this TranslateDocumentRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.translation.v3beta1.TranslateDocumentRequest

TranslateDocumentRequest

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