Class: Google::Apis::RedisV1::Operation
- Inherits:
-
Object
- Object
- Google::Apis::RedisV1::Operation
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/redis_v1/classes.rb,
generated/google/apis/redis_v1/representations.rb,
generated/google/apis/redis_v1/representations.rb
Overview
This resource represents a long-running operation that is the result of a network API call.
Instance Attribute Summary collapse
-
#done ⇒ Boolean
(also: #done?)
If the value is
false
, it means the operation is still in progress. -
#error ⇒ Google::Apis::RedisV1::Status
The
Status
type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. -
#metadata ⇒ Hash<String,Object>
createTime`: The time the operation was created.
-
#name ⇒ String
The server-assigned name, which is only unique within the same service that originally returns it.
-
#response ⇒ Hash<String,Object>
The normal response of the operation in case of success.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Operation
constructor
A new instance of Operation.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Operation
Returns a new instance of Operation.
623 624 625 |
# File 'generated/google/apis/redis_v1/classes.rb', line 623 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
575 576 577 |
# File 'generated/google/apis/redis_v1/classes.rb', line 575 def done @done end |
#error ⇒ Google::Apis::RedisV1::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
586 587 588 |
# File 'generated/google/apis/redis_v1/classes.rb', line 586 def error @error end |
#metadata ⇒ Hash<String,Object>
createTime: The time the operation was created.
endTime: The time the operation finished running.
target: Server-defined resource path for the target of the operation.
verb: Name of the verb executed by the operation.
statusDetail: Human-readable status of the operation, if any.
cancelRequested: 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.
apiVersion: API version used to start the operation.
Corresponds to the JSON property metadata
602 603 604 |
# File 'generated/google/apis/redis_v1/classes.rb', line 602 def @metadata end |
#name ⇒ String
The server-assigned name, which is only unique within the same service that
originally returns it. If you use the default HTTP mapping, the
name
should be a resource name ending with operations/
unique_id`.
Corresponds to the JSON property
name`
609 610 611 |
# File 'generated/google/apis/redis_v1/classes.rb', line 609 def name @name end |
#response ⇒ Hash<String,Object>
The normal response of the operation in case of success. If the original
method returns no data on success, such as Delete
, the response is
google.protobuf.Empty
. If the original method is standard
Get
/Create
/Update
, the response should be the resource. For other
methods, the response should have the type XxxResponse
, where Xxx
is the original method name. For example, if the original method name
is TakeSnapshot()
, the inferred response type is
TakeSnapshotResponse
.
Corresponds to the JSON property response
621 622 623 |
# File 'generated/google/apis/redis_v1/classes.rb', line 621 def response @response end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
628 629 630 631 632 633 634 |
# File 'generated/google/apis/redis_v1/classes.rb', line 628 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 |