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, 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 zonalOperations resource. For more information, read Global, Regional, and Zonal Resources.

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.



27138
27139
27140
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27138

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) 


26997
26998
26999
 
# File 'lib/google/apis/compute_beta/classes.rb', line 26997

def client_operation_id
  @client_operation_id
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


27002
27003
27004
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27002

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) 


27008
27009
27010
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27008

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) 


27014
27015
27016
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27014

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:



27020
27021
27022
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27020

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) 


27026
27027
27028
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27026

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) 


27033
27034
27035
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27033

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) 


27039
27040
27041
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27039

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) 


27045
27046
27047
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27045

def insert_time
  @insert_time
end

#kind ⇒ String

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

Returns:

  • (String) 


27051
27052
27053
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27051

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


27056
27057
27058
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27056

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) 


27062
27063
27064
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27062

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) 


27068
27069
27070
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27068

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) 


27076
27077
27078
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27076

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) 


27082
27083
27084
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27082

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


27087
27088
27089
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27087

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


27093
27094
27095
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27093

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) 


27099
27100
27101
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27099

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) 


27105
27106
27107
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27105

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) 


27111
27112
27113
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27111

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) 


27118
27119
27120
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27118

def target_link
  @target_link
end

#user ⇒ String

[Output Only] User who requested the operation, for example: user@example.com . Corresponds to the JSON property user

Returns:

  • (String) 


27124
27125
27126
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27124

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:



27130
27131
27132
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27130

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) 


27136
27137
27138
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27136

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



27143
27144
27145
27146
27147
27148
27149
27150
27151
27152
27153
27154
27155
27156
27157
27158
27159
27160
27161
27162
27163
27164
27165
27166
27167
27168
 
# File 'lib/google/apis/compute_beta/classes.rb', line 27143

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