Google Cloud Rapid Migration Assessment V1 Client - Class RapidMigrationAssessmentClient (0.1.1)

Reference documentation and code samples for the Google Cloud Rapid Migration Assessment V1 Client class RapidMigrationAssessmentClient.

Service Description: Rapid Migration Assessment service

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ RapidMigrationAssessment \ V1 \ Client

Methods

__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.

createAnnotation

Creates an Annotation

The async variant is Google\Cloud\RapidMigrationAssessment\V1\Client\BaseClient\self::createAnnotationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\CreateAnnotationRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\RapidMigrationAssessment\V1\Annotation;
use Google\Cloud\RapidMigrationAssessment\V1\Client\RapidMigrationAssessmentClient;
use Google\Cloud\RapidMigrationAssessment\V1\CreateAnnotationRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent Name of the parent (project+location). Please see
 *                                {@see RapidMigrationAssessmentClient::locationName()} for help formatting this field.
 */
function create_annotation_sample(string $formattedParent): void
{
    // Create a client.
    $rapidMigrationAssessmentClient = new RapidMigrationAssessmentClient();

    // Prepare the request message.
    $annotation = new Annotation();
    $request = (new CreateAnnotationRequest())
        ->setParent($formattedParent)
        ->setAnnotation($annotation);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $rapidMigrationAssessmentClient->createAnnotation($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Annotation $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 = RapidMigrationAssessmentClient::locationName('[PROJECT]', '[LOCATION]');

    create_annotation_sample($formattedParent);
}

createCollector

Create a Collector to manage the on-prem appliance which collects information about Customer assets.

The async variant is Google\Cloud\RapidMigrationAssessment\V1\Client\BaseClient\self::createCollectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\CreateCollectorRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\RapidMigrationAssessment\V1\Client\RapidMigrationAssessmentClient;
use Google\Cloud\RapidMigrationAssessment\V1\Collector;
use Google\Cloud\RapidMigrationAssessment\V1\CreateCollectorRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedParent Name of the parent (project+location). Please see
 *                                {@see RapidMigrationAssessmentClient::locationName()} for help formatting this field.
 * @param string $collectorId     Id of the requesting object.
 */
function create_collector_sample(string $formattedParent, string $collectorId): void
{
    // Create a client.
    $rapidMigrationAssessmentClient = new RapidMigrationAssessmentClient();

    // Prepare the request message.
    $collector = new Collector();
    $request = (new CreateCollectorRequest())
        ->setParent($formattedParent)
        ->setCollectorId($collectorId)
        ->setCollector($collector);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $rapidMigrationAssessmentClient->createCollector($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Collector $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 = RapidMigrationAssessmentClient::locationName('[PROJECT]', '[LOCATION]');
    $collectorId = '[COLLECTOR_ID]';

    create_collector_sample($formattedParent, $collectorId);
}

deleteCollector

Deletes a single Collector - changes state of collector to "Deleting".

The async variant is Google\Cloud\RapidMigrationAssessment\V1\Client\BaseClient\self::deleteCollectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\DeleteCollectorRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\RapidMigrationAssessment\V1\Client\RapidMigrationAssessmentClient;
use Google\Cloud\RapidMigrationAssessment\V1\Collector;
use Google\Cloud\RapidMigrationAssessment\V1\DeleteCollectorRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the resource. Please see
 *                              {@see RapidMigrationAssessmentClient::collectorName()} for help formatting this field.
 */
function delete_collector_sample(string $formattedName): void
{
    // Create a client.
    $rapidMigrationAssessmentClient = new RapidMigrationAssessmentClient();

    // Prepare the request message.
    $request = (new DeleteCollectorRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $rapidMigrationAssessmentClient->deleteCollector($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Collector $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 = RapidMigrationAssessmentClient::collectorName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTOR]'
    );

    delete_collector_sample($formattedName);
}

getAnnotation

Gets details of a single Annotation.

The async variant is Google\Cloud\RapidMigrationAssessment\V1\Client\BaseClient\self::getAnnotationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\GetAnnotationRequest` A request to house fields associated with the call.
`callOptions`	`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\RapidMigrationAssessment\V1\Annotation`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\RapidMigrationAssessment\V1\Annotation;
use Google\Cloud\RapidMigrationAssessment\V1\Client\RapidMigrationAssessmentClient;
use Google\Cloud\RapidMigrationAssessment\V1\GetAnnotationRequest;

/**
 * @param string $formattedName Name of the resource. Please see
 *                              {@see RapidMigrationAssessmentClient::annotationName()} for help formatting this field.
 */
function get_annotation_sample(string $formattedName): void
{
    // Create a client.
    $rapidMigrationAssessmentClient = new RapidMigrationAssessmentClient();

    // Prepare the request message.
    $request = (new GetAnnotationRequest())
        ->setName($formattedName);

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

/**
 * Helper to execute the sample.
 *
 * 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 = RapidMigrationAssessmentClient::annotationName(
        '[PROJECT]',
        '[LOCATION]',
        '[ANNOTATION]'
    );

    get_annotation_sample($formattedName);
}

getCollector

Gets details of a single Collector.

The async variant is Google\Cloud\RapidMigrationAssessment\V1\Client\BaseClient\self::getCollectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\GetCollectorRequest` A request to house fields associated with the call.
`callOptions`	`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\RapidMigrationAssessment\V1\Collector`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\RapidMigrationAssessment\V1\Client\RapidMigrationAssessmentClient;
use Google\Cloud\RapidMigrationAssessment\V1\Collector;
use Google\Cloud\RapidMigrationAssessment\V1\GetCollectorRequest;

/**
 * @param string $formattedName Name of the resource. Please see
 *                              {@see RapidMigrationAssessmentClient::collectorName()} for help formatting this field.
 */
function get_collector_sample(string $formattedName): void
{
    // Create a client.
    $rapidMigrationAssessmentClient = new RapidMigrationAssessmentClient();

    // Prepare the request message.
    $request = (new GetCollectorRequest())
        ->setName($formattedName);

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

/**
 * Helper to execute the sample.
 *
 * 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 = RapidMigrationAssessmentClient::collectorName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTOR]'
    );

    get_collector_sample($formattedName);
}

listCollectors

Lists Collectors in a given project and location.

The async variant is Google\Cloud\RapidMigrationAssessment\V1\Client\BaseClient\self::listCollectorsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\ListCollectorsRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\RapidMigrationAssessment\V1\Client\RapidMigrationAssessmentClient;
use Google\Cloud\RapidMigrationAssessment\V1\Collector;
use Google\Cloud\RapidMigrationAssessment\V1\ListCollectorsRequest;

/**
 * @param string $formattedParent Parent value for ListCollectorsRequest. Please see
 *                                {@see RapidMigrationAssessmentClient::locationName()} for help formatting this field.
 */
function list_collectors_sample(string $formattedParent): void
{
    // Create a client.
    $rapidMigrationAssessmentClient = new RapidMigrationAssessmentClient();

    // Prepare the request message.
    $request = (new ListCollectorsRequest())
        ->setParent($formattedParent);

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

        /** @var Collector $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());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 = RapidMigrationAssessmentClient::locationName('[PROJECT]', '[LOCATION]');

    list_collectors_sample($formattedParent);
}

pauseCollector

Pauses the given collector.

The async variant is Google\Cloud\RapidMigrationAssessment\V1\Client\BaseClient\self::pauseCollectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\PauseCollectorRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\RapidMigrationAssessment\V1\Client\RapidMigrationAssessmentClient;
use Google\Cloud\RapidMigrationAssessment\V1\Collector;
use Google\Cloud\RapidMigrationAssessment\V1\PauseCollectorRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the resource. Please see
 *                              {@see RapidMigrationAssessmentClient::collectorName()} for help formatting this field.
 */
function pause_collector_sample(string $formattedName): void
{
    // Create a client.
    $rapidMigrationAssessmentClient = new RapidMigrationAssessmentClient();

    // Prepare the request message.
    $request = (new PauseCollectorRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $rapidMigrationAssessmentClient->pauseCollector($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Collector $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 = RapidMigrationAssessmentClient::collectorName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTOR]'
    );

    pause_collector_sample($formattedName);
}

registerCollector

Registers the given collector.

The async variant is Google\Cloud\RapidMigrationAssessment\V1\Client\BaseClient\self::registerCollectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\RegisterCollectorRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\RapidMigrationAssessment\V1\Client\RapidMigrationAssessmentClient;
use Google\Cloud\RapidMigrationAssessment\V1\Collector;
use Google\Cloud\RapidMigrationAssessment\V1\RegisterCollectorRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the resource. Please see
 *                              {@see RapidMigrationAssessmentClient::collectorName()} for help formatting this field.
 */
function register_collector_sample(string $formattedName): void
{
    // Create a client.
    $rapidMigrationAssessmentClient = new RapidMigrationAssessmentClient();

    // Prepare the request message.
    $request = (new RegisterCollectorRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $rapidMigrationAssessmentClient->registerCollector($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Collector $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 = RapidMigrationAssessmentClient::collectorName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTOR]'
    );

    register_collector_sample($formattedName);
}

resumeCollector

Resumes the given collector.

The async variant is Google\Cloud\RapidMigrationAssessment\V1\Client\BaseClient\self::resumeCollectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\ResumeCollectorRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\RapidMigrationAssessment\V1\Client\RapidMigrationAssessmentClient;
use Google\Cloud\RapidMigrationAssessment\V1\Collector;
use Google\Cloud\RapidMigrationAssessment\V1\ResumeCollectorRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the resource. Please see
 *                              {@see RapidMigrationAssessmentClient::collectorName()} for help formatting this field.
 */
function resume_collector_sample(string $formattedName): void
{
    // Create a client.
    $rapidMigrationAssessmentClient = new RapidMigrationAssessmentClient();

    // Prepare the request message.
    $request = (new ResumeCollectorRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $rapidMigrationAssessmentClient->resumeCollector($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Collector $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * 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 = RapidMigrationAssessmentClient::collectorName(
        '[PROJECT]',
        '[LOCATION]',
        '[COLLECTOR]'
    );

    resume_collector_sample($formattedName);
}

updateCollector

Updates the parameters of a single Collector.

The async variant is Google\Cloud\RapidMigrationAssessment\V1\Client\BaseClient\self::updateCollectorAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\UpdateCollectorRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\RapidMigrationAssessment\V1\Client\RapidMigrationAssessmentClient;
use Google\Cloud\RapidMigrationAssessment\V1\Collector;
use Google\Cloud\RapidMigrationAssessment\V1\UpdateCollectorRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * 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 update_collector_sample(): void
{
    // Create a client.
    $rapidMigrationAssessmentClient = new RapidMigrationAssessmentClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $collector = new Collector();
    $request = (new UpdateCollectorRequest())
        ->setUpdateMask($updateMask)
        ->setCollector($collector);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $rapidMigrationAssessmentClient->updateCollector($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Collector $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

getLocation

Gets information about a location.

The async variant is Google\Cloud\RapidMigrationAssessment\V1\Client\BaseClient\self::getLocationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest` A request to house fields associated with the call.
`callOptions`	`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\Location\Location`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\RapidMigrationAssessment\V1\Client\RapidMigrationAssessmentClient;

/**
 * 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 get_location_sample(): void
{
    // Create a client.
    $rapidMigrationAssessmentClient = new RapidMigrationAssessmentClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

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

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\RapidMigrationAssessment\V1\Client\BaseClient\self::listLocationsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest` A request to house fields associated with the call.
`callOptions`	`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\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\RapidMigrationAssessment\V1\Client\RapidMigrationAssessmentClient;

/**
 * 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 list_locations_sample(): void
{
    // Create a client.
    $rapidMigrationAssessmentClient = new RapidMigrationAssessmentClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

        /** @var Location $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());
    }
}

createAnnotationAsync

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\CreateAnnotationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createCollectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\CreateCollectorRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteCollectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\DeleteCollectorRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getAnnotationAsync

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\GetAnnotationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getCollectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\GetCollectorRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listCollectorsAsync

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\ListCollectorsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

pauseCollectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\PauseCollectorRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

registerCollectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\RegisterCollectorRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

resumeCollectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\ResumeCollectorRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateCollectorAsync

Parameters
Name	Description
`request`	`Google\Cloud\RapidMigrationAssessment\V1\UpdateCollectorRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getLocationAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\GetLocationRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listLocationsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Location\ListLocationsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::annotationName

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

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

Returns
Type	Description
`string`	The formatted annotation resource.

static::collectorName

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

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

Returns
Type	Description
`string`	The formatted collector resource.

static::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.

static::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

annotation: projects/{project}/locations/{location}/annotations/{annotation}
collector: projects/{project}/locations/{location}/collectors/{collector}
location: projects/{project}/locations/{location}

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.