Class protos.google.cloud.translation.v3.BatchTranslateDocumentMetadata

Represents a BatchTranslateDocumentMetadata.

Package

@google-cloud/translate

Constructors

(constructor)(properties)

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

Constructs a new BatchTranslateDocumentMetadata.

Parameter
NameDescription
properties IBatchTranslateDocumentMetadata

Properties to set

Properties

failedCharacters

public failedCharacters: (number|Long|string);

BatchTranslateDocumentMetadata failedCharacters.

failedPages

public failedPages: (number|Long|string);

BatchTranslateDocumentMetadata failedPages.

state

public state: (google.cloud.translation.v3.BatchTranslateDocumentMetadata.State|keyof typeof google.cloud.translation.v3.BatchTranslateDocumentMetadata.State);

BatchTranslateDocumentMetadata state.

submitTime

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

BatchTranslateDocumentMetadata submitTime.

totalBillableCharacters

public totalBillableCharacters: (number|Long|string);

BatchTranslateDocumentMetadata totalBillableCharacters.

totalBillablePages

public totalBillablePages: (number|Long|string);

BatchTranslateDocumentMetadata totalBillablePages.

totalCharacters

public totalCharacters: (number|Long|string);

BatchTranslateDocumentMetadata totalCharacters.

totalPages

public totalPages: (number|Long|string);

BatchTranslateDocumentMetadata totalPages.

translatedCharacters

public translatedCharacters: (number|Long|string);

BatchTranslateDocumentMetadata translatedCharacters.

translatedPages

public translatedPages: (number|Long|string);

BatchTranslateDocumentMetadata translatedPages.

Methods

create(properties)

public static create(properties?: google.cloud.translation.v3.IBatchTranslateDocumentMetadata): google.cloud.translation.v3.BatchTranslateDocumentMetadata;

Creates a new BatchTranslateDocumentMetadata instance using the specified properties.

Parameter
NameDescription
properties IBatchTranslateDocumentMetadata

Properties to set

Returns
TypeDescription
google.cloud.translation.v3.BatchTranslateDocumentMetadata

BatchTranslateDocumentMetadata instance

decode(reader, length)

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

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

BatchTranslateDocumentMetadata

decodeDelimited(reader)

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

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

BatchTranslateDocumentMetadata

encode(message, writer)

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

Encodes the specified BatchTranslateDocumentMetadata message. Does not implicitly messages.

Parameters
NameDescription
message IBatchTranslateDocumentMetadata

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

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

Parameters
NameDescription
message IBatchTranslateDocumentMetadata

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

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

BatchTranslateDocumentMetadata

toJSON()

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

Converts this BatchTranslateDocumentMetadata to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

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

BatchTranslateDocumentMetadata

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