BigQuery Migration v2 API - Class MigrationService.MigrationServiceClient (1.0.0)

public class MigrationServiceClient : ClientBase<MigrationService.MigrationServiceClient>

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

Client for MigrationService

Inheritance

Object > ClientBase > ClientBase<MigrationService.MigrationServiceClient> > MigrationService.MigrationServiceClient

Inherited Members

ClientBase<MigrationService.MigrationServiceClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.BigQuery.Migration.V2

Assembly

Google.Cloud.BigQuery.Migration.V2.dll

Constructors

MigrationServiceClient()

protected MigrationServiceClient()

Protected parameterless constructor to allow creation of test doubles.

MigrationServiceClient(CallInvoker)

public MigrationServiceClient(CallInvoker callInvoker)

Creates a new client for MigrationService that uses a custom CallInvoker.

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

MigrationServiceClient(ChannelBase)

public MigrationServiceClient(ChannelBase channel)

Creates a new client for MigrationService

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

MigrationServiceClient(ClientBase.ClientBaseConfiguration)

protected MigrationServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration` The client configuration.

Methods

CreateMigrationWorkflow(CreateMigrationWorkflowRequest, CallOptions)

public virtual MigrationWorkflow CreateMigrationWorkflow(CreateMigrationWorkflowRequest request, CallOptions options)

Creates a migration workflow.

Parameters
Name	Description
`request`	`CreateMigrationWorkflowRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`MigrationWorkflow`	The response received from the server.

