Class: Google::Apis::DeploymentmanagerV2beta::Operation

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



1217
1218
1219
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1217

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) 


1083
1084
1085
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1083

def client_operation_id
  @client_operation_id
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


1088
1089
1090
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1088

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) 


1094
1095
1096
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1094

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) 


1100
1101
1102
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1100

def end_time
  @end_time
end

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



1106
1107
1108
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1106

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) 


1112
1113
1114
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1112

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) 


1119
1120
1121
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1119

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) 


1125
1126
1127
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1125

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) 


1131
1132
1133
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1131

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) 


1137
1138
1139
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1137

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


1142
1143
1144
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1142

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) 


1148
1149
1150
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1148

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) 


1156
1157
1158
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1156

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) 


1162
1163
1164
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1162

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


1167
1168
1169
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1167

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) 


1173
1174
1175
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1173

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) 


1179
1180
1181
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1179

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) 


1185
1186
1187
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1185

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) 


1191
1192
1193
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1191

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) 


1198
1199
1200
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1198

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) 


1203
1204
1205
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1203

def user
  @user
end

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



1209
1210
1211
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1209

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) 


1215
1216
1217
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1215

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1222

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