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

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. (== resource_for $api_version.globalOperations ==) (== resource_for $ api_version.regionOperations ==) (== resource_for $api_version. 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.


1564
1565
1566
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1564

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)

1424
1425
1426
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1424

def client_operation_id
  @client_operation_id
end

#creation_timestampString

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

Returns:

  • (String)

1429
1430
1431
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1429

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)

1435
1436
1437
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1435

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)

1441
1442
1443
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1441

def end_time
  @end_time
end

#errorGoogle::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


1447
1448
1449
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1447

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)

1453
1454
1455
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1453

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)

1460
1461
1462
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1460

def http_error_status_code
  @http_error_status_code
end

#idFixnum

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

Returns:

  • (Fixnum)

1466
1467
1468
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1466

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)

1472
1473
1474
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1472

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)

1478
1479
1480
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1478

def kind
  @kind
end

#nameString

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

Returns:

  • (String)

1483
1484
1485
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1483

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)

1489
1490
1491
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1489

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)

1497
1498
1499
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1497

def progress
  @progress
end

#regionString

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

1503
1504
1505
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1503

def region
  @region
end

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

Returns:

  • (String)

1508
1509
1510
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1508

def self_link
  @self_link
end

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

Returns:

  • (String)

1513
1514
1515
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1513

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

1519
1520
1521
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1519

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)

1525
1526
1527
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1525

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)

1531
1532
1533
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1531

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)

1537
1538
1539
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1537

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)

1544
1545
1546
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1544

def target_link
  @target_link
end

#userString

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

Returns:

  • (String)

1550
1551
1552
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1550

def user
  @user
end

#warningsArray<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


1556
1557
1558
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1556

def warnings
  @warnings
end

#zoneString

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

1562
1563
1564
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1562

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
# File 'generated/google/apis/deploymentmanager_alpha/classes.rb', line 1569

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