BigQuery Migration v2 API - Class MigrationServiceClient (1.5.0)

public abstract class MigrationServiceClient

Reference documentation and code samples for the BigQuery Migration v2 API class MigrationServiceClient.

MigrationService client wrapper, for convenient use.

Inheritance

object > MigrationServiceClient

Namespace

Google.Cloud.BigQuery.Migration.V2

Assembly

Google.Cloud.BigQuery.Migration.V2.dll

Remarks

Service to handle EDW migrations.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the MigrationService service, which is a host of "bigquerymigration.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

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

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.

CreateMigrationWorkflow(LocationName, MigrationWorkflow, CallSettings)

public virtual MigrationWorkflow CreateMigrationWorkflow(LocationName parent, MigrationWorkflow migrationWorkflow, CallSettings callSettings = null)

Creates a migration workflow.

Parameters
Name Description
parent LocationName

Required. The name of the project to which this migration workflow belongs. Example: projects/foo/locations/bar

migrationWorkflow MigrationWorkflow

Required. The migration workflow to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
MigrationWorkflow

The RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
MigrationWorkflow migrationWorkflow = new MigrationWorkflow();
// Make the request
MigrationWorkflow response = migrationServiceClient.CreateMigrationWorkflow(parent, migrationWorkflow);

CreateMigrationWorkflow(CreateMigrationWorkflowRequest, CallSettings)

public virtual MigrationWorkflow CreateMigrationWorkflow(CreateMigrationWorkflowRequest request, CallSettings callSettings = null)

Creates a migration workflow.

Parameters
Name Description
request CreateMigrationWorkflowRequest

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
MigrationWorkflow

The RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
CreateMigrationWorkflowRequest request = new CreateMigrationWorkflowRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    MigrationWorkflow = new MigrationWorkflow(),
};
// Make the request
MigrationWorkflow response = migrationServiceClient.CreateMigrationWorkflow(request);

CreateMigrationWorkflow(string, MigrationWorkflow, CallSettings)

public virtual MigrationWorkflow CreateMigrationWorkflow(string parent, MigrationWorkflow migrationWorkflow, CallSettings callSettings = null)

Creates a migration workflow.

Parameters
Name Description
parent string

Required. The name of the project to which this migration workflow belongs. Example: projects/foo/locations/bar

migrationWorkflow MigrationWorkflow

Required. The migration workflow to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
MigrationWorkflow

The RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
MigrationWorkflow migrationWorkflow = new MigrationWorkflow();
// Make the request
MigrationWorkflow response = migrationServiceClient.CreateMigrationWorkflow(parent, migrationWorkflow);

CreateMigrationWorkflowAsync(LocationName, MigrationWorkflow, CallSettings)

public virtual Task<MigrationWorkflow> CreateMigrationWorkflowAsync(LocationName parent, MigrationWorkflow migrationWorkflow, CallSettings callSettings = null)

Creates a migration workflow.

Parameters
Name Description
parent LocationName

Required. The name of the project to which this migration workflow belongs. Example: projects/foo/locations/bar

migrationWorkflow MigrationWorkflow

Required. The migration workflow to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskMigrationWorkflow

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
MigrationWorkflow migrationWorkflow = new MigrationWorkflow();
// Make the request
MigrationWorkflow response = await migrationServiceClient.CreateMigrationWorkflowAsync(parent, migrationWorkflow);

CreateMigrationWorkflowAsync(LocationName, MigrationWorkflow, CancellationToken)

public virtual Task<MigrationWorkflow> CreateMigrationWorkflowAsync(LocationName parent, MigrationWorkflow migrationWorkflow, CancellationToken cancellationToken)

Creates a migration workflow.

Parameters
Name Description
parent LocationName

Required. The name of the project to which this migration workflow belongs. Example: projects/foo/locations/bar

migrationWorkflow MigrationWorkflow

Required. The migration workflow to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskMigrationWorkflow

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
MigrationWorkflow migrationWorkflow = new MigrationWorkflow();
// Make the request
MigrationWorkflow response = await migrationServiceClient.CreateMigrationWorkflowAsync(parent, migrationWorkflow);

CreateMigrationWorkflowAsync(CreateMigrationWorkflowRequest, CallSettings)

public virtual Task<MigrationWorkflow> CreateMigrationWorkflowAsync(CreateMigrationWorkflowRequest request, CallSettings callSettings = null)

Creates a migration workflow.

Parameters
Name Description
request CreateMigrationWorkflowRequest

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
TaskMigrationWorkflow

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
CreateMigrationWorkflowRequest request = new CreateMigrationWorkflowRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    MigrationWorkflow = new MigrationWorkflow(),
};
// Make the request
MigrationWorkflow response = await migrationServiceClient.CreateMigrationWorkflowAsync(request);

