Class: Google::Apis::DeploymentmanagerV2::Operation

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

Overview

An Operation resource, used to manage asynchronous API requests.

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



777
778
779
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 777

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

Instance Attribute Details

#client_operation_id ⇒ String

[Output Only] Reserved for future use. Corresponds to the JSON property clientOperationId

Returns:

  • (String) 


643
644
645
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 643

def client_operation_id
  @client_operation_id
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


648
649
650
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 648

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) 


654
655
656
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 654

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) 


660
661
662
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 660

def end_time
  @end_time
end

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



666
667
668
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 666

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) 


672
673
674
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 672

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) 


679
680
681
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 679

def http_error_status_code
  @http_error_status_code
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


685
686
687
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 685

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) 


691
692
693
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 691

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) 


697
698
699
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 697

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


702
703
704
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 702

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


708
709
710
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 708

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) 


716
717
718
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 716

def progress
  @progress
end

#region ⇒ String

[Output Only] The URL of the region where the operation resides. Only available when performing regional operations. Corresponds to the JSON property region

Returns:

  • (String) 


722
723
724
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 722

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


727
728
729
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 727

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


733
734
735
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 733

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) 


739
740
741
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 739

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) 


745
746
747
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 745

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) 


751
752
753
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 751

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) 


758
759
760
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 758

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) 


763
764
765
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 763

def user
  @user
end

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



769
770
771
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 769

def warnings
  @warnings
end

#zone ⇒ String

[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. Corresponds to the JSON property zone

Returns:

  • (String) 


775
776
777
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 775

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 782

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