Class protos.google.cloud.clouddms.v1.OperationMetadata (1.0.5)

Represents an OperationMetadata.

Package

@google-cloud/dms!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.clouddms.v1.IOperationMetadata);

Constructs a new OperationMetadata.

Parameter

Name	Description
properties	`IOperationMetadata` Properties to set

Properties

apiVersion

public apiVersion: string;

OperationMetadata apiVersion.

Property Value

Type	Description
string

createTime

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

OperationMetadata createTime.

Property Value

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

endTime

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

OperationMetadata endTime.

Property Value

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

requestedCancellation

public requestedCancellation: boolean;

OperationMetadata requestedCancellation.

Property Value

Type	Description
boolean

statusMessage

public statusMessage: string;

OperationMetadata statusMessage.

Property Value

Type	Description
string

target

public target: string;

OperationMetadata target.

Property Value

Type	Description
string

verb

public verb: string;

OperationMetadata verb.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.clouddms.v1.IOperationMetadata): google.cloud.clouddms.v1.OperationMetadata;

Creates a new OperationMetadata instance using the specified properties.

Parameter

Name	Description
properties	`IOperationMetadata` Properties to set

Returns

Type	Description
google.cloud.clouddms.v1.OperationMetadata	OperationMetadata instance

decode(reader, length)

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

Decodes an OperationMetadata 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.clouddms.v1.OperationMetadata	OperationMetadata

decodeDelimited(reader)

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

Decodes an OperationMetadata 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.clouddms.v1.OperationMetadata	OperationMetadata

encode(message, writer)

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

Encodes the specified OperationMetadata message. Does not implicitly messages.

Parameters

Name	Description
message	`IOperationMetadata` OperationMetadata 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.clouddms.v1.IOperationMetadata, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IOperationMetadata` OperationMetadata 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.clouddms.v1.OperationMetadata;

Creates an OperationMetadata 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.clouddms.v1.OperationMetadata	OperationMetadata

toJSON()

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

Converts this OperationMetadata to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.clouddms.v1.OperationMetadata` OperationMetadata
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 an OperationMetadata 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