CreateMigrationWorkflowAsync(CreateMigrationWorkflowRequest, CancellationToken)

public virtual Task<MigrationWorkflow> CreateMigrationWorkflowAsync(CreateMigrationWorkflowRequest request, CancellationToken cancellationToken)

Creates a migration workflow.

Parameters
Name Description
request CreateMigrationWorkflowRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskMigrationWorkflow

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
CreateMigrationWorkflowRequest request = new CreateMigrationWorkflowRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    MigrationWorkflow = new MigrationWorkflow(),
};
// Make the request
MigrationWorkflow response = await migrationServiceClient.CreateMigrationWorkflowAsync(request);

CreateMigrationWorkflowAsync(string, MigrationWorkflow, CallSettings)

public virtual Task<MigrationWorkflow> CreateMigrationWorkflowAsync(string parent, MigrationWorkflow migrationWorkflow, CallSettings callSettings = null)

Creates a migration workflow.

Parameters
Name Description
parent string

Required. The name of the project to which this migration workflow belongs. Example: projects/foo/locations/bar

migrationWorkflow MigrationWorkflow

Required. The migration workflow to create.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskMigrationWorkflow

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
MigrationWorkflow migrationWorkflow = new MigrationWorkflow();
// Make the request
MigrationWorkflow response = await migrationServiceClient.CreateMigrationWorkflowAsync(parent, migrationWorkflow);

CreateMigrationWorkflowAsync(string, MigrationWorkflow, CancellationToken)

public virtual Task<MigrationWorkflow> CreateMigrationWorkflowAsync(string parent, MigrationWorkflow migrationWorkflow, CancellationToken cancellationToken)

Creates a migration workflow.

Parameters
Name Description
parent string

Required. The name of the project to which this migration workflow belongs. Example: projects/foo/locations/bar

migrationWorkflow MigrationWorkflow

Required. The migration workflow to create.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskMigrationWorkflow

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
MigrationWorkflow migrationWorkflow = new MigrationWorkflow();
// Make the request
MigrationWorkflow response = await migrationServiceClient.CreateMigrationWorkflowAsync(parent, migrationWorkflow);

DeleteMigrationWorkflow(DeleteMigrationWorkflowRequest, CallSettings)

public virtual void DeleteMigrationWorkflow(DeleteMigrationWorkflowRequest request, CallSettings callSettings = null)

Deletes a migration workflow by name.

Parameters
Name Description
request DeleteMigrationWorkflowRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
DeleteMigrationWorkflowRequest request = new DeleteMigrationWorkflowRequest
{
    MigrationWorkflowName = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]"),
};
// Make the request
migrationServiceClient.DeleteMigrationWorkflow(request);

DeleteMigrationWorkflow(MigrationWorkflowName, CallSettings)

public virtual void DeleteMigrationWorkflow(MigrationWorkflowName name, CallSettings callSettings = null)

Deletes a migration workflow by name.

Parameters
Name Description
name MigrationWorkflowName

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
MigrationWorkflowName name = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
// Make the request
migrationServiceClient.DeleteMigrationWorkflow(name);

DeleteMigrationWorkflow(string, CallSettings)

public virtual void DeleteMigrationWorkflow(string name, CallSettings callSettings = null)

Deletes a migration workflow by name.

Parameters
Name Description
name string

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]";
// Make the request
migrationServiceClient.DeleteMigrationWorkflow(name);

DeleteMigrationWorkflowAsync(DeleteMigrationWorkflowRequest, CallSettings)

public virtual Task DeleteMigrationWorkflowAsync(DeleteMigrationWorkflowRequest request, CallSettings callSettings = null)

Deletes a migration workflow by name.

Parameters
Name Description
request DeleteMigrationWorkflowRequest

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
Task

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteMigrationWorkflowRequest request = new DeleteMigrationWorkflowRequest
{
    MigrationWorkflowName = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]"),
};
// Make the request
await migrationServiceClient.DeleteMigrationWorkflowAsync(request);

DeleteMigrationWorkflowAsync(DeleteMigrationWorkflowRequest, CancellationToken)

public virtual Task DeleteMigrationWorkflowAsync(DeleteMigrationWorkflowRequest request, CancellationToken cancellationToken)

Deletes a migration workflow by name.

Parameters
Name Description
request DeleteMigrationWorkflowRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
DeleteMigrationWorkflowRequest request = new DeleteMigrationWorkflowRequest
{
    MigrationWorkflowName = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]"),
};
// Make the request
await migrationServiceClient.DeleteMigrationWorkflowAsync(request);

DeleteMigrationWorkflowAsync(MigrationWorkflowName, CallSettings)

public virtual Task DeleteMigrationWorkflowAsync(MigrationWorkflowName name, CallSettings callSettings = null)

Deletes a migration workflow by name.

