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.
Implements
Inherited Members
Namespace: Google.Apis.DeploymentManager.v2.Data
Assembly: Google.Apis.DeploymentManager.v2.dll
Syntax
public class Operation : IDirectResponseSchema
Properties
ClientOperationId
[Output Only] The value of requestId
if you provided it in the request. Not present otherwise.
Declaration
[JsonProperty("clientOperationId")]
public virtual string ClientOperationId { get; set; }
Property Value
Type | Description |
---|---|
string |
CreationTimestamp
[Deprecated] This field is deprecated.
Declaration
[JsonProperty("creationTimestamp")]
public virtual string CreationTimestamp { get; set; }
Property Value
Type | Description |
---|---|
string |
Description
[Output Only] A textual description of the operation, which is set when the operation is created.
Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
EndTime
[Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Declaration
[JsonProperty("endTime")]
public virtual string EndTime { get; set; }
Property Value
Type | Description |
---|---|
string |
Error
[Output Only] If errors are generated during processing of the operation, this field will be populated.
Declaration
[JsonProperty("error")]
public virtual Operation.ErrorData Error { get; set; }
Property Value
Type | Description |
---|---|
Operation.ErrorData |
HttpErrorMessage
[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as
NOT FOUND
.
Declaration
[JsonProperty("httpErrorMessage")]
public virtual string HttpErrorMessage { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpErrorStatusCode
[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.
Declaration
[JsonProperty("httpErrorStatusCode")]
public virtual int? HttpErrorStatusCode { get; set; }
Property Value
Type | Description |
---|---|
int? |
Id
[Output Only] The unique identifier for the operation. This identifier is defined by the server.
Declaration
[JsonProperty("id")]
public virtual ulong? Id { get; set; }
Property Value
Type | Description |
---|---|
ulong? |
InsertTime
[Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Declaration
[JsonProperty("insertTime")]
public virtual string InsertTime { get; set; }
Property Value
Type | Description |
---|---|
string |
InstancesBulkInsertOperationMetadata
Declaration
[JsonProperty("instancesBulkInsertOperationMetadata")]
public virtual InstancesBulkInsertOperationMetadata InstancesBulkInsertOperationMetadata { get; set; }
Property Value
Type | Description |
---|---|
InstancesBulkInsertOperationMetadata |
Kind
[Output Only] Type of the resource. Always compute#operation
for Operation resources.
Declaration
[JsonProperty("kind")]
public virtual string Kind { get; set; }
Property Value
Type | Description |
---|---|
string |
Name
[Output Only] Name of the operation.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
OperationGroupId
[Output Only] An ID that represents a group of operations, such as when a group of operations results from a
bulkInsert
API request.
Declaration
[JsonProperty("operationGroupId")]
public virtual string OperationGroupId { get; set; }
Property Value
Type | Description |
---|---|
string |
OperationType
[Output Only] The type of operation, such as insert
, update
, or delete
, and so on.
Declaration
[JsonProperty("operationType")]
public virtual string OperationType { get; set; }
Property Value
Type | Description |
---|---|
string |
Progress
[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.
Declaration
[JsonProperty("progress")]
public virtual int? Progress { get; set; }
Property Value
Type | Description |
---|---|
int? |
Region
[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Declaration
[JsonProperty("region")]
public virtual string Region { get; set; }
Property Value
Type | Description |
---|---|
string |
SelfLink
[Output Only] Server-defined URL for the resource.
Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type | Description |
---|---|
string |
SelfLinkWithId
[Output Only] Server-defined URL for this resource with the resource id.
Declaration
[JsonProperty("selfLinkWithId")]
public virtual string SelfLinkWithId { get; set; }
Property Value
Type | Description |
---|---|
string |
SetCommonInstanceMetadataOperationMetadata
[Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
Declaration
[JsonProperty("setCommonInstanceMetadataOperationMetadata")]
public virtual SetCommonInstanceMetadataOperationMetadata SetCommonInstanceMetadataOperationMetadata { get; set; }
Property Value
Type | Description |
---|---|
SetCommonInstanceMetadataOperationMetadata |
StartTime
[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Declaration
[JsonProperty("startTime")]
public virtual string StartTime { get; set; }
Property Value
Type | Description |
---|---|
string |
Status
[Output Only] The status of the operation, which can be one of the following: PENDING
, RUNNING
, or
DONE
.
Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type | Description |
---|---|
string |
StatusMessage
[Output Only] An optional textual description of the current status of the operation.
Declaration
[JsonProperty("statusMessage")]
public virtual string StatusMessage { get; set; }
Property Value
Type | Description |
---|---|
string |
TargetId
[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Declaration
[JsonProperty("targetId")]
public virtual ulong? TargetId { get; set; }
Property Value
Type | Description |
---|---|
ulong? |
TargetLink
[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
Declaration
[JsonProperty("targetLink")]
public virtual string TargetLink { get; set; }
Property Value
Type | Description |
---|---|
string |
User
[Output Only] User who requested the operation, for example: user@example.com
or alice_smith_identifier (global/workforcePools/example-com-us-employees)
.
Declaration
[JsonProperty("user")]
public virtual string User { get; set; }
Property Value
Type | Description |
---|---|
string |
Warnings
[Output Only] If warning messages are generated during processing of the operation, this field will be populated.
Declaration
[JsonProperty("warnings")]
public virtual IList<Operation.WarningsData> Warnings { get; set; }
Property Value
Type | Description |
---|---|
IList<Operation.WarningsData> |
Zone
[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Declaration
[JsonProperty("zone")]
public virtual string Zone { get; set; }
Property Value
Type | Description |
---|---|
string |