Vertex AI V1 API - Class Google::Longrunning::Operation (v0.58.0)

Version latest

• 0.58.0 (latest)
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 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. If true, the operation is completed, and either error or response is available.

#done=

def done=(value) -> ::Boolean

Parameter

• value (::Boolean) — 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.

Returns

• (::Boolean) — 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.

#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 with operations/{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 with operations/{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 with operations/{unique_id}.

#response

def response() -> ::Google::Protobuf::Any

Returns

• (::Google::Protobuf::Any) — 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.

#response=

def response=(value) -> ::Google::Protobuf::Any

Parameter

• value (::Google::Protobuf::Any) — 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.

Returns

• (::Google::Protobuf::Any) — 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.