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

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.

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.



1194
1195
1196
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1194

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) 


1059
1060
1061
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1059

def client_operation_id
  @client_operation_id
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


1064
1065
1066
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1064

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) 


1070
1071
1072
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1070

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) 


1076
1077
1078
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1076

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:



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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

def kind
  @kind
end

#name ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

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) 


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

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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:



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

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) 


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

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
 
# File 'generated/google/apis/deploymentmanager_v2beta/classes.rb', line 1199

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