Class: Google::Apis::ComputeBeta::Operation

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_beta/classes.rb,
lib/google/apis/compute_beta/representations.rb,
lib/google/apis/compute_beta/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, readHandling 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.



46001
46002
46003
 
# File 'lib/google/apis/compute_beta/classes.rb', line 46001

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) 


45834
45835
45836
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45834

def client_operation_id
  @client_operation_id
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


45839
45840
45841
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45839

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) 


45845
45846
45847
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45845

def description
  @description
end

#end_time ⇒ String

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

Returns:

  • (String) 


45852
45853
45854
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45852

def end_time
  @end_time
end

#error ⇒ Google::Apis::ComputeBeta::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:



45858
45859
45860
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45858

def error
  @error
end

#get_version_operation_metadata ⇒ Google::Apis::ComputeBeta::GetVersionOperationMetadata

Corresponds to the JSON property getVersionOperationMetadata

Returns:



45863
45864
45865
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45863

def get_version_operation_metadata
  @get_version_operation_metadata
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) 


45869
45870
45871
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45869

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) 


45876
45877
45878
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45876

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) 


45882
45883
45884
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45882

def id
  @id
end

#insert_time ⇒ String

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

Returns:

  • (String) 


45889
45890
45891
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45889

def insert_time
  @insert_time
end

#instances_bulk_insert_operation_metadata ⇒ Google::Apis::ComputeBeta::InstancesBulkInsertOperationMetadata

Corresponds to the JSON property instancesBulkInsertOperationMetadata

Returns:



45894
45895
45896
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45894

def instances_bulk_insert_operation_metadata
  @instances_bulk_insert_operation_metadata
end

#kind ⇒ String

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

Returns:

  • (String) 


45901
45902
45903
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45901

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


45906
45907
45908
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45906

def name
  @name
end

#operation_group_id ⇒ String

Output only. [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) 


45913
45914
45915
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45913

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) 


45919
45920
45921
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45919

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) 


45928
45929
45930
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45928

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) 


45934
45935
45936
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45934

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


45939
45940
45941
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45939

def self_link
  @self_link
end

#set_common_instance_metadata_operation_metadata ⇒ Google::Apis::ComputeBeta::SetCommonInstanceMetadataOperationMetadata

Output only. [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:



45947
45948
45949
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45947

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 inRFC3339 text format. Corresponds to the JSON property startTime

Returns:

  • (String) 


45954
45955
45956
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45954

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) 


45961
45962
45963
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45961

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) 


45967
45968
45969
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45967

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) 


45973
45974
45975
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45973

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 disk that the snapshot was created from. Corresponds to the JSON property targetLink

Returns:

  • (String) 


45980
45981
45982
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45980

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) 


45987
45988
45989
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45987

def user
  @user
end

#warnings ⇒ Array<Google::Apis::ComputeBeta::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:



45993
45994
45995
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45993

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) 


45999
46000
46001
 
# File 'lib/google/apis/compute_beta/classes.rb', line 45999

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



46006
46007
46008
46009
46010
46011
46012
46013
46014
46015
46016
46017
46018
46019
46020
46021
46022
46023
46024
46025
46026
46027
46028
46029
46030
46031
46032
46033
46034
 
# File 'lib/google/apis/compute_beta/classes.rb', line 46006

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)
  @get_version_operation_metadata = args[:get_version_operation_metadata] if args.key?(:get_version_operation_metadata)
  @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)
  @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