Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::MigrationService::Operations (v0.25.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::MigrationService::Operations.

Service that implements Longrunning Operations API.


  • Object



def self.configure() { |config| ... } -> Operations::Configuration

Configuration for the MigrationService Operations API.

  • (config) — Configure the Operations client.
Yield Parameter


def cancel_operation(request, options = nil) -> ::Google::Protobuf::Empty
def cancel_operation(name: nil) -> ::Google::Protobuf::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

def cancel_operation(request, options = nil) -> ::Google::Protobuf::Empty
Pass arguments to cancel_operation via a request object, either of type Longrunning::CancelOperationRequest or an equivalent Hash.
  • request (::Google::Longrunning::CancelOperationRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
def cancel_operation(name: nil) -> ::Google::Protobuf::Empty
Pass arguments to cancel_operation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
  • name (::String) — The name of the operation resource to be cancelled.
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • (::Google::Cloud::Error) — if the RPC is aborted.

Basic example

require "google/longrunning"

# Create a client object. The client can be reused for multiple calls.
client =

# Create a request. To set request fields, pass in keyword arguments.
request =

# Call the cancel_operation method.
result = client.cancel_operation request

# The returned object is of type Google::Protobuf::Empty.
p result


def configure() { |config| ... } -> Operations::Configuration

Configure the MigrationService Operations instance.

The configur