Cloud AI Platform v1 API - Class MigrationServiceClient (3.9.0) 

public abstract class MigrationServiceClient

Reference documentation and code samples for the Cloud AI Platform v1 API class MigrationServiceClient.

MigrationService client wrapper, for convenient use.

Inheritance

object > MigrationServiceClient

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

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

Properties

BatchMigrateResourcesOperationsClient

public virtual OperationsClient BatchMigrateResourcesOperationsClient { get; }

The long-running operations client for BatchMigrateResources.

Property Value
Type Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the MigrationService service, which is a host of "aiplatform.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default MigrationService scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default MigrationService scopes are:

GrpcClient

public virtual MigrationService.MigrationServiceClient GrpcClient { get; }

The underlying gRPC MigrationService client

Property Value
Type Description
MigrationServiceMigrationServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

BatchMigrateResources(LocationName, IEnumerable<MigrateResourceRequest>, CallSettings)

public virtual Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> BatchMigrateResources(LocationName parent, IEnumerable<MigrateResourceRequest> migrateResourceRequests, CallSettings callSettings = null)

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

Parameters
Name Description
parent LocationName

Required. The location of the migrated resource will live in. Format: projects/{project}/locations/{location}
migrateResourceRequests IEnumerableMigrateResourceRequest

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.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBatchMigrateResourcesResponseBatchMigrateResourcesOperationMetadata

The RPC response.
Example 
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IEnumerable<MigrateResourceRequest> migrateResourceRequests = new MigrateResourceRequest[]
{
    new MigrateResourceRequest(),
};
// Make the request
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> response = migrationServiceClient.BatchMigrateResources(parent, migrateResourceRequests);

// Poll until the returned long-running operation is complete
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
BatchMigrateResourcesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> retrievedResponse = migrationServiceClient.PollOnceBatchMigrateResources(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchMigrateResourcesResponse retrievedResult = retrievedResponse.Result;
}

BatchMigrateResources(BatchMigrateResourcesRequest, CallSettings)

public virtual Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> BatchMigrateResources(BatchMigrateResourcesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request BatchMigrateResourcesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBatchMigrateResourcesResponseBatchMigrateResourcesOperationMetadata

The RPC response.
Example 
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
BatchMigrateResourcesRequest request = new BatchMigrateResourcesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    MigrateResourceRequests =
    {
        new MigrateResourceRequest(),
    },
};
// Make the request
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> response = migrationServiceClient.BatchMigrateResources(request);

// Poll until the returned long-running operation is complete
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
BatchMigrateResourcesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> retrievedResponse = migrationServiceClient.PollOnceBatchMigrateResources(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchMigrateResourcesResponse retrievedResult = retrievedResponse.Result;
}

BatchMigrateResources(string, IEnumerable<MigrateResourceRequest>, CallSettings)

public virtual Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> BatchMigrateResources(string parent, IEnumerable<MigrateResourceRequest> migrateResourceRequests, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. The location of the migrated resource will live in. Format: projects/{project}/locations/{location}
migrateResourceRequests IEnumerableMigrateResourceRequest

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.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBatchMigrateResourcesResponseBatchMigrateResourcesOperationMetadata

The RPC response.
Example 
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IEnumerable<MigrateResourceRequest> migrateResourceRequests = new MigrateResourceRequest[]
{
    new MigrateResourceRequest(),
};
// Make the request
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> response = migrationServiceClient.BatchMigrateResources(parent, migrateResourceRequests);

// Poll until the returned long-running operation is complete
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
BatchMigrateResourcesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> retrievedResponse = migrationServiceClient.PollOnceBatchMigrateResources(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchMigrateResourcesResponse retrievedResult = retrievedResponse.Result;
}

BatchMigrateResourcesAsync(LocationName, IEnumerable<MigrateResourceRequest>, CallSettings)

public virtual Task<Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata>> BatchMigrateResourcesAsync(LocationName parent, IEnumerable<MigrateResourceRequest> migrateResourceRequests, CallSettings callSettings = null)

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

Parameters
Name Description
parent LocationName

Required. The location of the migrated resource will live in. Format: projects/{project}/locations/{location}
migrateResourceRequests IEnumerableMigrateResourceRequest

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.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBatchMigrateResourcesResponseBatchMigrateResourcesOperationMetadata

A Task containing the RPC response.
Example 
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IEnumerable<MigrateResourceRequest> migrateResourceRequests = new MigrateResourceRequest[]
{
    new MigrateResourceRequest(),
};
// Make the request
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> response = await migrationServiceClient.BatchMigrateResourcesAsync(parent, migrateResourceRequests);

// Poll until the returned long-running operation is complete
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchMigrateResourcesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> retrievedResponse = await migrationServiceClient.PollOnceBatchMigrateResourcesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchMigrateResourcesResponse retrievedResult = retrievedResponse.Result;
}