Parameters
Name Description
name MigrationWorkflowName

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
MigrationWorkflowName name = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
// Make the request
await migrationServiceClient.DeleteMigrationWorkflowAsync(name);

DeleteMigrationWorkflowAsync(MigrationWorkflowName, CancellationToken)

public virtual Task DeleteMigrationWorkflowAsync(MigrationWorkflowName name, CancellationToken cancellationToken)

Deletes a migration workflow by name.

Parameters
Name Description
name MigrationWorkflowName

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
MigrationWorkflowName name = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
// Make the request
await migrationServiceClient.DeleteMigrationWorkflowAsync(name);

DeleteMigrationWorkflowAsync(string, CallSettings)

public virtual Task DeleteMigrationWorkflowAsync(string name, CallSettings callSettings = null)

Deletes a migration workflow by name.

Parameters
Name Description
name string

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]";
// Make the request
await migrationServiceClient.DeleteMigrationWorkflowAsync(name);

DeleteMigrationWorkflowAsync(string, CancellationToken)

public virtual Task DeleteMigrationWorkflowAsync(string name, CancellationToken cancellationToken)

Deletes a migration workflow by name.

Parameters
Name Description
name string

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]";
// Make the request
await migrationServiceClient.DeleteMigrationWorkflowAsync(name);

GetMigrationSubtask(GetMigrationSubtaskRequest, CallSettings)

public virtual MigrationSubtask GetMigrationSubtask(GetMigrationSubtaskRequest request, CallSettings callSettings = null)

Gets a previously created migration subtask.

Parameters
Name Description
request GetMigrationSubtaskRequest

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
MigrationSubtask

The RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
GetMigrationSubtaskRequest request = new GetMigrationSubtaskRequest
{
    MigrationSubtaskName = MigrationSubtaskName.FromProjectLocationWorkflowSubtask("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[SUBTASK]"),
    ReadMask = new FieldMask(),
};
// Make the request
MigrationSubtask response = migrationServiceClient.GetMigrationSubtask(request);

GetMigrationSubtask(MigrationSubtaskName, CallSettings)

public virtual MigrationSubtask GetMigrationSubtask(MigrationSubtaskName name, CallSettings callSettings = null)

Gets a previously created migration subtask.

Parameters
Name Description
name MigrationSubtaskName

Required. The unique identifier for the migration subtask. Example: projects/123/locations/us/workflows/1234/subtasks/543

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
MigrationSubtask

The RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
MigrationSubtaskName name = MigrationSubtaskName.FromProjectLocationWorkflowSubtask("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[SUBTASK]");
// Make the request
MigrationSubtask response = migrationServiceClient.GetMigrationSubtask(name);

GetMigrationSubtask(string, CallSettings)

public virtual MigrationSubtask GetMigrationSubtask(string name, CallSettings callSettings = null)

Gets a previously created migration subtask.

Parameters
Name Description
name string

Required. The unique identifier for the migration subtask. Example: projects/123/locations/us/workflows/1234/subtasks/543

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
MigrationSubtask

The RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]/subtasks/[SUBTASK]";
// Make the request
MigrationSubtask response = migrationServiceClient.GetMigrationSubtask(name);

GetMigrationSubtaskAsync(GetMigrationSubtaskRequest, CallSettings)

public virtual Task<MigrationSubtask> GetMigrationSubtaskAsync(GetMigrationSubtaskRequest request, CallSettings callSettings = null)

Gets a previously created migration subtask.

Parameters
Name Description
request GetMigrationSubtaskRequest

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
TaskMigrationSubtask

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
GetMigrationSubtaskRequest request = new GetMigrationSubtaskRequest
{
    MigrationSubtaskName = MigrationSubtaskName.FromProjectLocationWorkflowSubtask("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[SUBTASK]"),
    ReadMask = new FieldMask(),
};
// Make the request
MigrationSubtask response = await migrationServiceClient.GetMigrationSubtaskAsync(request);

GetMigrationSubtaskAsync(GetMigrationSubtaskRequest, CancellationToken)

public virtual Task<MigrationSubtask> GetMigrationSubtaskAsync(GetMigrationSubtaskRequest request, CancellationToken cancellationToken)

Gets a previously created migration subtask.

Parameters
Name Description
request GetMigrationSubtaskRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskMigrationSubtask

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
GetMigrationSubtaskRequest request = new GetMigrationSubtaskRequest
{
    MigrationSubtaskName = MigrationSubtaskName.FromProjectLocationWorkflowSubtask("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[SUBTASK]"),
    ReadMask = new FieldMask(),
};
// Make the request
MigrationSubtask response = await migrationServiceClient.GetMigrationSubtaskAsync(request);

GetMigrationSubtaskAsync(MigrationSubtaskName, CallSettings)

public virtual Task<MigrationSubtask> GetMigrationSubtaskAsync(MigrationSubtaskName name, CallSettings callSettings = null)

