BatchTranslateDocumentMetadata

google.cloud.translation.v3beta1. BatchTranslateDocumentMetadata

Represents a BatchTranslateDocumentMetadata.

Constructor

new BatchTranslateDocumentMetadata(propertiesopt)

Constructs a new BatchTranslateDocumentMetadata.

Parameters:
Name Type Attributes Description
properties google.cloud.translation.v3beta1.IBatchTranslateDocumentMetadata <optional>

Properties to set

Implements:
  • IBatchTranslateDocumentMetadata

Members

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

RUNNING number

RUNNING value

SUCCEEDED number

SUCCEEDED value

FAILED number

FAILED value

CANCELLING number

CANCELLING value

CANCELLED number

CANCELLED value

failedCharacters

BatchTranslateDocumentMetadata failedCharacters.

failedPages

BatchTranslateDocumentMetadata failedPages.

state

BatchTranslateDocumentMetadata state.

submitTime

BatchTranslateDocumentMetadata submitTime.

totalBillableCharacters

BatchTranslateDocumentMetadata totalBillableCharacters.

totalBillablePages

BatchTranslateDocumentMetadata totalBillablePages.

totalCharacters

BatchTranslateDocumentMetadata totalCharacters.

totalPages

BatchTranslateDocumentMetadata totalPages.

translatedCharacters

BatchTranslateDocumentMetadata translatedCharacters.

translatedPages

BatchTranslateDocumentMetadata translatedPages.

Methods

(static) create(propertiesopt) → {google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata}

Creates a new BatchTranslateDocumentMetadata instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.translation.v3beta1.IBatchTranslateDocumentMetadata <optional>

Properties to set

Returns:
Type Description
google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata

BatchTranslateDocumentMetadata instance

(static) decode(reader, lengthopt) → {google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata}

Decodes a BatchTranslateDocumentMetadata message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata

BatchTranslateDocumentMetadata

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata

BatchTranslateDocumentMetadata

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified BatchTranslateDocumentMetadata message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.translation.v3beta1.IBatchTranslateDocumentMetadata

BatchTranslateDocumentMetadata message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.translation.v3beta1.IBatchTranslateDocumentMetadata

BatchTranslateDocumentMetadata message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata

BatchTranslateDocumentMetadata

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.translation.v3beta1.BatchTranslateDocumentMetadata

BatchTranslateDocumentMetadata

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a BatchTranslateDocumentMetadata message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

toJSON() → {Object.<string, *>}

Converts this BatchTranslateDocumentMetadata to JSON.

Returns:
Type Description
Object.<string, *>

JSON object