Class: Google::Apis::LifesciencesV2beta::Operation

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



895
896
897
# File 'lib/google/apis/lifesciences_v2beta/classes.rb', line 895

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)


866
867
868
# File 'lib/google/apis/lifesciences_v2beta/classes.rb', line 866

def done
  @done
end

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



877
878
879
# File 'lib/google/apis/lifesciences_v2beta/classes.rb', line 877

def error
  @error
end

#metadataHash<String,Object>

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

Returns:

  • (Hash<String,Object>)


882
883
884
# File 'lib/google/apis/lifesciences_v2beta/classes.rb', line 882

def 
  @metadata
end

#nameString

The server-assigned name for the operation. This may be passed to the other operation methods to retrieve information about the operation's status. Corresponds to the JSON property name

Returns:

  • (String)


888
889
890
# File 'lib/google/apis/lifesciences_v2beta/classes.rb', line 888

def name
  @name
end

#responseHash<String,Object>

An Empty object. Corresponds to the JSON property response

Returns:

  • (Hash<String,Object>)


893
894
895
# File 'lib/google/apis/lifesciences_v2beta/classes.rb', line 893

def response
  @response
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



900
901
902
903
904
905
906
# File 'lib/google/apis/lifesciences_v2beta/classes.rb', line 900

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