Gets a previously created migration subtask.

Parameters
Name Description
name MigrationSubtaskName

Required. The unique identifier for the migration subtask. Example: projects/123/locations/us/workflows/1234/subtasks/543

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskMigrationSubtask

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
MigrationSubtaskName name = MigrationSubtaskName.FromProjectLocationWorkflowSubtask("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[SUBTASK]");
// Make the request
MigrationSubtask response = await migrationServiceClient.GetMigrationSubtaskAsync(name);

GetMigrationSubtaskAsync(MigrationSubtaskName, CancellationToken)

public virtual Task<MigrationSubtask> GetMigrationSubtaskAsync(MigrationSubtaskName name, CancellationToken cancellationToken)

Gets a previously created migration subtask.

Parameters
Name Description
name MigrationSubtaskName

Required. The unique identifier for the migration subtask. Example: projects/123/locations/us/workflows/1234/subtasks/543

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskMigrationSubtask

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
MigrationSubtaskName name = MigrationSubtaskName.FromProjectLocationWorkflowSubtask("[PROJECT]", "[LOCATION]", "[WORKFLOW]", "[SUBTASK]");
// Make the request
MigrationSubtask response = await migrationServiceClient.GetMigrationSubtaskAsync(name);

GetMigrationSubtaskAsync(string, CallSettings)

public virtual Task<MigrationSubtask> GetMigrationSubtaskAsync(string name, CallSettings callSettings = null)

Gets a previously created migration subtask.

Parameters
Name Description
name string

Required. The unique identifier for the migration subtask. Example: projects/123/locations/us/workflows/1234/subtasks/543

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskMigrationSubtask

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]/subtasks/[SUBTASK]";
// Make the request
MigrationSubtask response = await migrationServiceClient.GetMigrationSubtaskAsync(name);

GetMigrationSubtaskAsync(string, CancellationToken)

public virtual Task<MigrationSubtask> GetMigrationSubtaskAsync(string name, CancellationToken cancellationToken)

Gets a previously created migration subtask.

Parameters
Name Description
name string

Required. The unique identifier for the migration subtask. Example: projects/123/locations/us/workflows/1234/subtasks/543

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskMigrationSubtask

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]/subtasks/[SUBTASK]";
// Make the request
MigrationSubtask response = await migrationServiceClient.GetMigrationSubtaskAsync(name);

GetMigrationWorkflow(GetMigrationWorkflowRequest, CallSettings)

public virtual MigrationWorkflow GetMigrationWorkflow(GetMigrationWorkflowRequest request, CallSettings callSettings = null)

Gets a previously created migration workflow.

Parameters
Name Description
request GetMigrationWorkflowRequest

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
MigrationWorkflow

The RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
GetMigrationWorkflowRequest request = new GetMigrationWorkflowRequest
{
    MigrationWorkflowName = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]"),
    ReadMask = new FieldMask(),
};
// Make the request
MigrationWorkflow response = migrationServiceClient.GetMigrationWorkflow(request);

GetMigrationWorkflow(MigrationWorkflowName, CallSettings)

public virtual MigrationWorkflow GetMigrationWorkflow(MigrationWorkflowName name, CallSettings callSettings = null)

Gets a previously created migration workflow.

Parameters
Name Description
name MigrationWorkflowName

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
MigrationWorkflow

The RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
MigrationWorkflowName name = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
// Make the request
MigrationWorkflow response = migrationServiceClient.GetMigrationWorkflow(name);

GetMigrationWorkflow(string, CallSettings)

public virtual MigrationWorkflow GetMigrationWorkflow(string name, CallSettings callSettings = null)

Gets a previously created migration workflow.

Parameters
Name Description
name string

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
MigrationWorkflow

The RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]";
// Make the request
MigrationWorkflow response = migrationServiceClient.GetMigrationWorkflow(name);

GetMigrationWorkflowAsync(GetMigrationWorkflowRequest, CallSettings)

public virtual Task<MigrationWorkflow> GetMigrationWorkflowAsync(GetMigrationWorkflowRequest request, CallSettings callSettings = null)

Gets a previously created migration workflow.

Parameters
Name Description
request GetMigrationWorkflowRequest

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
TaskMigrationWorkflow

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
GetMigrationWorkflowRequest request = new GetMigrationWorkflowRequest
{
    MigrationWorkflowName = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]"),
    ReadMask = new FieldMask(),
};
// Make the request
MigrationWorkflow response = await migrationServiceClient.GetMigrationWorkflowAsync(request);

GetMigrationWorkflowAsync(GetMigrationWorkflowRequest, CancellationToken)

public virtual Task<MigrationWorkflow> GetMigrationWorkflowAsync(GetMigrationWorkflowRequest request, CancellationToken cancellationToken)

Gets a previously created migration workflow.

