Class: Google::Apis::ResourceviewsV1beta2::Operation

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


203
204
205
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 203

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

Instance Attribute Details

#client_operation_idString

[Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project. Corresponds to the JSON property clientOperationId

Returns:

  • (String)

83
84
85
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 83

def client_operation_id
  @client_operation_id
end

#creation_timestampString

[Output Only] The time that this operation was requested, in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String)

89
90
91
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 89

def creation_timestamp
  @creation_timestamp
end

#end_timeString

[Output Only] The time that this operation was completed, in RFC3339 text format. Corresponds to the JSON property endTime

Returns:

  • (String)

95
96
97
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 95

def end_time
  @end_time
end

#errorGoogle::Apis::ResourceviewsV1beta2::Operation::Error

[Output Only] If errors occurred during processing of this operation, this field will be populated. Corresponds to the JSON property error


101
102
103
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 101

def error
  @error
end

#http_error_messageString

[Output only] If operation fails, the HTTP error message returned. Corresponds to the JSON property httpErrorMessage

Returns:

  • (String)

106
107
108
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 106

def http_error_message
  @http_error_message
end

#http_error_status_codeFixnum

[Output only] If operation fails, the HTTP error status code returned. Corresponds to the JSON property httpErrorStatusCode

Returns:

  • (Fixnum)

111
112
113
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 111

def http_error_status_code
  @http_error_status_code
end

#idString

[Output Only] Unique identifier for the resource, generated by the server. Corresponds to the JSON property id

Returns:

  • (String)

116
117
118
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 116

def id
  @id
end

#insert_timeString

[Output Only] The time that this operation was requested, in RFC3339 text format. Corresponds to the JSON property insertTime

Returns:

  • (String)

122
123
124
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 122

def insert_time
  @insert_time
end

#kindString

[Output only] Type of the resource. Corresponds to the JSON property kind

Returns:

  • (String)

127
128
129
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 127

def kind
  @kind
end

#nameString

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

Returns:

  • (String)

132
133
134
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 132

def name
  @name
end

#operation_typeString

[Output only] Type of the operation. Operations include insert, update, and delete. Corresponds to the JSON property operationType

Returns:

  • (String)

138
139
140
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 138

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 at when the operation will be complete. This number should be monotonically increasing as the operation progresses. Corresponds to the JSON property progress

Returns:

  • (Fixnum)

146
147
148
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 146

def progress
  @progress
end

#regionString

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

Returns:

  • (String)

152
153
154
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 152

def region
  @region
end

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

Returns:

  • (String)

157
158
159
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 157

def self_link
  @self_link
end

#start_timeString

[Output Only] The time that this operation was started by the server, in RFC3339 text format. Corresponds to the JSON property startTime

Returns:

  • (String)

163
164
165
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 163

def start_time
  @start_time
end

#statusString

[Output Only] Status of the operation. Corresponds to the JSON property status

Returns:

  • (String)

168
169
170
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 168

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

Returns:

  • (String)

174
175
176
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 174

def status_message
  @status_message
end

#target_idString

[Output Only] Unique target ID which identifies a particular incarnation of the target. Corresponds to the JSON property targetId

Returns:

  • (String)

180
181
182
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 180

def target_id
  @target_id
end

[Output only] URL of the resource the operation is mutating. Corresponds to the JSON property targetLink

Returns:

  • (String)

185
186
187
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 185

def target_link
  @target_link
end

#userString

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

Returns:

  • (String)

190
191
192
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 190

def user
  @user
end

#warningsArray<Google::Apis::ResourceviewsV1beta2::Operation::Warning>

[Output Only] If there are issues with this operation, a warning is returned. Corresponds to the JSON property warnings


195
196
197
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 195

def warnings
  @warnings
end

#zoneString

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

Returns:

  • (String)

201
202
203
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 201

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'generated/google/apis/resourceviews_v1beta2/classes.rb', line 208

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