Compute Engine v1 API - Class Operation (2.17.0)

public sealed class Operation : IMessage<Operation>, IEquatable<Operation>, IDeepCloneable<Operation>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class Operation.

Represents an Operation resource. Google Compute Engine has three Operation resources: * Global * Regional * Zonal You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the globalOperations resource. - For regional operations, use the regionOperations resource. - For zonal operations, use the zoneOperations resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.

Inheritance

object > Operation

Implements

IMessage Operation, IEquatable Operation, IDeepCloneable Operation, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

Operation()

public Operation()

Operation(Operation)

public Operation(Operation other)

Parameter
Name	Description
`other`	`Operation`

Properties

ClientOperationId

public string ClientOperationId { get; set; }

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

Property Value
Type	Description
`string`

CreationTimestamp

public string CreationTimestamp { get; set; }

[Deprecated] This field is deprecated.

Property Value
Type	Description
`string`

Description

public string Description { get; set; }

[Output Only] A textual description of the operation, which is set when the operation is created.

Property Value
Type	Description
`string`

EndTime

public string EndTime { get; set; }

[Output Only] The time that this operation was completed. This value is in RFC3339 text format.

Property Value
Type	Description
`string`

Error

public Error Error { get; set; }

[Output Only] If errors are generated during processing of the operation, this field will be populated.

Property Value
Type	Description
`Error`

HasClientOperationId

public bool HasClientOperationId { get; }

Gets whether the "client_operation_id" field is set

Property Value
Type	Description
`bool`

HasCreationTimestamp

public bool HasCreationTimestamp { get; }

Gets whether the "creation_timestamp" field is set

Property Value
Type	Description
`bool`

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type	Description
`bool`

HasEndTime

public bool HasEndTime { get; }

Gets whether the "end_time" field is set

Property Value
Type	Description
`bool`

HasHttpErrorMessage

public bool HasHttpErrorMessage { get; }

Gets whether the "http_error_message" field is set

Property Value
Type	Description
`bool`

HasHttpErrorStatusCode

public bool HasHttpErrorStatusCode { get; }

Gets whether the "http_error_status_code" field is set

Property Value
Type	Description
`bool`

HasId

public bool HasId { get; }

Gets whether the "id" field is set

Property Value
Type	Description
`bool`

HasInsertTime

public bool HasInsertTime { get; }

Gets whether the "insert_time" field is set

Property Value
Type	Description
`bool`

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
Type	Description
`bool`

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type	Description
`bool`

HasOperationGroupId

public bool HasOperationGroupId { get; }

Gets whether the "operation_group_id" field is set

Property Value
Type	Description
`bool`

HasOperationType

public bool HasOperationType { get; }

Gets whether the "operation_type" field is set

Property Value
Type	Description
`bool`

HasProgress

public bool HasProgress { get; }

Gets whether the "progress" field is set

Property Value
Type	Description
`bool`

HasRegion

public bool HasRegion { get; }

Gets whether the "region" field is set

Property Value
Type	Description
`bool`

HasSelfLink

public bool HasSelfLink { get; }

Gets whether the "self_link" field is set

Property Value
Type	Description
`bool`

HasStartTime

public bool HasStartTime { get; }

Gets whether the "start_time" field is set

Property Value
Type	Description
`bool`

HasStatus

public bool HasStatus { get; }

Gets whether the "status" field is set

Property Value
Type	Description
`bool`

HasStatusMessage

public bool HasStatusMessage { get; }

Gets whether the "status_message" field is set

Property Value
Type	Description
`bool`

HasTargetId

public bool HasTargetId { get; }

Gets whether the "target_id" field is set

Property Value
Type	Description
`bool`

HasTargetLink

public bool HasTargetLink { get; }

Gets whether the "target_link" field is set

Property Value
Type	Description
`bool`

HasUser

public bool HasUser { get; }

Gets whether the "user" field is set

Property Value
Type	Description
`bool`

HasZone

public bool HasZone { get; }

Gets whether the "zone" field is set

Property Value
Type	Description
`bool`

HttpErrorMessage

public string HttpErrorMessage { get; set; }

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

Property Value
Type	Description
`string`

HttpErrorStatusCode

public int HttpErrorStatusCode { get; set; }

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found.

Property Value
Type	Description
`int`

Id

public ulong Id { get; set; }

[Output Only] The unique identifier for the operation. This identifier is defined by the server.

Property Value
Type	Description
`ulong`

InsertTime

public string InsertTime { get; set; }

[Output Only] The time that this operation was requested. This value is in RFC3339 text format.

Property Value
Type	Description
`string`

InstancesBulkInsertOperationMetadata

public InstancesBulkInsertOperationMetadata InstancesBulkInsertOperationMetadata { get; set; }

Property Value
Type	Description
`InstancesBulkInsertOperationMetadata`

Kind

public string Kind { get; set; }

[Output Only] Type of the resource. Always compute#operation for Operation resources.

Property Value
Type	Description
`string`

Name

public string Name { get; set; }

[Output Only] Name of the operation.

Property Value
Type	Description
`string`

OperationGroupId

public string OperationGroupId { get; set; }

[Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

Property Value
Type	Description
`string`

OperationType

public string OperationType { get; set; }

[Output Only] The type of operation, such as insert, update, or delete, and so on.

Property Value
Type	Description
`string`

Progress

public int Progress { get; set; }

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

Property Value
Type	Description
`int`

Region

public string Region { get; set; }

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

Property Value
Type	Description
`string`

SelfLink

public string SelfLink { get; set; }

[Output Only] Server-defined URL for the resource.

Property Value
Type	Description
`string`

SetCommonInstanceMetadataOperationMetadata

public SetCommonInstanceMetadataOperationMetadata SetCommonInstanceMetadataOperationMetadata { get; set; }

[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.

Property Value
Type	Description
`SetCommonInstanceMetadataOperationMetadata`

StartTime

public string StartTime { get; set; }

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

Property Value
Type	Description
`string`

Status

public Operation.Types.Status Status { get; set; }

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

Property Value
Type	Description
`OperationTypesStatus`

StatusMessage

public string StatusMessage { get; set; }

[Output Only] An optional textual description of the current status of the operation.

Property Value
Type	Description
`string`

TargetId

public ulong TargetId { get; set; }

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

Property Value
Type	Description
`ulong`

TargetLink

public string TargetLink { get; set; }

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

Property Value
Type	Description
`string`

User

public string User { get; set; }

[Output Only] User who requested the operation, for example: user@example.com or alice_smith_identifier (global/workforcePools/example-com-us-employees).

Property Value
Type	Description
`string`

Warnings

public RepeatedField<Warnings> Warnings { get; }

[Output Only] If warning messages are generated during processing of the operation, this field will be populated.

Property Value
Type	Description
`RepeatedFieldWarnings`

Zone

public string Zone { get; set; }

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

Property Value
Type	Description
`string`