Class protos.google.cloud.translation.v3.BatchTranslateMetadata (6.1.0)

Represents a BatchTranslateMetadata.

Package

@google-cloud/translate!

Constructors

(constructor)(properties)

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

Constructs a new BatchTranslateMetadata.

Parameter

Name	Description
properties	`IBatchTranslateMetadata` Properties to set

Properties

failedCharacters

public failedCharacters: (number|Long|string);

BatchTranslateMetadata failedCharacters.

Property Value

Type	Description
(number\|Long\|string)

state

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

BatchTranslateMetadata state.

Property Value

Type	Description
(google.cloud.translation.v3.BatchTranslateMetadata.State\|keyof typeof google.cloud.translation.v3.BatchTranslateMetadata.State)

submitTime

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

BatchTranslateMetadata submitTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

totalCharacters

public totalCharacters: (number|Long|string);

BatchTranslateMetadata totalCharacters.

Property Value

Type	Description
(number\|Long\|string)

translatedCharacters

public translatedCharacters: (number|Long|string);

BatchTranslateMetadata translatedCharacters.

Property Value

Type	Description
(number\|Long\|string)

Methods

create(properties)

public static create(properties?: google.cloud.translation.v3.IBatchTranslateMetadata): google.cloud.translation.v3.BatchTranslateMetadata;

Creates a new BatchTranslateMetadata instance using the specified properties.

Parameter

Name	Description
properties	`IBatchTranslateMetadata` Properties to set

Returns

Type	Description
google.cloud.translation.v3.BatchTranslateMetadata	BatchTranslateMetadata instance

decode(reader, length)

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

Decodes a BatchTranslateMetadata message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

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

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

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

encode(message, writer)

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

Encodes the specified BatchTranslateMetadata message. Does not implicitly messages.

Parameters

Name	Description
message	`IBatchTranslateMetadata` BatchTranslateMetadata message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

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

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

Parameters

Name	Description
message	`IBatchTranslateMetadata` BatchTranslateMetadata message or plain object to encode
writer	`$protobuf.Writer` Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.translation.v3.BatchTranslateMetadata;

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

Parameter

Name	Description
object	`{ [k: string]: any }` Plain object

Returns

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

toJSON()

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

Converts this BatchTranslateMetadata to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.translation.v3.BatchTranslateMetadata` BatchTranslateMetadata
options	`$protobuf.IConversionOptions` Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a BatchTranslateMetadata message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not