BatchMigrateResourcesAsync(LocationName, IEnumerable<MigrateResourceRequest>, CancellationToken)

public virtual Task<Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata>> BatchMigrateResourcesAsync(LocationName parent, IEnumerable<MigrateResourceRequest> migrateResourceRequests, CancellationToken cancellationToken)

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

Parameters
Name Description
parent LocationName

Required. The location of the migrated resource will live in. Format: projects/{project}/locations/{location}
migrateResourceRequests IEnumerableMigrateResourceRequest

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.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationBatchMigrateResourcesResponseBatchMigrateResourcesOperationMetadata

A Task containing the RPC response.
Example 
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
IEnumerable<MigrateResourceRequest> migrateResourceRequests = new MigrateResourceRequest[]
{
    new MigrateResourceRequest(),
};
// Make the request
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> response = await migrationServiceClient.BatchMigrateResourcesAsync(parent, migrateResourceRequests);

// Poll until the returned long-running operation is complete
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchMigrateResourcesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> retrievedResponse = await migrationServiceClient.PollOnceBatchMigrateResourcesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchMigrateResourcesResponse retrievedResult = retrievedResponse.Result;
}

BatchMigrateResourcesAsync(BatchMigrateResourcesRequest, CallSettings)

public virtual Task<Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata>> BatchMigrateResourcesAsync(BatchMigrateResourcesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request BatchMigrateResourcesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBatchMigrateResourcesResponseBatchMigrateResourcesOperationMetadata

A Task containing the RPC response.
Example 
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
BatchMigrateResourcesRequest request = new BatchMigrateResourcesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    MigrateResourceRequests =
    {
        new MigrateResourceRequest(),
    },
};
// Make the request
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> response = await migrationServiceClient.BatchMigrateResourcesAsync(request);

// Poll until the returned long-running operation is complete
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchMigrateResourcesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> retrievedResponse = await migrationServiceClient.PollOnceBatchMigrateResourcesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchMigrateResourcesResponse retrievedResult = retrievedResponse.Result;
}

BatchMigrateResourcesAsync(BatchMigrateResourcesRequest, CancellationToken)

public virtual Task<Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata>> BatchMigrateResourcesAsync(BatchMigrateResourcesRequest request, CancellationToken cancellationToken)

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

Parameters
Name Description
request BatchMigrateResourcesRequest

The request object containing all of the parameters for the API call.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationBatchMigrateResourcesResponseBatchMigrateResourcesOperationMetadata

A Task containing the RPC response.
Example 
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
BatchMigrateResourcesRequest request = new BatchMigrateResourcesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    MigrateResourceRequests =
    {
        new MigrateResourceRequest(),
    },
};
// Make the request
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> response = await migrationServiceClient.BatchMigrateResourcesAsync(request);

// Poll until the returned long-running operation is complete
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchMigrateResourcesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> retrievedResponse = await migrationServiceClient.PollOnceBatchMigrateResourcesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchMigrateResourcesResponse retrievedResult = retrievedResponse.Result;
}

BatchMigrateResourcesAsync(string, IEnumerable<MigrateResourceRequest>, CallSettings)

public virtual Task<Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata>> BatchMigrateResourcesAsync(string parent, IEnumerable<MigrateResourceRequest> migrateResourceRequests, CallSettings callSettings = null)

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

