Class protos.google.cloud.vision.v1.BatchOperationMetadata (2.4.2)

Represents a BatchOperationMetadata.

Package

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.vision.v1.IBatchOperationMetadata);

Constructs a new BatchOperationMetadata.

Parameter

Name	Description
properties	`IBatchOperationMetadata` Properties to set

Properties

endTime

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

BatchOperationMetadata endTime.

state

public state: (google.cloud.vision.v1.BatchOperationMetadata.State|keyof typeof google.cloud.vision.v1.BatchOperationMetadata.State);

BatchOperationMetadata state.

submitTime

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

BatchOperationMetadata submitTime.

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1.IBatchOperationMetadata): google.cloud.vision.v1.BatchOperationMetadata;

Creates a new BatchOperationMetadata instance using the specified properties.

Parameter

Name	Description
properties	`IBatchOperationMetadata` Properties to set

Returns

Type	Description
google.cloud.vision.v1.BatchOperationMetadata	BatchOperationMetadata instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.vision.v1.BatchOperationMetadata;

Decodes a BatchOperationMetadata 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.vision.v1.BatchOperationMetadata	BatchOperationMetadata

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.vision.v1.BatchOperationMetadata;

Decodes a BatchOperationMetadata 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.vision.v1.BatchOperationMetadata	BatchOperationMetadata

encode(message, writer)

public static encode(message: google.cloud.vision.v1.IBatchOperationMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified BatchOperationMetadata message. Does not implicitly messages.

Parameters

Name	Description
message	`IBatchOperationMetadata` BatchOperationMetadata 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.vision.v1.IBatchOperationMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IBatchOperationMetadata` BatchOperationMetadata 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.vision.v1.BatchOperationMetadata;

Creates a BatchOperationMetadata 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.vision.v1.BatchOperationMetadata	BatchOperationMetadata

toJSON()

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

Converts this BatchOperationMetadata to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.vision.v1.BatchOperationMetadata` BatchOperationMetadata
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 BatchOperationMetadata 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