Class: Google::Apis::CloudchannelV1::GoogleLongrunningOperation
- Inherits:
-
Object
- Object
- Google::Apis::CloudchannelV1::GoogleLongrunningOperation
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/cloudchannel_v1/classes.rb,
lib/google/apis/cloudchannel_v1/representations.rb,
lib/google/apis/cloudchannel_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::CloudchannelV1::GoogleRpcStatus
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) ⇒ GoogleLongrunningOperation
constructor
A new instance of GoogleLongrunningOperation.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleLongrunningOperation
Returns a new instance of GoogleLongrunningOperation.
4135 4136 4137 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 4135 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
4096 4097 4098 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 4096 def done @done end |
#error ⇒ Google::Apis::CloudchannelV1::GoogleRpcStatus
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
4107 4108 4109 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 4107 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
4115 4116 4117 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 4115 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`
4122 4123 4124 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 4122 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
4133 4134 4135 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 4133 def response @response end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4140 4141 4142 4143 4144 4145 4146 |
# File 'lib/google/apis/cloudchannel_v1/classes.rb', line 4140 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 |