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



29622
29623
29624
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29622

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) 


29470
29471
29472
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29470

def client_operation_id
  @client_operation_id
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


29475
29476
29477
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29475

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) 


29481
29482
29483
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29481

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) 


29487
29488
29489
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29487

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:



29493
29494
29495
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29493

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) 


29499
29500
29501
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29499

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) 


29506
29507
29508
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29506

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) 


29512
29513
29514
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29512

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) 


29518
29519
29520
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29518

def insert_time
  @insert_time
end

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

Corresponds to the JSON property instancesBulkInsertOperationMetadata

Returns:



29523
29524
29525
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29523

def instances_bulk_insert_operation_metadata
  @instances_bulk_insert_operation_metadata
end

#kind ⇒ String

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

Returns:

  • (String) 


29529
29530
29531
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29529

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


29534
29535
29536
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29534

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) 


29540
29541
29542
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29540

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) 


29546
29547
29548
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29546

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) 


29554
29555
29556
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29554

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) 


29560
29561
29562
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29560

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


29565
29566
29567
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29565

def self_link
  @self_link
end

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

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



29571
29572
29573
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29571

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

Returns:

  • (String) 


29577
29578
29579
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29577

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) 


29583
29584
29585
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29583

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) 


29589
29590
29591
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29589

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) 


29595
29596
29597
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29595

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) 


29602
29603
29604
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29602

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) 


29608
29609
29610
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29608

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:



29614
29615
29616
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29614

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) 


29620
29621
29622
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29620

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



29627
29628
29629
29630
29631
29632
29633
29634
29635
29636
29637
29638
29639
29640
29641
29642
29643
29644
29645
29646
29647
29648
29649
29650
29651
29652
29653
29654
 
# File 'lib/google/apis/compute_beta/classes.rb', line 29627

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