Class: Google::Apis::DeploymentmanagerV2beta::Operation

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

Overview

An Operation resource, used to manage asynchronous API requests. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta. regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

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



1336
1337
1338
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1336

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

Instance Attribute Details

#client_operation_idString

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

Returns:

  • (String)


1199
1200
1201
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1199

def client_operation_id
  @client_operation_id
end

#creation_timestampString

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

Returns:

  • (String)


1204
1205
1206
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1204

def creation_timestamp
  @creation_timestamp
end

#descriptionString

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

Returns:

  • (String)


1210
1211
1212
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1210

def description
  @description
end

#end_timeString

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

Returns:

  • (String)


1216
1217
1218
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1216

def end_time
  @end_time
end

#errorGoogle::Apis::DeploymentmanagerV2beta::Operation::Error

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



1222
1223
1224
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1222

def error
  @error
end

#http_error_messageString

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


1228
1229
1230
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1228

def http_error_message
  @http_error_message
end

#http_error_status_codeFixnum

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


1235
1236
1237
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1235

def http_error_status_code
  @http_error_status_code
end

#idFixnum

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

Returns:

  • (Fixnum)


1241
1242
1243
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1241

def id
  @id
end

#insert_timeString

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

Returns:

  • (String)


1247
1248
1249
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1247

def insert_time
  @insert_time
end

#kindString

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

Returns:

  • (String)


1253
1254
1255
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1253

def kind
  @kind
end

#nameString

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

Returns:

  • (String)


1258
1259
1260
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1258

def name
  @name
end

#operation_typeString

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

Returns:

  • (String)


1264
1265
1266
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1264

def operation_type
  @operation_type
end

#progressFixnum

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


1272
1273
1274
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1272

def progress
  @progress
end

#regionString

[Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. Corresponds to the JSON property region

Returns:

  • (String)


1280
1281
1282
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1280

def region
  @region
end

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

Returns:

  • (String)


1285
1286
1287
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1285

def self_link
  @self_link
end

#start_timeString

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


1291
1292
1293
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1291

def start_time
  @start_time
end

#statusString

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


1297
1298
1299
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1297

def status
  @status
end

#status_messageString

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

Returns:

  • (String)


1303
1304
1305
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1303

def status_message
  @status_message
end

#target_idFixnum

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

Returns:

  • (Fixnum)


1309
1310
1311
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1309

def target_id
  @target_id
end

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


1316
1317
1318
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1316

def target_link
  @target_link
end

#userString

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

Returns:

  • (String)


1321
1322
1323
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1321

def user
  @user
end

#warningsArray<Google::Apis::DeploymentmanagerV2beta::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



1327
1328
1329
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1327

def warnings
  @warnings
end

#zoneString

[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. Corresponds to the JSON property zone

Returns:

  • (String)


1334
1335
1336
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1334

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1341

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