Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::MigrationService::Client (v0.58.0)

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

Client for the MigrationService service.

A service that migrates resources from automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com to Vertex AI.

Inherits

Object

Includes

Google::Cloud::AIPlatform::V1::MigrationService::Paths

Methods

.configure

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

Configure the MigrationService Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all MigrationService clients
::Google::Cloud::AIPlatform::V1::MigrationService::Client.configure do |config|
  config.timeout = 10.0
end

#batch_migrate_resources

def batch_migrate_resources(request, options = nil) -> ::Gapic::Operation
def batch_migrate_resources(parent: nil, migrate_resource_requests: nil) -> ::Gapic::Operation

Batch migrates resources from ml.googleapis.com, automl.googleapis.com, and datalabeling.googleapis.com to Vertex AI.

Overloads

def batch_migrate_resources(request, options = nil) -> ::Gapic::Operation

Pass arguments to batch_migrate_resources via a request object, either of type BatchMigrateResourcesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AIPlatform::V1::BatchMigrateResourcesRequest, ::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 batch_migrate_resources(parent: nil, migrate_resource_requests: nil) -> ::Gapic::Operation

Pass arguments to batch_migrate_resources 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).

Parameters

parent (::String) — Required. The location of the migrated resource will live in. Format: projects/{project}/locations/{location}
migrate_resource_requests (::Array<::Google::Cloud::AIPlatform::V1::MigrateResourceRequest, ::Hash>) — Required. The request messages specifying the resources to migrate. They must be in the same location as the destination. Up to 50 resources can be migrated in one batch.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::Operation)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::Operation)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::MigrationService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::BatchMigrateResourcesRequest.new

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

#configure

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

Configure the MigrationService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

Get the associated client for mix-in of the IAMPolicy.

Returns

(Google::Iam::V1::IAMPolicy::Client)

#initialize

def initialize() { |config| ... } -> Client

Create a new MigrationService client object.

Yields

(config) — Configure the MigrationService client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::AIPlatform::V1::MigrationService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AIPlatform::V1::MigrationService::Client.new do |config|
  config.timeout = 10.0
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns

(Google::Cloud::Location::Locations::Client)

#operations_client

def operations_client() -> ::Google::Cloud::AIPlatform::V1::MigrationService::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::AIPlatform::V1::MigrationService::Operations)

#search_migratable_resources

def search_migratable_resources(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::MigratableResource>
def search_migratable_resources(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::MigratableResource>

Searches all of the resources in automl.googleapis.com, datalabeling.googleapis.com and ml.googleapis.com that can be migrated to Vertex AI's given location.

Overloads

def search_migratable_resources(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::MigratableResource>

Pass arguments to search_migratable_resources via a request object, either of type SearchMigratableResourcesRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::AIPlatform::V1::SearchMigratableResourcesRequest, ::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 search_migratable_resources(parent: nil, page_size: nil, page_token: nil, filter: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::MigratableResource>

Pass arguments to search_migratable_resources 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).

Parameters

parent (::String) — Required. The location that the migratable resources should be searched from. It's the Vertex AI location that the resources can be migrated to, not the resources' original location. Format: projects/{project}/locations/{location}
page_size (::Integer) — The standard page size. The default and maximum value is 100.
page_token (::String) — The standard page token.
filter (::String) —
A filter for your search. You can use the following types of filters:
- Resource type filters. The following strings filter for a specific type of MigratableResource:
  - ml_engine_model_version:*
  - automl_model:*
  - automl_dataset:*
  - data_labeling_dataset:*
- "Migrated or not" filters. The following strings filter for resources that either have or have not already been migrated:
  - last_migrate_time:* filters for migrated resources.
  - NOT last_migrate_time:* filters for not yet migrated resources.

Yields

(response, operation) — Access the result along with the RPC operation

Yield Parameters

response (::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::MigratableResource>)
operation (::GRPC::ActiveCall::Operation)

Returns

(::Gapic::PagedEnumerable<::Google::Cloud::AIPlatform::V1::MigratableResource>)

Raises

(::Google::Cloud::Error) — if the RPC is aborted.

Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::MigrationService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::SearchMigratableResourcesRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::AIPlatform::V1::MigratableResource.
  p item
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)