Reference documentation and code samples for the Datastream V1alpha1 API class Google::Longrunning::Operation.
This resource represents a long-running operation that is the result of a network API call.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#done
def done() -> ::Boolean
Returns
-
(::Boolean) — If the value is
false
, it means the operation is still in progress. Iftrue
, the operation is completed, and eithererror
orresponse
is available.
#done=
def done=(value) -> ::Boolean
Parameter
-
value (::Boolean) — If the value is
false
, it means the operation is still in progress. Iftrue
, the operation is completed, and eithererror
orresponse
is available.
Returns
-
(::Boolean) — If the value is
false
, it means the operation is still in progress. Iftrue
, the operation is completed, and eithererror
orresponse
is available.
#error
def error() -> ::Google::Rpc::Status
Returns
- (::Google::Rpc::Status) — The error result of the operation in case of failure or cancellation.
#error=
def error=(value) -> ::Google::Rpc::Status
Parameter
- value (::Google::Rpc::Status) — The error result of the operation in case of failure or cancellation.
Returns
- (::Google::Rpc::Status) — The error result of the operation in case of failure or cancellation.
#metadata
def metadata() -> ::Google::Protobuf::Any
Returns
- (::Google::Protobuf::Any) — 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.
#metadata=
def metadata=(value) -> ::Google::Protobuf::Any
Parameter
- value (::Google::Protobuf::Any) — 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.
Returns
- (::Google::Protobuf::Any) — 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.
#name
def name() -> ::String
Returns
-
(::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 withoperations/{unique_id}
.
#name=
def name=(value) -> ::String
Parameter
-
value (::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 withoperations/{unique_id}
.
Returns
-
(::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 withoperations/{unique_id}
.
#response
def response() -> ::Google::Protobuf::Any
Returns
-
(::Google::Protobuf::Any) — The normal, successful response of the operation. If the original
method returns no data on success, such as
Delete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
.
#response=
def response=(value) -> ::Google::Protobuf::Any
Parameter
-
value (::Google::Protobuf::Any) — The normal, successful response of the operation. If the original
method returns no data on success, such as
Delete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
.
Returns
-
(::Google::Protobuf::Any) — The normal, successful response of the operation. If the original
method returns no data on success, such as
Delete
, the response isgoogle.protobuf.Empty
. If the original method is standardGet
/Create
/Update
, the response should be the resource. For other methods, the response should have the typeXxxResponse
, whereXxx
is the original method name. For example, if the original method name isTakeSnapshot()
, the inferred response type isTakeSnapshotResponse
.