Class: Google::Apis::ComputeAlpha::Operation

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb

Overview

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.

Defined Under Namespace

Classes: Error, Warning

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Operation

Returns a new instance of Operation.



33115
33116
33117
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33115

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#client_operation_id ⇒ String

[Output Only] The value of requestId if you provided it in the request. Not present otherwise. Corresponds to the JSON property clientOperationId

Returns:

  • (String) 


32958
32959
32960
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32958

def client_operation_id
  @client_operation_id
end

#creation_timestamp ⇒ String

[Deprecated] This field is deprecated. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


32963
32964
32965
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32963

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

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

Returns:

  • (String) 


32969
32970
32971
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32969

def description
  @description
end

#end_time ⇒ String

[Output Only] The time that this operation was completed. This value is in RFC3339 text format. Corresponds to the JSON property endTime

Returns:

  • (String) 


32975
32976
32977
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32975

def end_time
  @end_time
end

#error ⇒ Google::Apis::ComputeAlpha::Operation::Error

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

Returns:



32981
32982
32983
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32981

def error
  @error
end

#http_error_message ⇒ String

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

Returns:

  • (String) 


32987
32988
32989
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32987

def http_error_message
  @http_error_message
end

#http_error_status_code ⇒ Fixnum

[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. Corresponds to the JSON property httpErrorStatusCode

Returns:

  • (Fixnum) 


32994
32995
32996
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 32994

def http_error_status_code
  @http_error_status_code
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the operation. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


33000
33001
33002
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33000

def id
  @id
end

#insert_time ⇒ String

[Output Only] The time that this operation was requested. This value is in RFC3339 text format. Corresponds to the JSON property insertTime

Returns:

  • (String) 


33006
33007
33008
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33006

def insert_time
  @insert_time
end

#instances_bulk_insert_operation_metadata ⇒ Google::Apis::ComputeAlpha::InstancesBulkInsertOperationMetadata

Corresponds to the JSON property instancesBulkInsertOperationMetadata

Returns:



33011
33012
33013
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33011

def instances_bulk_insert_operation_metadata
  @instances_bulk_insert_operation_metadata
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#operation for Operation resources. Corresponds to the JSON property kind

Returns:

  • (String) 


33017
33018
33019
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33017

def kind
  @kind
end

#name ⇒ String

[Output Only] Name of the operation. Corresponds to the JSON property name

Returns:

  • (String) 


33022
33023
33024
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33022

def name
  @name
end

#operation_group_id ⇒ String

[Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request. Corresponds to the JSON property operationGroupId

Returns:

  • (String) 


33028
33029
33030
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33028

def operation_group_id
  @operation_group_id
end

#operation_type ⇒ String

[Output Only] The type of operation, such as insert, update, or delete, and so on. Corresponds to the JSON property operationType

Returns:

  • (String) 


33034
33035
33036
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33034

def operation_type
  @operation_type
end

#progress ⇒ Fixnum

[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. Corresponds to the JSON property progress

Returns:

  • (Fixnum) 


33042
33043
33044
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33042

def progress
  @progress
end

#region ⇒ String

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

Returns:

  • (String) 


33048
33049
33050
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33048

def region
  @region
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


33053
33054
33055
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33053

def self_link
  @self_link
end

#self_link_with_id ⇒ String

[Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


33058
33059
33060
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33058

def self_link_with_id
  @self_link_with_id
end

#set_common_instance_metadata_operation_metadata ⇒ Google::Apis::ComputeAlpha::SetCommonInstanceMetadataOperationMetadata

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

Returns:



33064
33065
33066
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33064

def set_common_instance_metadata_operation_metadata
  @set_common_instance_metadata_operation_metadata
end

#start_time ⇒ String

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

Returns:

  • (String) 


33070
33071
33072
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33070

def start_time
  @start_time
end

#status ⇒ String

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

Returns:

  • (String) 


33076
33077
33078
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33076

def status
  @status
end

#status_message ⇒ String

[Output Only] An optional textual description of the current status of the operation. Corresponds to the JSON property statusMessage

Returns:

  • (String) 


33082
33083
33084
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33082

def status_message
  @status_message
end

#target_id ⇒ Fixnum

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource. Corresponds to the JSON property targetId

Returns:

  • (Fixnum) 


33088
33089
33090
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33088

def target_id
  @target_id
end

#target_link ⇒ String

[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. Corresponds to the JSON property targetLink

Returns:

  • (String) 


33095
33096
33097
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33095

def target_link
  @target_link
end

#user ⇒ String

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

Returns:

  • (String) 


33101
33102
33103
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33101

def user
  @user
end

#warnings ⇒ Array<Google::Apis::ComputeAlpha::Operation::Warning>

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

Returns:



33107
33108
33109
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33107

def warnings
  @warnings
end

#zone ⇒ String

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

Returns:

  • (String) 


33113
33114
33115
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33113

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



33120
33121
33122
33123
33124
33125
33126
33127
33128
33129
33130
33131
33132
33133
33134
33135
33136
33137
33138
33139
33140
33141
33142
33143
33144
33145
33146
33147
33148
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 33120

def update!(**args)
  @client_operation_id = args[:client_operation_id] if args.key?(:client_operation_id)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @end_time = args[:end_time] if args.key?(:end_time)
  @error = args[:error] if args.key?(:error)
  @http_error_message = args[:http_error_message] if args.key?(:http_error_message)
  @http_error_status_code = args[:http_error_status_code] if args.key?(:http_error_status_code)
  @id = args[:id] if args.key?(:id)
  @insert_time = args[:insert_time] if args.key?(:insert_time)
  @instances_bulk_insert_operation_metadata = args[:instances_bulk_insert_operation_metadata] if args.key?(:instances_bulk_insert_operation_metadata)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @operation_group_id = args[:operation_group_id] if args.key?(:operation_group_id)
  @operation_type = args[:operation_type] if args.key?(:operation_type)
  @progress = args[:progress] if args.key?(:progress)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @set_common_instance_metadata_operation_metadata = args[:set_common_instance_metadata_operation_metadata] if args.key?(:set_common_instance_metadata_operation_metadata)
  @start_time = args[:start_time] if args.key?(:start_time)
  @status = args[:status] if args.key?(:status)
  @status_message = args[:status_message] if args.key?(:status_message)
  @target_id = args[:target_id] if args.key?(:target_id)
  @target_link = args[:target_link] if args.key?(:target_link)
  @user = args[:user] if args.key?(:user)
  @warnings = args[:warnings] if args.key?(:warnings)
  @zone = args[:zone] if args.key?(:zone)
end