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. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta. regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.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


1007
1008
1009
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 1007

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


870
871
872
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 870

def client_operation_id
  @client_operation_id
end

#creation_timestampString

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


875
876
877
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 875

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


881
882
883
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 881

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


887
888
889
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 887

def end_time
  @end_time
end

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


893
894
895
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 893

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


899
900
901
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 899

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


906
907
908
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 906

def http_error_status_code
  @http_error_status_code
end

#idFixnum

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


912
913
914
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 912

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


918
919
920
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 918

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


924
925
926
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 924

def kind
  @kind
end

#nameString

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


929
930
931
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 929

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


935
936
937
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 935

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


943
944
945
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 943

def progress
  @progress
end

#regionString

[Output Only] The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. Corresponds to the JSON property region


951
952
953
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 951

def region
  @region
end

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


956
957
958
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 956

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


962
963
964
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 962

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


968
969
970
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 968

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


974
975
976
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 974

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


980
981
982
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 980

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


987
988
989
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 987

def target_link
  @target_link
end

#userString

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


992
993
994
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 992

def user
  @user
end

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


998
999
1000
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 998

def warnings
  @warnings
end

#zoneString

[Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. Corresponds to the JSON property zone


1005
1006
1007
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 1005

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
# File 'generated/google/apis/deploymentmanager_v2/classes.rb', line 1012

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