Class: Google::Apis::ComputeAlpha::Operation

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_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

Constructor Details

#initialize(**args) ⇒ Operation

Returns a new instance of Operation.



25733
25734
25735
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25733

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) 


25552
25553
25554
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25552

def client_operation_id
  @client_operation_id
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


25557
25558
25559
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25557

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) 


25563
25564
25565
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25563

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) 


25569
25570
25571
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25569

def end_time
  @end_time
end

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



25575
25576
25577
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25575

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) 


25581
25582
25583
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25581

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) 


25588
25589
25590
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25588

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) 


25594
25595
25596
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25594

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) 


25600
25601
25602
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25600

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) 


25606
25607
25608
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25606

def kind
  @kind
end

#metadata ⇒ Google::Apis::ComputeAlpha::Any

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) ... Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) foo = any. unpack(Foo.class); Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any. Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo... any, err := anypb.New(foo) if err != nil ... ... foo := &pb.Foo`if err := any.UnmarshalTo(foo); err != nil ... The pack methods provided by protobuf library will by default use 'type. googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example " foo.bar.com/x/y.z" will yield type name "y.z". JSON ==== The JSON representation of anAnyvalue uses the regular representation of the deserialized, embedded message, with an additional field @typewhich contains the type URL. Example: package google.profile; message Person string first_name = 1; string last_name = 2; "@type": "type.googleapis.com/google.profile.Person", "firstName": , " lastName": If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a fieldvalue which holds the custom JSON in addition to the@typefield. Example (for message [google.protobuf.Duration][]): "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" Corresponds to the JSON propertymetadata`

Returns:



25641
25642
25643
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25641

def metadata
  @metadata
end

#name ⇒ String

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

Returns:

  • (String) 


25646
25647
25648
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25646

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) 


25652
25653
25654
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25652

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) 


25658
25659
25660
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25658

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) 


25666
25667
25668
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25666

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) 


25672
25673
25674
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25672

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


25677
25678
25679
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25677

def self_link
  @self_link
end

#self_link_with_id ⇒ String

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

Returns:

  • (String) 


25682
25683
25684
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25682

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


25688
25689
25690
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25688

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) 


25694
25695
25696
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25694

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) 


25700
25701
25702
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25700

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) 


25706
25707
25708
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25706

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) 


25713
25714
25715
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25713

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) 


25719
25720
25721
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25719

def user
  @user
end

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



25725
25726
25727
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25725

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) 


25731
25732
25733
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25731

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



25738
25739
25740
25741
25742
25743
25744
25745
25746
25747
25748
25749
25750
25751
25752
25753
25754
25755
25756
25757
25758
25759
25760
25761
25762
25763
25764
25765
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25738

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