Reference documentation and code samples for the Cloud Functions V2 API class Google::Cloud::Functions::V2::OperationMetadata.
Represents the metadata of the long-running operation.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#api_version
def api_version() -> ::String
Returns
- (::String) — API version used to start the operation.
#api_version=
def api_version=(value) -> ::String
Parameter
- value (::String) — API version used to start the operation.
Returns
- (::String) — API version used to start the operation.
#cancel_requested
def cancel_requested() -> ::Boolean
Returns
-
(::Boolean) — 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.
#cancel_requested=
def cancel_requested=(value) -> ::Boolean
Parameter
-
value (::Boolean) — 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.
Returns
-
(::Boolean) — 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.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — The time the operation was created.
#create_time=
def create_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — The time the operation was created.
Returns
- (::Google::Protobuf::Timestamp) — The time the operation was created.
#end_time
def end_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — The time the operation finished running.
#end_time=
def end_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — The time the operation finished running.
Returns
- (::Google::Protobuf::Timestamp) — The time the operation finished running.
#request_resource
def request_resource() -> ::Google::Protobuf::Any
Returns
- (::Google::Protobuf::Any) — The original request that started the operation.
#request_resource=
def request_resource=(value) -> ::Google::Protobuf::Any
Parameter
- value (::Google::Protobuf::Any) — The original request that started the operation.
Returns
- (::Google::Protobuf::Any) — The original request that started the operation.
#stages
def stages() -> ::Array<::Google::Cloud::Functions::V2::Stage>
Returns
- (::Array<::Google::Cloud::Functions::V2::Stage>) — Mechanism for reporting in-progress stages
#stages=
def stages=(value) -> ::Array<::Google::Cloud::Functions::V2::Stage>
Parameter
- value (::Array<::Google::Cloud::Functions::V2::Stage>) — Mechanism for reporting in-progress stages
Returns
- (::Array<::Google::Cloud::Functions::V2::Stage>) — Mechanism for reporting in-progress stages
#status_detail
def status_detail() -> ::String
Returns
- (::String) — Human-readable status of the operation, if any.
#status_detail=
def status_detail=(value) -> ::String
Parameter
- value (::String) — Human-readable status of the operation, if any.
Returns
- (::String) — Human-readable status of the operation, if any.
#target
def target() -> ::String
Returns
- (::String) — Server-defined resource path for the target of the operation.
#target=
def target=(value) -> ::String
Parameter
- value (::String) — Server-defined resource path for the target of the operation.
Returns
- (::String) — Server-defined resource path for the target of the operation.
#verb
def verb() -> ::String
Returns
- (::String) — Name of the verb executed by the operation.
#verb=
def verb=(value) -> ::String
Parameter
- value (::String) — Name of the verb executed by the operation.
Returns
- (::String) — Name of the verb executed by the operation.