Parameters
Name Description
parent string

Required. The location of the migrated resource will live in. Format: projects/{project}/locations/{location}
migrateResourceRequests IEnumerableMigrateResourceRequest

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.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBatchMigrateResourcesResponseBatchMigrateResourcesOperationMetadata

A Task containing the RPC response.
Example 
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IEnumerable<MigrateResourceRequest> migrateResourceRequests = new MigrateResourceRequest[]
{
    new MigrateResourceRequest(),
};
// Make the request
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> response = await migrationServiceClient.BatchMigrateResourcesAsync(parent, migrateResourceRequests);

// Poll until the returned long-running operation is complete
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchMigrateResourcesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> retrievedResponse = await migrationServiceClient.PollOnceBatchMigrateResourcesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchMigrateResourcesResponse retrievedResult = retrievedResponse.Result;
}

BatchMigrateResourcesAsync(string, IEnumerable<MigrateResourceRequest>, CancellationToken)

public virtual Task<Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata>> BatchMigrateResourcesAsync(string parent, IEnumerable<MigrateResourceRequest> migrateResourceRequests, CancellationToken cancellationToken)

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

Parameters
Name Description
parent string

Required. The location of the migrated resource will live in. Format: projects/{project}/locations/{location}
migrateResourceRequests IEnumerableMigrateResourceRequest

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.
cancellationToken CancellationToken

A CancellationToken to use for this RPC.
Returns
Type Description
TaskOperationBatchMigrateResourcesResponseBatchMigrateResourcesOperationMetadata

A Task containing the RPC response.
Example 
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
IEnumerable<MigrateResourceRequest> migrateResourceRequests = new MigrateResourceRequest[]
{
    new MigrateResourceRequest(),
};
// Make the request
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> response = await migrationServiceClient.BatchMigrateResourcesAsync(parent, migrateResourceRequests);

// Poll until the returned long-running operation is complete
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
BatchMigrateResourcesResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> retrievedResponse = await migrationServiceClient.PollOnceBatchMigrateResourcesAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    BatchMigrateResourcesResponse retrievedResult = retrievedResponse.Result;
}

Create()

public static MigrationServiceClient Create()

Synchronously creates a MigrationServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MigrationServiceClientBuilder.

Returns
Type Description
MigrationServiceClient

The created MigrationServiceClient.

CreateAsync(CancellationToken)

public static Task<MigrationServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a MigrationServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use MigrationServiceClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.
Returns
Type Description
TaskMigrationServiceClient

The task representing the created MigrationServiceClient.

PollOnceBatchMigrateResources(string, CallSettings)

