Google Cloud BigQuery Migration V2 Client - Class MigrationServiceClient (0.1.4)

Reference documentation and code samples for the Google Cloud BigQuery Migration V2 Client class MigrationServiceClient.

Service Description: Service to handle EDW migrations.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$migrationServiceClient = new MigrationServiceClient();
try {
    $formattedParent = $migrationServiceClient->locationName('[PROJECT]', '[LOCATION]');
    $migrationWorkflow = new MigrationWorkflow();
    $response = $migrationServiceClient->createMigrationWorkflow($formattedParent, $migrationWorkflow);
} finally {
    $migrationServiceClient->close();
}

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Methods

locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

migrationSubtaskName

Formats a string containing the fully-qualified path to represent a migration_subtask resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`workflow`	`string`
`subtask`	`string`

Returns
Type	Description
`string`	The formatted migration_subtask resource.

migrationWorkflowName

Formats a string containing the fully-qualified path to represent a migration_workflow resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`workflow`	`string`

Returns
Type	Description
`string`	The formatted migration_workflow resource.

parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

location: projects/{project}/locations/{location}
migrationSubtask: projects/{project}/locations/{location}/workflows/{workflow}/subtasks/{subtask}
migrationWorkflow: projects/{project}/locations/{location}/workflows/{workflow}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

createMigrationWorkflow

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`	`Google\Cloud\BigQuery\Migration\V2\MigrationWorkflow` Required. The migration workflow to create.
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\BigQuery\Migration\V2\MigrationWorkflow`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Migration\V2\MigrationServiceClient;
use Google\Cloud\BigQuery\Migration\V2\MigrationWorkflow;

/**
 * @param string $formattedParent The name of the project to which this migration workflow belongs.
 *                                Example: `projects/foo/locations/bar`
 *                                Please see {@see MigrationServiceClient::locationName()} for help formatting this field.
 */