CreateMigrationWorkflow(CreateMigrationWorkflowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual MigrationWorkflow CreateMigrationWorkflow(CreateMigrationWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a migration workflow.

Parameters
Name	Description
`request`	`CreateMigrationWorkflowRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`MigrationWorkflow`	The response received from the server.

CreateMigrationWorkflowAsync(CreateMigrationWorkflowRequest, CallOptions)

public virtual AsyncUnaryCall<MigrationWorkflow> CreateMigrationWorkflowAsync(CreateMigrationWorkflowRequest request, CallOptions options)

Creates a migration workflow.

Parameters
Name	Description
`request`	`CreateMigrationWorkflowRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<MigrationWorkflow>`	The call object.

CreateMigrationWorkflowAsync(CreateMigrationWorkflowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<MigrationWorkflow> CreateMigrationWorkflowAsync(CreateMigrationWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Creates a migration workflow.

Parameters
Name	Description
`request`	`CreateMigrationWorkflowRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<MigrationWorkflow>`	The call object.

DeleteMigrationWorkflow(DeleteMigrationWorkflowRequest, CallOptions)

public virtual Empty DeleteMigrationWorkflow(DeleteMigrationWorkflowRequest request, CallOptions options)

Deletes a migration workflow by name.

Parameters
Name	Description
`request`	`DeleteMigrationWorkflowRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteMigrationWorkflow(DeleteMigrationWorkflowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty DeleteMigrationWorkflow(DeleteMigrationWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a migration workflow by name.

Parameters
Name	Description
`request`	`DeleteMigrationWorkflowRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

DeleteMigrationWorkflowAsync(DeleteMigrationWorkflowRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteMigrationWorkflowAsync(DeleteMigrationWorkflowRequest request, CallOptions options)

Deletes a migration workflow by name.

Parameters
Name	Description
`request`	`DeleteMigrationWorkflowRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Empty>`	The call object.

DeleteMigrationWorkflowAsync(DeleteMigrationWorkflowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteMigrationWorkflowAsync(DeleteMigrationWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Deletes a migration workflow by name.

Parameters
Name	Description
`request`	`DeleteMigrationWorkflowRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Empty>`	The call object.

GetMigrationSubtask(GetMigrationSubtaskRequest, CallOptions)

public virtual MigrationSubtask GetMigrationSubtask(GetMigrationSubtaskRequest request, CallOptions options)

Gets a previously created migration subtask.

Parameters
Name	Description
`request`	`GetMigrationSubtaskRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`MigrationSubtask`	The response received from the server.

GetMigrationSubtask(GetMigrationSubtaskRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual MigrationSubtask GetMigrationSubtask(GetMigrationSubtaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a previously created migration subtask.

Parameters
Name	Description
`request`	`GetMigrationSubtaskRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`MigrationSubtask`	The response received from the server.

GetMigrationSubtaskAsync(GetMigrationSubtaskRequest, CallOptions)

public virtual AsyncUnaryCall<MigrationSubtask> GetMigrationSubtaskAsync(GetMigrationSubtaskRequest request, CallOptions options)

Gets a previously created migration subtask.

Parameters
Name	Description
`request`	`GetMigrationSubtaskRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<MigrationSubtask>`	The call object.

GetMigrationSubtaskAsync(GetMigrationSubtaskRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<MigrationSubtask> GetMigrationSubtaskAsync(GetMigrationSubtaskRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a previously created migration subtask.

Parameters
Name	Description
`request`	`GetMigrationSubtaskRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<MigrationSubtask>`	The call object.

GetMigrationWorkflow(GetMigrationWorkflowRequest, CallOptions)

public virtual MigrationWorkflow GetMigrationWorkflow(GetMigrationWorkflowRequest request, CallOptions options)

Gets a previously created migration workflow.

Parameters
Name	Description
`request`	`GetMigrationWorkflowRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`MigrationWorkflow`	The response received from the server.

GetMigrationWorkflow(GetMigrationWorkflowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual MigrationWorkflow GetMigrationWorkflow(GetMigrationWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a previously created migration workflow.

Parameters
Name	Description
`request`	`GetMigrationWorkflowRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`MigrationWorkflow`	The response received from the server.

GetMigrationWorkflowAsync(GetMigrationWorkflowRequest, CallOptions)

public virtual AsyncUnaryCall<MigrationWorkflow> GetMigrationWorkflowAsync(GetMigrationWorkflowRequest request, CallOptions options)

Gets a previously created migration workflow.

Parameters
Name	Description
`request`	`GetMigrationWorkflowRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<MigrationWorkflow>`	The call object.

GetMigrationWorkflowAsync(GetMigrationWorkflowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<MigrationWorkflow> GetMigrationWorkflowAsync(GetMigrationWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets a previously created migration workflow.

Parameters
Name	Description
`request`	`GetMigrationWorkflowRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<MigrationWorkflow>`	The call object.

ListMigrationSubtasks(ListMigrationSubtasksRequest, CallOptions)

public virtual ListMigrationSubtasksResponse ListMigrationSubtasks(ListMigrationSubtasksRequest request, CallOptions options)

Lists previously created migration subtasks.

Parameters
Name	Description
`request`	`ListMigrationSubtasksRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListMigrationSubtasksResponse`	The response received from the server.

ListMigrationSubtasks(ListMigrationSubtasksRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListMigrationSubtasksResponse ListMigrationSubtasks(ListMigrationSubtasksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists previously created migration subtasks.

Parameters
Name	Description
`request`	`ListMigrationSubtasksRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListMigrationSubtasksResponse`	The response received from the server.

ListMigrationSubtasksAsync(ListMigrationSubtasksRequest, CallOptions)

public virtual AsyncUnaryCall<ListMigrationSubtasksResponse> ListMigrationSubtasksAsync(ListMigrationSubtasksRequest request, CallOptions options)

Lists previously created migration subtasks.

Parameters
Name	Description
`request`	`ListMigrationSubtasksRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<ListMigrationSubtasksResponse>`	The call object.

ListMigrationSubtasksAsync(ListMigrationSubtasksRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListMigrationSubtasksResponse> ListMigrationSubtasksAsync(ListMigrationSubtasksRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists previously created migration subtasks.

Parameters
Name	Description
`request`	`ListMigrationSubtasksRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<ListMigrationSubtasksResponse>`	The call object.

ListMigrationWorkflows(ListMigrationWorkflowsRequest, CallOptions)

public virtual ListMigrationWorkflowsResponse ListMigrationWorkflows(ListMigrationWorkflowsRequest request, CallOptions options)

Lists previously created migration workflow.

Parameters
Name	Description
`request`	`ListMigrationWorkflowsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListMigrationWorkflowsResponse`	The response received from the server.

ListMigrationWorkflows(ListMigrationWorkflowsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListMigrationWorkflowsResponse ListMigrationWorkflows(ListMigrationWorkflowsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists previously created migration workflow.

Parameters
Name	Description
`request`	`ListMigrationWorkflowsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListMigrationWorkflowsResponse`	The response received from the server.

ListMigrationWorkflowsAsync(ListMigrationWorkflowsRequest, CallOptions)

public virtual AsyncUnaryCall<ListMigrationWorkflowsResponse> ListMigrationWorkflowsAsync(ListMigrationWorkflowsRequest request, CallOptions options)

Lists previously created migration workflow.

Parameters
Name	Description
`request`	`ListMigrationWorkflowsRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<ListMigrationWorkflowsResponse>`	The call object.

ListMigrationWorkflowsAsync(ListMigrationWorkflowsRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListMigrationWorkflowsResponse> ListMigrationWorkflowsAsync(ListMigrationWorkflowsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Lists previously created migration workflow.

Parameters
Name	Description
`request`	`ListMigrationWorkflowsRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<ListMigrationWorkflowsResponse>`	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override MigrationService.MigrationServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`MigrationService.MigrationServiceClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.BigQuery.Migration.V2.MigrationService.MigrationServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

StartMigrationWorkflow(StartMigrationWorkflowRequest, CallOptions)

public virtual Empty StartMigrationWorkflow(StartMigrationWorkflowRequest request, CallOptions options)

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 to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Empty`	The response received from the server.

StartMigrationWorkflow(StartMigrationWorkflowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Empty StartMigrationWorkflow(StartMigrationWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters
Name	Description
`request`	`StartMigrationWorkflowRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Empty`	The response received from the server.

StartMigrationWorkflowAsync(StartMigrationWorkflowRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> StartMigrationWorkflowAsync(StartMigrationWorkflowRequest request, CallOptions options)

Parameters
Name	Description
`request`	`StartMigrationWorkflowRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Empty>`	The call object.

StartMigrationWorkflowAsync(StartMigrationWorkflowRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Empty> StartMigrationWorkflowAsync(StartMigrationWorkflowRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters
Name	Description
`request`	`StartMigrationWorkflowRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Empty>`	The call object.