Class protos.google.cloud.translation.v3beta1.TranslateTextRequest

Represents a TranslateTextRequest.

Package

@google-cloud/translate

Constructors

(constructor)(properties)

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

Constructs a new TranslateTextRequest.

Parameter
NameDescription
properties google.cloud.translation.v3beta1.ITranslateTextRequest

Properties to set

Properties

contents

public contents: string[];

TranslateTextRequest contents.

glossaryConfig

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

TranslateTextRequest glossaryConfig.

labels

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

TranslateTextRequest labels.

mimeType

public mimeType: string;

TranslateTextRequest mimeType.

model

public model: string;

TranslateTextRequest model.

parent

public parent: string;

TranslateTextRequest parent.

sourceLanguageCode

public sourceLanguageCode: string;

TranslateTextRequest sourceLanguageCode.

targetLanguageCode

public targetLanguageCode: string;

TranslateTextRequest targetLanguageCode.

Methods

create(properties)

public static create(properties?: google.cloud.translation.v3beta1.ITranslateTextRequest): google.cloud.translation.v3beta1.TranslateTextRequest;

Creates a new TranslateTextRequest instance using the specified properties.

Parameter
NameDescription
properties google.cloud.translation.v3beta1.ITranslateTextRequest

Properties to set

Returns
TypeDescription
google.cloud.translation.v3beta1.TranslateTextRequest

TranslateTextRequest instance

decode(reader, length)

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

Decodes a TranslateTextRequest 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.TranslateTextRequest

TranslateTextRequest

decodeDelimited(reader)

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

Decodes a TranslateTextRequest 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.TranslateTextRequest

TranslateTextRequest

encode(message, writer)

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

Encodes the specified TranslateTextRequest message. Does not implicitly messages.

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

TranslateTextRequest 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.ITranslateTextRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

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

TranslateTextRequest 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.TranslateTextRequest;

Creates a TranslateTextRequest 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.TranslateTextRequest

TranslateTextRequest

toJSON()

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

Converts this TranslateTextRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

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

TranslateTextRequest

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