BatchTranslateMetadata

google.cloud.translation.v3. BatchTranslateMetadata

Represents a BatchTranslateMetadata.

Constructor

new BatchTranslateMetadata(propertiesopt)

Constructs a new BatchTranslateMetadata.

Parameters:
Name Type Attributes Description
properties google.cloud.translation.v3.IBatchTranslateMetadata <optional>

Properties to set

Implements:
  • IBatchTranslateMetadata

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

BatchTranslateMetadata failedCharacters.

state

BatchTranslateMetadata state.

submitTime

BatchTranslateMetadata submitTime.

totalCharacters

BatchTranslateMetadata totalCharacters.

translatedCharacters

BatchTranslateMetadata translatedCharacters.

Methods

(static) create(propertiesopt) → {google.cloud.translation.v3.BatchTranslateMetadata}

Creates a new BatchTranslateMetadata instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.translation.v3.IBatchTranslateMetadata <optional>

Properties to set

Returns:
Type Description
google.cloud.translation.v3.BatchTranslateMetadata

BatchTranslateMetadata instance

(static) decode(reader, lengthopt) → {google.cloud.translation.v3.BatchTranslateMetadata}

Decodes a BatchTranslateMetadata 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.v3.BatchTranslateMetadata

BatchTranslateMetadata

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.v3.BatchTranslateMetadata}

Decodes a BatchTranslateMetadata 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.v3.BatchTranslateMetadata

BatchTranslateMetadata

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 BatchTranslateMetadata message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.translation.v3.IBatchTranslateMetadata

BatchTranslateMetadata 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 BatchTranslateMetadata message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.translation.v3.IBatchTranslateMetadata

BatchTranslateMetadata 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.v3.BatchTranslateMetadata}

Creates a BatchTranslateMetadata 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.v3.BatchTranslateMetadata

BatchTranslateMetadata

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

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

Parameters:
Name Type Attributes Description
message google.cloud.translation.v3.BatchTranslateMetadata

BatchTranslateMetadata

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a BatchTranslateMetadata 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 BatchTranslateMetadata to JSON.

Returns:
Type Description
Object.<string, *>

JSON object