Class: Google::Apis::GenomicsV2alpha1::Operation

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

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



793
794
795
# File 'generated/google/apis/genomics_v2alpha1/classes.rb', line 793

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

Instance Attribute Details

#doneBoolean 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)


762
763
764
# File 'generated/google/apis/genomics_v2alpha1/classes.rb', line 762

def done
  @done
end

#errorGoogle::Apis::GenomicsV2alpha1::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



773
774
775
# File 'generated/google/apis/genomics_v2alpha1/classes.rb', line 773

def error
  @error
end

#metadataHash<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>)


779
780
781
# File 'generated/google/apis/genomics_v2alpha1/classes.rb', line 779

def 
  @metadata
end

#nameString

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)


786
787
788
# File 'generated/google/apis/genomics_v2alpha1/classes.rb', line 786

def name
  @name
end

#responseHash<String,Object>

An Empty object. Corresponds to the JSON property response

Returns:

  • (Hash<String,Object>)


791
792
793
# File 'generated/google/apis/genomics_v2alpha1/classes.rb', line 791

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



798
799
800
801
802
803
804
# File 'generated/google/apis/genomics_v2alpha1/classes.rb', line 798

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