Parameters
Name Description
request GetMigrationWorkflowRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskMigrationWorkflow

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
GetMigrationWorkflowRequest request = new GetMigrationWorkflowRequest
{
    MigrationWorkflowName = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]"),
    ReadMask = new FieldMask(),
};
// Make the request
MigrationWorkflow response = await migrationServiceClient.GetMigrationWorkflowAsync(request);

GetMigrationWorkflowAsync(MigrationWorkflowName, CallSettings)

public virtual Task<MigrationWorkflow> GetMigrationWorkflowAsync(MigrationWorkflowName name, CallSettings callSettings = null)

Gets a previously created migration workflow.

Parameters
Name Description
name MigrationWorkflowName

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskMigrationWorkflow

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
MigrationWorkflowName name = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
// Make the request
MigrationWorkflow response = await migrationServiceClient.GetMigrationWorkflowAsync(name);

GetMigrationWorkflowAsync(MigrationWorkflowName, CancellationToken)

public virtual Task<MigrationWorkflow> GetMigrationWorkflowAsync(MigrationWorkflowName name, CancellationToken cancellationToken)

Gets a previously created migration workflow.

Parameters
Name Description
name MigrationWorkflowName

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskMigrationWorkflow

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
MigrationWorkflowName name = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
// Make the request
MigrationWorkflow response = await migrationServiceClient.GetMigrationWorkflowAsync(name);

GetMigrationWorkflowAsync(string, CallSettings)

public virtual Task<MigrationWorkflow> GetMigrationWorkflowAsync(string name, CallSettings callSettings = null)

Gets a previously created migration workflow.

Parameters
Name Description
name string

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskMigrationWorkflow

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]";
// Make the request
MigrationWorkflow response = await migrationServiceClient.GetMigrationWorkflowAsync(name);

GetMigrationWorkflowAsync(string, CancellationToken)

public virtual Task<MigrationWorkflow> GetMigrationWorkflowAsync(string name, CancellationToken cancellationToken)

Gets a previously created migration workflow.

Parameters
Name Description
name string

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskMigrationWorkflow

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]";
// Make the request
MigrationWorkflow response = await migrationServiceClient.GetMigrationWorkflowAsync(name);

ListMigrationSubtasks(ListMigrationSubtasksRequest, CallSettings)

public virtual PagedEnumerable<ListMigrationSubtasksResponse, MigrationSubtask> ListMigrationSubtasks(ListMigrationSubtasksRequest request, CallSettings callSettings = null)

Lists previously created migration subtasks.

Parameters
Name Description
request ListMigrationSubtasksRequest

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
PagedEnumerableListMigrationSubtasksResponseMigrationSubtask

