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.



26021
26022
26023
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 26021

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) 


25840
25841
25842
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25840

def client_operation_id
  @client_operation_id
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


25845
25846
25847
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25845

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) 


25851
25852
25853
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25851

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) 


25857
25858
25859
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25857

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:



25863
25864
25865
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25863

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) 


25869
25870
25871
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25869

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) 


25876
25877
25878
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25876

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) 


25882
25883
25884
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25882

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) 


25888
25889
25890
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25888

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) 


25894
25895
25896
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25894

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:



25929
25930
25931
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25929

def metadata
  @metadata
end

#name ⇒ String

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

Returns:

  • (String) 


25934
25935
25936
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25934

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) 


25940
25941
25942
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25940

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) 


25946
25947
25948
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25946

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) 


25954
25955
25956
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25954

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) 


25960
25961
25962
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25960

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


25965
25966
25967
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25965

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) 


25970
25971
25972
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25970

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) 


25976
25977
25978
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25976

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) 


25982
25983
25984
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25982

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) 


25988
25989
25990
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25988

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) 


25994
25995
25996
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 25994

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) 


26001
26002
26003
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 26001

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) 


26007
26008
26009
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 26007

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:



26013
26014
26015
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 26013

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) 


26019
26020
26021
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 26019

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



26026
26027
26028
26029
26030
26031
26032
26033
26034
26035
26036
26037
26038
26039
26040
26041
26042
26043
26044
26045
26046
26047
26048
26049
26050
26051
26052
26053
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 26026

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