Class: Google::Apis::DeploymentmanagerAlpha::Operation

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/deploymentmanager_alpha/classes.rb,
generated/google/apis/deploymentmanager_alpha/representations.rb,
generated/google/apis/deploymentmanager_alpha/representations.rb

Overview

An Operation resource, used to manage asynchronous API requests.

Defined Under Namespace

Classes: Error, Warning

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Operation

Returns a new instance of Operation



1263
1264
1265
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1263

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

Instance Attribute Details

#client_operation_id ⇒ String

[Output Only] Reserved for future use. Corresponds to the JSON property clientOperationId

Returns:

  • (String) 


1129
1130
1131
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1129

def client_operation_id
  @client_operation_id
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


1134
1135
1136
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1134

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) 


1140
1141
1142
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1140

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) 


1146
1147
1148
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1146

def end_time
  @end_time
end

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



1152
1153
1154
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1152

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) 


1158
1159
1160
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1158

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) 


1165
1166
1167
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1165

def http_error_status_code
  @http_error_status_code
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1171
1172
1173
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1171

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) 


1177
1178
1179
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1177

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) 


1183
1184
1185
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1183

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


1188
1189
1190
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1188

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


1194
1195
1196
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1194

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) 


1202
1203
1204
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1202

def progress
  @progress
end

#region ⇒ String

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

Returns:

  • (String) 


1208
1209
1210
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1208

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


1213
1214
1215
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1213

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) 


1219
1220
1221
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1219

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) 


1225
1226
1227
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1225

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) 


1231
1232
1233
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1231

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) 


1237
1238
1239
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1237

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) 


1244
1245
1246
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1244

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) 


1249
1250
1251
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1249

def user
  @user
end

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



1255
1256
1257
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1255

def warnings
  @warnings
end

#zone ⇒ String

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

Returns:

  • (String) 


1261
1262
1263
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1261

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
 
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1268

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_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