A pageable sequence of MigrationSubtask resources.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
ListMigrationSubtasksRequest request = new ListMigrationSubtasksRequest
{
    ParentAsMigrationWorkflowName = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]"),
    ReadMask = new FieldMask(),
    Filter = "",
};
// Make the request
PagedEnumerable<ListMigrationSubtasksResponse, MigrationSubtask> response = migrationServiceClient.ListMigrationSubtasks(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (MigrationSubtask 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 (ListMigrationSubtasksResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigrationSubtask 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<MigrationSubtask> 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 (MigrationSubtask 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;

ListMigrationSubtasks(MigrationWorkflowName, string, int?, CallSettings)

public virtual PagedEnumerable<ListMigrationSubtasksResponse, MigrationSubtask> ListMigrationSubtasks(MigrationWorkflowName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists previously created migration subtasks.

Parameters
Name Description
parent MigrationWorkflowName

Required. The migration task of the subtasks to list. Example: projects/123/locations/us/workflows/1234

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
PagedEnumerableListMigrationSubtasksResponseMigrationSubtask

A pageable sequence of MigrationSubtask resources.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
MigrationWorkflowName parent = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
// Make the request
PagedEnumerable<ListMigrationSubtasksResponse, MigrationSubtask> response = migrationServiceClient.ListMigrationSubtasks(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (MigrationSubtask 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 (ListMigrationSubtasksResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigrationSubtask 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<MigrationSubtask> 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 (MigrationSubtask 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;

ListMigrationSubtasks(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListMigrationSubtasksResponse, MigrationSubtask> ListMigrationSubtasks(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists previously created migration subtasks.

Parameters
Name Description
parent string

Required. The migration task of the subtasks to list. Example: projects/123/locations/us/workflows/1234

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
PagedEnumerableListMigrationSubtasksResponseMigrationSubtask

A pageable sequence of MigrationSubtask resources.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]";
// Make the request
PagedEnumerable<ListMigrationSubtasksResponse, MigrationSubtask> response = migrationServiceClient.ListMigrationSubtasks(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (MigrationSubtask 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 (ListMigrationSubtasksResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigrationSubtask 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<MigrationSubtask> 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 (MigrationSubtask 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;

ListMigrationSubtasksAsync(ListMigrationSubtasksRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListMigrationSubtasksResponse, MigrationSubtask> ListMigrationSubtasksAsync(ListMigrationSubtasksRequest request, CallSettings callSettings = null)

Lists previously created migration subtasks.

Parameters
Name Description
request ListMigrationSubtasksRequest

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
PagedAsyncEnumerableListMigrationSubtasksResponseMigrationSubtask

A pageable asynchronous sequence of MigrationSubtask resources.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
ListMigrationSubtasksRequest request = new ListMigrationSubtasksRequest
{
    ParentAsMigrationWorkflowName = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]"),
    ReadMask = new FieldMask(),
    Filter = "",
};
// Make the request
PagedAsyncEnumerable<ListMigrationSubtasksResponse, MigrationSubtask> response = migrationServiceClient.ListMigrationSubtasksAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((MigrationSubtask 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((ListMigrationSubtasksResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigrationSubtask 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<MigrationSubtask> 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 (MigrationSubtask 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;

ListMigrationSubtasksAsync(MigrationWorkflowName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListMigrationSubtasksResponse, MigrationSubtask> ListMigrationSubtasksAsync(MigrationWorkflowName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists previously created migration subtasks.

Parameters
Name Description
parent MigrationWorkflowName

Required. The migration task of the subtasks to list. Example: projects/123/locations/us/workflows/1234

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
PagedAsyncEnumerableListMigrationSubtasksResponseMigrationSubtask

A pageable asynchronous sequence of MigrationSubtask resources.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
MigrationWorkflowName parent = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
// Make the request
PagedAsyncEnumerable<ListMigrationSubtasksResponse, MigrationSubtask> response = migrationServiceClient.ListMigrationSubtasksAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((MigrationSubtask 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((ListMigrationSubtasksResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigrationSubtask 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<MigrationSubtask> 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 (MigrationSubtask 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;

ListMigrationSubtasksAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListMigrationSubtasksResponse, MigrationSubtask> ListMigrationSubtasksAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists previously created migration subtasks.

Parameters
Name Description
parent string

Required. The migration task of the subtasks to list. Example: projects/123/locations/us/workflows/1234

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
PagedAsyncEnumerableListMigrationSubtasksResponseMigrationSubtask

A pageable asynchronous sequence of MigrationSubtask resources.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]";
// Make the request
PagedAsyncEnumerable<ListMigrationSubtasksResponse, MigrationSubtask> response = migrationServiceClient.ListMigrationSubtasksAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((MigrationSubtask 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((ListMigrationSubtasksResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigrationSubtask 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<MigrationSubtask> 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 (MigrationSubtask 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;

ListMigrationWorkflows(LocationName, string, int?, CallSettings)

public virtual PagedEnumerable<ListMigrationWorkflowsResponse, MigrationWorkflow> ListMigrationWorkflows(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists previously created migration workflow.

Parameters
Name Description
parent LocationName

Required. The project and location of the migration workflows to list. Example: projects/123/locations/us

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
PagedEnumerableListMigrationWorkflowsResponseMigrationWorkflow

A pageable sequence of MigrationWorkflow resources.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedEnumerable<ListMigrationWorkflowsResponse, MigrationWorkflow> response = migrationServiceClient.ListMigrationWorkflows(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (MigrationWorkflow 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 (ListMigrationWorkflowsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigrationWorkflow 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<MigrationWorkflow> 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 (MigrationWorkflow 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;

ListMigrationWorkflows(ListMigrationWorkflowsRequest, CallSettings)

public virtual PagedEnumerable<ListMigrationWorkflowsResponse, MigrationWorkflow> ListMigrationWorkflows(ListMigrationWorkflowsRequest request, CallSettings callSettings = null)

Lists previously created migration workflow.

Parameters
Name Description
request ListMigrationWorkflowsRequest

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
PagedEnumerableListMigrationWorkflowsResponseMigrationWorkflow

A pageable sequence of MigrationWorkflow resources.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
ListMigrationWorkflowsRequest request = new ListMigrationWorkflowsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ReadMask = new FieldMask(),
};
// Make the request
PagedEnumerable<ListMigrationWorkflowsResponse, MigrationWorkflow> response = migrationServiceClient.ListMigrationWorkflows(request);

// Iterate over all response items, lazily performing RPCs as required
foreach (MigrationWorkflow 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 (ListMigrationWorkflowsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigrationWorkflow 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<MigrationWorkflow> 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 (MigrationWorkflow 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;

ListMigrationWorkflows(string, string, int?, CallSettings)

public virtual PagedEnumerable<ListMigrationWorkflowsResponse, MigrationWorkflow> ListMigrationWorkflows(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists previously created migration workflow.

Parameters
Name Description
parent string

Required. The project and location of the migration workflows to list. Example: projects/123/locations/us

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
PagedEnumerableListMigrationWorkflowsResponseMigrationWorkflow

A pageable sequence of MigrationWorkflow resources.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedEnumerable<ListMigrationWorkflowsResponse, MigrationWorkflow> response = migrationServiceClient.ListMigrationWorkflows(parent);

// Iterate over all response items, lazily performing RPCs as required
foreach (MigrationWorkflow 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 (ListMigrationWorkflowsResponse page in response.AsRawResponses())
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigrationWorkflow 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<MigrationWorkflow> 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 (MigrationWorkflow 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;

ListMigrationWorkflowsAsync(LocationName, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListMigrationWorkflowsResponse, MigrationWorkflow> ListMigrationWorkflowsAsync(LocationName parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists previously created migration workflow.

Parameters
Name Description
parent LocationName

Required. The project and location of the migration workflows to list. Example: projects/123/locations/us

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
PagedAsyncEnumerableListMigrationWorkflowsResponseMigrationWorkflow

A pageable asynchronous sequence of MigrationWorkflow resources.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
LocationName parent = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
PagedAsyncEnumerable<ListMigrationWorkflowsResponse, MigrationWorkflow> response = migrationServiceClient.ListMigrationWorkflowsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((MigrationWorkflow 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((ListMigrationWorkflowsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigrationWorkflow 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<MigrationWorkflow> 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 (MigrationWorkflow 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;

ListMigrationWorkflowsAsync(ListMigrationWorkflowsRequest, CallSettings)

public virtual PagedAsyncEnumerable<ListMigrationWorkflowsResponse, MigrationWorkflow> ListMigrationWorkflowsAsync(ListMigrationWorkflowsRequest request, CallSettings callSettings = null)

Lists previously created migration workflow.

Parameters
Name Description
request ListMigrationWorkflowsRequest

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
PagedAsyncEnumerableListMigrationWorkflowsResponseMigrationWorkflow

A pageable asynchronous sequence of MigrationWorkflow resources.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
ListMigrationWorkflowsRequest request = new ListMigrationWorkflowsRequest
{
    ParentAsLocationName = LocationName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
    ReadMask = new FieldMask(),
};
// Make the request
PagedAsyncEnumerable<ListMigrationWorkflowsResponse, MigrationWorkflow> response = migrationServiceClient.ListMigrationWorkflowsAsync(request);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((MigrationWorkflow 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((ListMigrationWorkflowsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigrationWorkflow 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<MigrationWorkflow> 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 (MigrationWorkflow 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;

ListMigrationWorkflowsAsync(string, string, int?, CallSettings)

public virtual PagedAsyncEnumerable<ListMigrationWorkflowsResponse, MigrationWorkflow> ListMigrationWorkflowsAsync(string parent, string pageToken = null, int? pageSize = null, CallSettings callSettings = null)

Lists previously created migration workflow.

Parameters
Name Description
parent string

Required. The project and location of the migration workflows to list. Example: projects/123/locations/us

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
PagedAsyncEnumerableListMigrationWorkflowsResponseMigrationWorkflow

A pageable asynchronous sequence of MigrationWorkflow resources.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string parent = "projects/[PROJECT]/locations/[LOCATION]";
// Make the request
PagedAsyncEnumerable<ListMigrationWorkflowsResponse, MigrationWorkflow> response = migrationServiceClient.ListMigrationWorkflowsAsync(parent);

// Iterate over all response items, lazily performing RPCs as required
await response.ForEachAsync((MigrationWorkflow 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((ListMigrationWorkflowsResponse page) =>
{
    // Do something with each page of items
    Console.WriteLine("A page of results:");
    foreach (MigrationWorkflow 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<MigrationWorkflow> 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 (MigrationWorkflow 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.

StartMigrationWorkflow(MigrationWorkflowName, CallSettings)

public virtual void StartMigrationWorkflow(MigrationWorkflowName name, CallSettings callSettings = null)

Starts a previously created migration workflow. I.e., the state transitions from DRAFT to RUNNING. This is a no-op if the state is already RUNNING. An error will be signaled if the state is anything other than DRAFT or RUNNING.

Parameters
Name Description
name MigrationWorkflowName

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
MigrationWorkflowName name = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
// Make the request
migrationServiceClient.StartMigrationWorkflow(name);

StartMigrationWorkflow(StartMigrationWorkflowRequest, CallSettings)

public virtual void StartMigrationWorkflow(StartMigrationWorkflowRequest request, CallSettings callSettings = null)

Starts a previously created migration workflow. I.e., the state transitions from DRAFT to RUNNING. This is a no-op if the state is already RUNNING. An error will be signaled if the state is anything other than DRAFT or RUNNING.

Parameters
Name Description
request StartMigrationWorkflowRequest

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

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
StartMigrationWorkflowRequest request = new StartMigrationWorkflowRequest
{
    MigrationWorkflowName = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]"),
};
// Make the request
migrationServiceClient.StartMigrationWorkflow(request);

StartMigrationWorkflow(string, CallSettings)

public virtual void StartMigrationWorkflow(string name, CallSettings callSettings = null)

Starts a previously created migration workflow. I.e., the state transitions from DRAFT to RUNNING. This is a no-op if the state is already RUNNING. An error will be signaled if the state is anything other than DRAFT or RUNNING.

Parameters
Name Description
name string

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

callSettings CallSettings

If not null, applies overrides to this RPC call.

Example
// Create client
MigrationServiceClient migrationServiceClient = MigrationServiceClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]";
// Make the request
migrationServiceClient.StartMigrationWorkflow(name);

StartMigrationWorkflowAsync(MigrationWorkflowName, CallSettings)

public virtual Task StartMigrationWorkflowAsync(MigrationWorkflowName name, CallSettings callSettings = null)

Starts a previously created migration workflow. I.e., the state transitions from DRAFT to RUNNING. This is a no-op if the state is already RUNNING. An error will be signaled if the state is anything other than DRAFT or RUNNING.

Parameters
Name Description
name MigrationWorkflowName

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
MigrationWorkflowName name = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
// Make the request
await migrationServiceClient.StartMigrationWorkflowAsync(name);

StartMigrationWorkflowAsync(MigrationWorkflowName, CancellationToken)

public virtual Task StartMigrationWorkflowAsync(MigrationWorkflowName name, CancellationToken cancellationToken)

Starts a previously created migration workflow. I.e., the state transitions from DRAFT to RUNNING. This is a no-op if the state is already RUNNING. An error will be signaled if the state is anything other than DRAFT or RUNNING.

Parameters
Name Description
name MigrationWorkflowName

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
MigrationWorkflowName name = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]");
// Make the request
await migrationServiceClient.StartMigrationWorkflowAsync(name);

StartMigrationWorkflowAsync(StartMigrationWorkflowRequest, CallSettings)

public virtual Task StartMigrationWorkflowAsync(StartMigrationWorkflowRequest request, CallSettings callSettings = null)

Starts a previously created migration workflow. I.e., the state transitions from DRAFT to RUNNING. This is a no-op if the state is already RUNNING. An error will be signaled if the state is anything other than DRAFT or RUNNING.

Parameters
Name Description
request StartMigrationWorkflowRequest

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
Task

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
StartMigrationWorkflowRequest request = new StartMigrationWorkflowRequest
{
    MigrationWorkflowName = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]"),
};
// Make the request
await migrationServiceClient.StartMigrationWorkflowAsync(request);

StartMigrationWorkflowAsync(StartMigrationWorkflowRequest, CancellationToken)

public virtual Task StartMigrationWorkflowAsync(StartMigrationWorkflowRequest request, CancellationToken cancellationToken)

Starts a previously created migration workflow. I.e., the state transitions from DRAFT to RUNNING. This is a no-op if the state is already RUNNING. An error will be signaled if the state is anything other than DRAFT or RUNNING.

Parameters
Name Description
request StartMigrationWorkflowRequest

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

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
StartMigrationWorkflowRequest request = new StartMigrationWorkflowRequest
{
    MigrationWorkflowName = MigrationWorkflowName.FromProjectLocationWorkflow("[PROJECT]", "[LOCATION]", "[WORKFLOW]"),
};
// Make the request
await migrationServiceClient.StartMigrationWorkflowAsync(request);

StartMigrationWorkflowAsync(string, CallSettings)

public virtual Task StartMigrationWorkflowAsync(string name, CallSettings callSettings = null)

Starts a previously created migration workflow. I.e., the state transitions from DRAFT to RUNNING. This is a no-op if the state is already RUNNING. An error will be signaled if the state is anything other than DRAFT or RUNNING.

Parameters
Name Description
name string

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]";
// Make the request
await migrationServiceClient.StartMigrationWorkflowAsync(name);

StartMigrationWorkflowAsync(string, CancellationToken)

public virtual Task StartMigrationWorkflowAsync(string name, CancellationToken cancellationToken)

Starts a previously created migration workflow. I.e., the state transitions from DRAFT to RUNNING. This is a no-op if the state is already RUNNING. An error will be signaled if the state is anything other than DRAFT or RUNNING.

Parameters
Name Description
name string

Required. The unique identifier for the migration workflow. Example: projects/123/locations/us/workflows/1234

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
Task

A Task containing the RPC response.

Example
// Create client
MigrationServiceClient migrationServiceClient = await MigrationServiceClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/workflows/[WORKFLOW]";
// Make the request
await migrationServiceClient.StartMigrationWorkflowAsync(name);