Class: Google::Apis::CloudsearchV1::Operation
- Inherits:
-
Object
- Object
- Google::Apis::CloudsearchV1::Operation
- Defined in:
- generated/google/apis/cloudsearch_v1/classes.rb,
generated/google/apis/cloudsearch_v1/representations.rb,
generated/google/apis/cloudsearch_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::CloudsearchV1::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>
Service-specific metadata associated with the operation.
-
#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 Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Operation
Returns a new instance of Operation
2571 2572 2573 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2571 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
2531 2532 2533 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2531 def done @done end |
#error ⇒ Google::Apis::CloudsearchV1::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
2542 2543 2544 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2542 def error @error end |
#metadata ⇒ Hash<String,Object>
Service-specific metadata associated with the operation. It typically
contains progress information and common metadata such as create time.
Some services might not provide such metadata. Any method that returns a
long-running operation should document the metadata type, if any.
Corresponds to the JSON property metadata
2550 2551 2552 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2550 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`
2557 2558 2559 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2557 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
2569 2570 2571 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2569 def response @response end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2576 2577 2578 2579 2580 2581 2582 |
# File 'generated/google/apis/cloudsearch_v1/classes.rb', line 2576 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 |