Class: Google::Apis::GenomicsV1::Operation

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

Overview

This resource represents a long-running operation that is the result of a network API call.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Operation

Returns a new instance of Operation.



342
343
344
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 342

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

Instance Attribute Details

#done ⇒ Boolean Also known as: done?

If the value is false, it means the operation is still in progress. If true , the operation is completed, and either error or response is available. Corresponds to the JSON property done

Returns:

  • (Boolean) 


311
312
313
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 311

def done
  @done
end

#error ⇒ Google::Apis::GenomicsV1::Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property error

Returns:



322
323
324
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 322

def error
  @error
end

#metadata ⇒ Hash<String,Object>

An OperationMetadata or Metadata object. This will always be returned with the Operation. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,Object>) 


328
329
330
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 328

def metadata
  @metadata
end

#name ⇒ String

The server-assigned name, which is only unique within the same service that originally returns it. For example: operations/CJHU7Oi_ChDrveSpBRjfuL- qzoWAgEw Corresponds to the JSON property name

Returns:

  • (String) 


335
336
337
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 335

def name
  @name
end

#response ⇒ Hash<String,Object>

An Empty object. Corresponds to the JSON property response

Returns:

  • (Hash<String,Object>) 


340
341
342
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 340

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



347
348
349
350
351
352
353
 
# File 'generated/google/apis/genomics_v1/classes.rb', line 347

def update!(**args)
  @done = args[:done] if args.key?(:done)
  @error = args[:error] if args.key?(:error)
  @metadata = args[:metadata] if args.key?(:metadata)
  @name = args[:name] if args.key?(:name)
  @response = args[:response] if args.key?(:response)
end