public virtual Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata> PollOnceBatchMigrateResources(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of BatchMigrateResources .

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBatchMigrateResourcesResponseBatchMigrateResourcesOperationMetadata

The result of polling the operation.

PollOnceBatchMigrateResourcesAsync(string, CallSettings)

public virtual Task<Operation<BatchMigrateResourcesResponse, BatchMigrateResourcesOperationMetadata>> PollOnceBatchMigrateResourcesAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of BatchMigrateResources.

Parameters
Name Description
operationName string

The name of a previously invoked operation. Must not be null or empty.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBatchMigrateResourcesResponseBatchMigrateResourcesOperationMetadata

A task representing the result of polling the operation.

SearchMigratableResources(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<SearchMigratableResourcesResponse, MigratableResource> SearchMigratableResources(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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.

Parameters
Name Description
parent LocationName

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}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSearchMigratableResourcesResponseMigratableResource

A pageable sequence of MigratableResource resources.
Example 
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<SearchMigratableResourcesResponse, MigratableResource> response = migrationServiceClient.SearchMigratableResources(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (MigratableResource item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchMigratableResourcesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigratableResource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<MigratableResource> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (MigratableResource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchMigratableResources(SearchMigratableResourcesRequest, CallSettings)

public virtual PagedEnumerable<SearchMigratableResourcesResponse, MigratableResource> SearchMigratableResources(SearchMigratableResourcesRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request SearchMigratableResourcesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSearchMigratableResourcesResponseMigratableResource

A pageable sequence of MigratableResource resources.
Example 
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
SearchMigratableResourcesRequest request = new SearchMigratableResourcesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
};
// Make the request
PagedEnumerable<SearchMigratableResourcesResponse, MigratableResource> response = migrationServiceClient.SearchMigratableResources(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (MigratableResource item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchMigratableResourcesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigratableResource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<MigratableResource> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (MigratableResource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchMigratableResources(string, string, int?, CallSettings)

public virtual PagedEnumerable<SearchMigratableResourcesResponse, MigratableResource> SearchMigratableResources(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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.

Parameters
Name Description
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}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableSearchMigratableResourcesResponseMigratableResource

A pageable sequence of MigratableResource resources.
Example 
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<SearchMigratableResourcesResponse, MigratableResource> response = migrationServiceClient.SearchMigratableResources(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (MigratableResource item in response)
{
    // Do something with each item
    Console.WriteLine(item);
}

// Or iterate over pages (of server-defined size), performing one RPC per page
foreach (SearchMigratableResourcesResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigratableResource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
}

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<MigratableResource> singlePage = response.ReadPage(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (MigratableResource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchMigratableResourcesAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<SearchMigratableResourcesResponse, MigratableResource> SearchMigratableResourcesAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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.

Parameters
Name Description
parent LocationName

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}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSearchMigratableResourcesResponseMigratableResource

A pageable asynchronous sequence of MigratableResource resources.
Example 
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<SearchMigratableResourcesResponse, MigratableResource> response = migrationServiceClient.SearchMigratableResourcesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((MigratableResource item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchMigratableResourcesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigratableResource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<MigratableResource> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (MigratableResource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchMigratableResourcesAsync(SearchMigratableResourcesRequest, CallSettings)

public virtual PagedAsyncEnumerable<SearchMigratableResourcesResponse, MigratableResource> SearchMigratableResourcesAsync(SearchMigratableResourcesRequest request, CallSettings callSettings = null)

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.

Parameters
Name Description
request SearchMigratableResourcesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSearchMigratableResourcesResponseMigratableResource

A pageable asynchronous sequence of MigratableResource resources.
Example 
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
SearchMigratableResourcesRequest request = new SearchMigratableResourcesRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<SearchMigratableResourcesResponse, MigratableResource> response = migrationServiceClient.SearchMigratableResourcesAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((MigratableResource item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchMigratableResourcesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigratableResource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<MigratableResource> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (MigratableResource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

SearchMigratableResourcesAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<SearchMigratableResourcesResponse, MigratableResource> SearchMigratableResourcesAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

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.

Parameters
Name Description
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}
pageToken string

The token returned from the previous request. A value of null or an empty string retrieves the first page.
pageSize int

The size of page to request. The response will not be larger than this, but may be smaller. A value of null or 0 uses a server-defined page size.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableSearchMigratableResourcesResponseMigratableResource

A pageable asynchronous sequence of MigratableResource resources.
Example 
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<SearchMigratableResourcesResponse, MigratableResource> response = migrationServiceClient.SearchMigratableResourcesAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((MigratableResource item) =>
{
    // Do something with each item
    Console.WriteLine(item);
});

// Or iterate over pages (of server-defined size), performing one RPC per page
await response.AsRawResponses().ForEachAsync((SearchMigratableResourcesResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigratableResource item in page)
    {
        // Do something with each item
        Console.WriteLine(item);
    }
});

// Or retrieve a single page of known size (unless it's the final page), performing as many RPCs as required
int pageSize = 10;
Page<MigratableResource> singlePage = await response.ReadPageAsync(pageSize);
// Do something with the page of items
Console.WriteLine($"A page of {pageSize} results (unless it's the final page):");
foreach (MigratableResource item in singlePage)
{
    // Do something with each item
    Console.WriteLine(item);
}
// Store the pageToken, for when the next page is required.
string nextPageToken = singlePage.NextPageToken;

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.
Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.