function create_migration_workflow_sample(string $formattedParent): void
{
    // Create a client.
    $migrationServiceClient = new MigrationServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $migrationWorkflow = new MigrationWorkflow();

    // Call the API and handle any network failures.
    try {
        /** @var MigrationWorkflow $response */
        $response = $migrationServiceClient->createMigrationWorkflow($formattedParent, $migrationWorkflow);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = MigrationServiceClient::locationName('[PROJECT]', '[LOCATION]');

    create_migration_workflow_sample($formattedParent);
}

deleteMigrationWorkflow

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`
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Migration\V2\MigrationServiceClient;

/**
 * @param string $formattedName The unique identifier for the migration workflow.
 *                              Example: `projects/123/locations/us/workflows/1234`
 *                              Please see {@see MigrationServiceClient::migrationWorkflowName()} for help formatting this field.
 */
function delete_migration_workflow_sample(string $formattedName): void
{
    // Create a client.
    $migrationServiceClient = new MigrationServiceClient();

    // Call the API and handle any network failures.
    try {
        $migrationServiceClient->deleteMigrationWorkflow($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = MigrationServiceClient::migrationWorkflowName(
        '[PROJECT]',
        '[LOCATION]',
        '[WORKFLOW]'
    );

    delete_migration_workflow_sample($formattedName);
}

getMigrationSubtask

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`
`optionalArgs`	`array` Optional.
`↳ readMask`	`FieldMask` Optional. The list of fields to be retrieved.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\BigQuery\Migration\V2\MigrationSubtask`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Migration\V2\MigrationServiceClient;
use Google\Cloud\BigQuery\Migration\V2\MigrationSubtask;

/**
 * @param string $formattedName The unique identifier for the migration subtask.
 *                              Example: `projects/123/locations/us/workflows/1234/subtasks/543`
 *                              Please see {@see MigrationServiceClient::migrationSubtaskName()} for help formatting this field.
 */
function get_migration_subtask_sample(string $formattedName): void
{
    // Create a client.
    $migrationServiceClient = new MigrationServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var MigrationSubtask $response */
        $response = $migrationServiceClient->getMigrationSubtask($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = MigrationServiceClient::migrationSubtaskName(
        '[PROJECT]',
        '[LOCATION]',
        '[WORKFLOW]',
        '[SUBTASK]'
    );

    get_migration_subtask_sample($formattedName);
}

getMigrationWorkflow

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`
`optionalArgs`	`array` Optional.
`↳ readMask`	`FieldMask` The list of fields to be retrieved.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\BigQuery\Migration\V2\MigrationWorkflow`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Migration\V2\MigrationServiceClient;
use Google\Cloud\BigQuery\Migration\V2\MigrationWorkflow;

/**
 * @param string $formattedName The unique identifier for the migration workflow.
 *                              Example: `projects/123/locations/us/workflows/1234`
 *                              Please see {@see MigrationServiceClient::migrationWorkflowName()} for help formatting this field.
 */
function get_migration_workflow_sample(string $formattedName): void
{
    // Create a client.
    $migrationServiceClient = new MigrationServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var MigrationWorkflow $response */
        $response = $migrationServiceClient->getMigrationWorkflow($formattedName);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = MigrationServiceClient::migrationWorkflowName(
        '[PROJECT]',
        '[LOCATION]',
        '[WORKFLOW]'
    );

    get_migration_workflow_sample($formattedName);
}

listMigrationSubtasks

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`
`optionalArgs`	`array` Optional.
`↳ readMask`	`FieldMask` Optional. The list of fields to be retrieved.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ filter`	`string` Optional. The filter to apply. This can be used to get the subtasks of a specific tasks in a workflow, e.g. `migration_task = "ab012"` where `"ab012"` is the task ID (not the name in the named map).
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BigQuery\Migration\V2\MigrationServiceClient;
use Google\Cloud\BigQuery\Migration\V2\MigrationSubtask;

/**
 * @param string $formattedParent The migration task of the subtasks to list.
 *                                Example: `projects/123/locations/us/workflows/1234`
 *                                Please see {@see MigrationServiceClient::migrationWorkflowName()} for help formatting this field.
 */
function list_migration_subtasks_sample(string $formattedParent): void
{
    // Create a client.
    $migrationServiceClient = new MigrationServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $migrationServiceClient->listMigrationSubtasks($formattedParent);

        /** @var MigrationSubtask $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = MigrationServiceClient::migrationWorkflowName(
        '[PROJECT]',
        '[LOCATION]',
        '[WORKFLOW]'
    );

    list_migration_subtasks_sample($formattedParent);
}

listMigrationWorkflows

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`
`optionalArgs`	`array` Optional.
`↳ readMask`	`FieldMask` The list of fields to be retrieved.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\BigQuery\Migration\V2\MigrationServiceClient;
use Google\Cloud\BigQuery\Migration\V2\MigrationWorkflow;

/**
 * @param string $formattedParent The project and location of the migration workflows to list.
 *                                Example: `projects/123/locations/us`
 *                                Please see {@see MigrationServiceClient::locationName()} for help formatting this field.
 */
function list_migration_workflows_sample(string $formattedParent): void
{
    // Create a client.
    $migrationServiceClient = new MigrationServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $migrationServiceClient->listMigrationWorkflows($formattedParent);

        /** @var MigrationWorkflow $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = MigrationServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_migration_workflows_sample($formattedParent);
}

startMigrationWorkflow

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`
`optionalArgs`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Example

use Google\ApiCore\ApiException;
use Google\Cloud\BigQuery\Migration\V2\MigrationServiceClient;

/**
 * @param string $formattedName The unique identifier for the migration workflow.
 *                              Example: `projects/123/locations/us/workflows/1234`
 *                              Please see {@see MigrationServiceClient::migrationWorkflowName()} for help formatting this field.
 */
function start_migration_workflow_sample(string $formattedName): void
{
    // Create a client.
    $migrationServiceClient = new MigrationServiceClient();

    // Call the API and handle any network failures.
    try {
        $migrationServiceClient->startMigrationWorkflow($formattedName);
        printf('Call completed successfully.' . PHP_EOL);
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = MigrationServiceClient::migrationWorkflowName(
        '[PROJECT]',
        '[LOCATION]',
        '[WORKFLOW]'
    );

    start_migration_workflow_sample($formattedName);
}

Constants

SERVICE_NAME

Value: 'google.cloud.bigquery.migration.v2.MigrationService'

The name of the service.

SERVICE_ADDRESS

Value: 'bigquerymigration.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.