Class protos.google.cloud.translation.v3.BatchTranslateResponse (8.0.3)

Represents a BatchTranslateResponse.

Package

@google-cloud/translate

Constructors

(constructor)(properties)

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

Constructs a new BatchTranslateResponse.

Parameter
NameDescription
properties IBatchTranslateResponse

Properties to set

Properties

endTime

public endTime?: (google.protobuf.ITimestamp|null);

BatchTranslateResponse endTime.

failedCharacters

public failedCharacters: (number|Long|string);

BatchTranslateResponse failedCharacters.

submitTime

public submitTime?: (google.protobuf.ITimestamp|null);

BatchTranslateResponse submitTime.

totalCharacters

public totalCharacters: (number|Long|string);

BatchTranslateResponse totalCharacters.

translatedCharacters

public translatedCharacters: (number|Long|string);

BatchTranslateResponse translatedCharacters.

Methods

create(properties)

public static create(properties?: google.cloud.translation.v3.IBatchTranslateResponse): google.cloud.translation.v3.BatchTranslateResponse;

Creates a new BatchTranslateResponse instance using the specified properties.

Parameter
NameDescription
properties IBatchTranslateResponse

Properties to set

Returns
TypeDescription
BatchTranslateResponse

BatchTranslateResponse instance

decode(reader, length)

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

Decodes a BatchTranslateResponse 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
BatchTranslateResponse

BatchTranslateResponse

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
BatchTranslateResponse

BatchTranslateResponse

encode(message, writer)

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

Encodes the specified BatchTranslateResponse message. Does not implicitly messages.

Parameters
NameDescription
message IBatchTranslateResponse

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

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

Parameters
NameDescription
message IBatchTranslateResponse

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

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

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

Plain object

Returns
TypeDescription
BatchTranslateResponse

BatchTranslateResponse

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BatchTranslateResponse

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message BatchTranslateResponse

BatchTranslateResponse

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