Class: Google::Apis::FileV1::OperationMetadata

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

Overview

Represents the metadata of the long-running operation.

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) ⇒ OperationMetadata

Returns a new instance of OperationMetadata



294
295
296
 
# File 'generated/google/apis/file_v1/classes.rb', line 294

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

Instance Attribute Details

#api_version ⇒ String

[Output only] API version used to start the operation. Corresponds to the JSON property apiVersion

Returns:

  • (String) 


258
259
260
 
# File 'generated/google/apis/file_v1/classes.rb', line 258

def api_version
  @api_version
end

#cancel_requested ⇒ Boolean Also known as: cancel_requested?

[Output only] Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED. Corresponds to the JSON property cancelRequested

Returns:

  • (Boolean) 


266
267
268
 
# File 'generated/google/apis/file_v1/classes.rb', line 266

def cancel_requested
  @cancel_requested
end

#create_time ⇒ String

[Output only] The time the operation was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


272
273
274
 
# File 'generated/google/apis/file_v1/classes.rb', line 272

def create_time
  @create_time
end

#end_time ⇒ String

[Output only] The time the operation finished running. Corresponds to the JSON property endTime

Returns:

  • (String) 


277
278
279
 
# File 'generated/google/apis/file_v1/classes.rb', line 277

def end_time
  @end_time
end

#status_detail ⇒ String

[Output only] Human-readable status of the operation, if any. Corresponds to the JSON property statusDetail

Returns:

  • (String) 


282
283
284
 
# File 'generated/google/apis/file_v1/classes.rb', line 282

def status_detail
  @status_detail
end

#target ⇒ String

[Output only] Server-defined resource path for the target of the operation. Corresponds to the JSON property target

Returns:

  • (String) 


287
288
289
 
# File 'generated/google/apis/file_v1/classes.rb', line 287

def target
  @target
end

#verb ⇒ String

[Output only] Name of the verb executed by the operation. Corresponds to the JSON property verb

Returns:

  • (String) 


292
293
294
 
# File 'generated/google/apis/file_v1/classes.rb', line 292

def verb
  @verb
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



299
300
301
302
303
304
305
306
307
 
# File 'generated/google/apis/file_v1/classes.rb', line 299

def update!(**args)
  @api_version = args[:api_version] if args.key?(:api_version)
  @cancel_requested = args[:cancel_requested] if args.key?(:cancel_requested)
  @create_time = args[:create_time] if args.key?(:create_time)
  @end_time = args[:end_time] if args.key?(:end_time)
  @status_detail = args[:status_detail] if args.key?(:status_detail)
  @target = args[:target] if args.key?(:target)
  @verb = args[:verb] if args.key?(:verb)
end