Class protos.google.cloud.translation.v3beta1.BatchTranslateDocumentResponse (8.0.3)

Represents a BatchTranslateDocumentResponse.

Package

@google-cloud/translate

Constructors

(constructor)(properties)

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

Constructs a new BatchTranslateDocumentResponse.

Parameter
NameDescription
properties IBatchTranslateDocumentResponse

Properties to set

Properties

endTime

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

BatchTranslateDocumentResponse endTime.

failedCharacters

public failedCharacters: (number|Long|string);

BatchTranslateDocumentResponse failedCharacters.

failedPages

public failedPages: (number|Long|string);

BatchTranslateDocumentResponse failedPages.

submitTime

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

BatchTranslateDocumentResponse submitTime.

totalBillableCharacters

public totalBillableCharacters: (number|Long|string);

BatchTranslateDocumentResponse totalBillableCharacters.

totalBillablePages

public totalBillablePages: (number|Long|string);

BatchTranslateDocumentResponse totalBillablePages.

totalCharacters

public totalCharacters: (number|Long|string);

BatchTranslateDocumentResponse totalCharacters.

totalPages

public totalPages: (number|Long|string);

BatchTranslateDocumentResponse totalPages.

translatedCharacters

public translatedCharacters: (number|Long|string);

BatchTranslateDocumentResponse translatedCharacters.

translatedPages

public translatedPages: (number|Long|string);

BatchTranslateDocumentResponse translatedPages.

Methods

create(properties)

public static create(properties?: google.cloud.translation.v3beta1.IBatchTranslateDocumentResponse): google.cloud.translation.v3beta1.BatchTranslateDocumentResponse;

Creates a new BatchTranslateDocumentResponse instance using the specified properties.

Parameter
NameDescription
properties IBatchTranslateDocumentResponse

Properties to set

Returns
TypeDescription
BatchTranslateDocumentResponse

BatchTranslateDocumentResponse instance

decode(reader, length)

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

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

BatchTranslateDocumentResponse

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
BatchTranslateDocumentResponse

BatchTranslateDocumentResponse

encode(message, writer)

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

Encodes the specified BatchTranslateDocumentResponse message. Does not implicitly messages.

Parameters
NameDescription
message IBatchTranslateDocumentResponse

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

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

Parameters
NameDescription
message IBatchTranslateDocumentResponse

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

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

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

Plain object

Returns
TypeDescription
BatchTranslateDocumentResponse

BatchTranslateDocumentResponse

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BatchTranslateDocumentResponse

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message BatchTranslateDocumentResponse

BatchTranslateDocumentResponse

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