Class protos.google.cloud.compute.v1small.Operation (4.8.0)

Represents an Operation.

Package

@google-cloud/compute

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.compute.v1small.IOperation);

Constructs a new Operation.

Parameter
Name Description
properties IOperation

Properties to set

Properties

_clientOperationId

public _clientOperationId?: "clientOperationId";

Operation _clientOperationId.

_creationTimestamp

public _creationTimestamp?: "creationTimestamp";

Operation _creationTimestamp.

_description

public _description?: "description";

Operation _description.

_endTime

public _endTime?: "endTime";

Operation _endTime.

_error

public _error?: "error";

Operation _error.

_httpErrorMessage

public _httpErrorMessage?: "httpErrorMessage";

Operation _httpErrorMessage.

_httpErrorStatusCode

public _httpErrorStatusCode?: "httpErrorStatusCode";

Operation _httpErrorStatusCode.

_id

public _id?: "id";

Operation _id.

_insertTime

public _insertTime?: "insertTime";

Operation _insertTime.

_kind

public _kind?: "kind";

Operation _kind.

_name

public _name?: "name";

Operation _name.

_operationType

public _operationType?: "operationType";

Operation _operationType.

_progress

public _progress?: "progress";

Operation _progress.

_region

public _region?: "region";

Operation _region.

_selfLink

public _selfLink?: "selfLink";

Operation _selfLink.

_startTime

public _startTime?: "startTime";

Operation _startTime.

_status

public _status?: "status";

Operation _status.

_statusMessage

public _statusMessage?: "statusMessage";

Operation _statusMessage.

_targetId

public _targetId?: "targetId";

Operation _targetId.

_targetLink

public _targetLink?: "targetLink";

Operation _targetLink.

_user

public _user?: "user";

Operation _user.

_zone

public _zone?: "zone";

Operation _zone.

clientOperationId

public clientOperationId?: (string|null);

Operation clientOperationId.

creationTimestamp

public creationTimestamp?: (string|null);

Operation creationTimestamp.

description

public description?: (string|null);

Operation description.

endTime

public endTime?: (string|null);

Operation endTime.

error

public error?: (google.cloud.compute.v1small.IError|null);

Operation error.

httpErrorMessage

public httpErrorMessage?: (string|null);

Operation httpErrorMessage.

httpErrorStatusCode

public httpErrorStatusCode?: (number|null);

Operation httpErrorStatusCode.

id

public id?: (number|Long|string|null);

Operation id.

insertTime

public insertTime?: (string|null);

Operation insertTime.

kind

public kind?: (string|null);

Operation kind.

name

public name?: (string|null);

Operation name.

operationType

public operationType?: (string|null);

Operation operationType.

progress

public progress?: (number|null);

Operation progress.

region

public region?: (string|null);

Operation region.

selfLink

public selfLink?: (string|null);

Operation selfLink.

startTime

public startTime?: (string|null);

Operation startTime.

status

public status?: (google.cloud.compute.v1small.Operation.Status|keyof typeof google.cloud.compute.v1small.Operation.Status|null);

Operation status.

statusMessage

public statusMessage?: (string|null);

Operation statusMessage.

targetId

public targetId?: (number|Long|string|null);

Operation targetId.

targetLink

public targetLink?: (string|null);

Operation targetLink.

user

public user?: (string|null);

Operation user.

warnings

public warnings: google.cloud.compute.v1small.IWarnings[];

Operation warnings.

zone

public zone?: (string|null);

Operation zone.

Methods

create(properties)

public static create(properties?: google.cloud.compute.v1small.IOperation): google.cloud.compute.v1small.Operation;

Creates a new Operation instance using the specified properties.

Parameter
Name Description
properties IOperation

Properties to set
Returns
Type Description
Operation

Operation instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1small.Operation;

Decodes an Operation message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
length number

Message length if known beforehand
Returns
Type Description
Operation

Operation

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1small.Operation;

Decodes an Operation message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from
Returns
Type Description
Operation

Operation

encode(message, writer)

public static encode(message: google.cloud.compute.v1small.IOperation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Operation message. Does not implicitly messages.

Parameters
Name Description
message IOperation

Operation 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.compute.v1small.IOperation, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IOperation

Operation 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.compute.v1small.Operation;

Creates an Operation 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
Operation

Operation

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Operation

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")
Returns
Type Description
string

The default type url

toJSON()

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

Converts this Operation to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message Operation

Operation
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 Operation 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