Google Cloud Telco Automation V1 Client - Class TelcoAutomationClient (1.0.1)

Reference documentation and code samples for the Google Cloud Telco Automation V1 Client class TelcoAutomationClient.

Service Description: TelcoAutomation Service manages the control plane cluster a.k.a.

Orchestration Cluster (GKE cluster with config controller) of TNA. It also exposes blueprint APIs which manages the lifecycle of blueprints that control the infrastructure setup (e.g GDCE clusters) and deployment of network functions.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

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.

Namespace

Google \ Cloud \ TelcoAutomation \ 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.

applyDeployment

Applies the deployment's YAML files to the parent orchestration cluster.

The async variant is TelcoAutomationClient::applyDeploymentAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ApplyDeploymentRequest

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\TelcoAutomation\V1\Deployment
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\ApplyDeploymentRequest;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\Deployment;

/**
 * @param string $formattedName The name of the deployment to apply to orchestration cluster. Please see
 *                              {@see TelcoAutomationClient::deploymentName()} for help formatting this field.
 */
function apply_deployment_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Deployment $response */
        $response = $telcoAutomationClient->applyDeployment($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 = TelcoAutomationClient::deploymentName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[DEPLOYMENT]'
    );

    apply_deployment_sample($formattedName);
}

applyHydratedDeployment

Applies a hydrated deployment to a workload cluster.

The async variant is TelcoAutomationClient::applyHydratedDeploymentAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ApplyHydratedDeploymentRequest

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\TelcoAutomation\V1\HydratedDeployment
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\ApplyHydratedDeploymentRequest;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\HydratedDeployment;

/**
 * @param string $formattedName The name of the hydrated deployment to apply. Please see
 *                              {@see TelcoAutomationClient::hydratedDeploymentName()} for help formatting this field.
 */
function apply_hydrated_deployment_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var HydratedDeployment $response */
        $response = $telcoAutomationClient->applyHydratedDeployment($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 = TelcoAutomationClient::hydratedDeploymentName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[DEPLOYMENT]',
        '[HYDRATED_DEPLOYMENT]'
    );

    apply_hydrated_deployment_sample($formattedName);
}

approveBlueprint

Approves a blueprint and commits a new revision.

The async variant is TelcoAutomationClient::approveBlueprintAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ApproveBlueprintRequest

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\TelcoAutomation\V1\Blueprint
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\ApproveBlueprintRequest;
use Google\Cloud\TelcoAutomation\V1\Blueprint;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;

/**
 * @param string $formattedName The name of the blueprint to approve. The blueprint must be in
 *                              Proposed state. A new revision is committed on approval. Please see
 *                              {@see TelcoAutomationClient::blueprintName()} for help formatting this field.
 */
function approve_blueprint_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Blueprint $response */
        $response = $telcoAutomationClient->approveBlueprint($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 = TelcoAutomationClient::blueprintName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[BLUEPRINT]'
    );

    approve_blueprint_sample($formattedName);
}

computeDeploymentStatus

Returns the requested deployment status.

The async variant is TelcoAutomationClient::computeDeploymentStatusAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ComputeDeploymentStatusRequest

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\TelcoAutomation\V1\ComputeDeploymentStatusResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\ComputeDeploymentStatusRequest;
use Google\Cloud\TelcoAutomation\V1\ComputeDeploymentStatusResponse;

/**
 * @param string $formattedName The name of the deployment without revisionID. Please see
 *                              {@see TelcoAutomationClient::deploymentName()} for help formatting this field.
 */
function compute_deployment_status_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ComputeDeploymentStatusResponse $response */
        $response = $telcoAutomationClient->computeDeploymentStatus($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 = TelcoAutomationClient::deploymentName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[DEPLOYMENT]'
    );

    compute_deployment_status_sample($formattedName);
}

createBlueprint

Creates a blueprint.

The async variant is TelcoAutomationClient::createBlueprintAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\CreateBlueprintRequest

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\TelcoAutomation\V1\Blueprint
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Blueprint;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\CreateBlueprintRequest;

/**
 * @param string $formattedParent          The name of parent resource.
 *                                         Format should be -
 *                                         "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". Please see
 *                                         {@see TelcoAutomationClient::orchestrationClusterName()} for help formatting this field.
 * @param string $blueprintSourceBlueprint Immutable. The public blueprint ID from which this blueprint was
 *                                         created.
 */
function create_blueprint_sample(string $formattedParent, string $blueprintSourceBlueprint): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

    // Prepare the request message.
    $blueprint = (new Blueprint())
        ->setSourceBlueprint($blueprintSourceBlueprint);
    $request = (new CreateBlueprintRequest())
        ->setParent($formattedParent)
        ->setBlueprint($blueprint);

    // Call the API and handle any network failures.
    try {
        /** @var Blueprint $response */
        $response = $telcoAutomationClient->createBlueprint($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
{
    $formattedParent = TelcoAutomationClient::orchestrationClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]'
    );
    $blueprintSourceBlueprint = '[SOURCE_BLUEPRINT]';

    create_blueprint_sample($formattedParent, $blueprintSourceBlueprint);
}

createDeployment

Creates a deployment.

The async variant is TelcoAutomationClient::createDeploymentAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\CreateDeploymentRequest

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\TelcoAutomation\V1\Deployment
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\CreateDeploymentRequest;
use Google\Cloud\TelcoAutomation\V1\Deployment;

/**
 * @param string $formattedParent                   The name of parent resource.
 *                                                  Format should be -
 *                                                  "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". Please see
 *                                                  {@see TelcoAutomationClient::orchestrationClusterName()} for help formatting this field.
 * @param string $deploymentSourceBlueprintRevision The blueprint revision from which this deployment was created.
 */
function create_deployment_sample(
    string $formattedParent,
    string $deploymentSourceBlueprintRevision
): void {
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

    // Prepare the request message.
    $deployment = (new Deployment())
        ->setSourceBlueprintRevision($deploymentSourceBlueprintRevision);
    $request = (new CreateDeploymentRequest())
        ->setParent($formattedParent)
        ->setDeployment($deployment);

    // Call the API and handle any network failures.
    try {
        /** @var Deployment $response */
        $response = $telcoAutomationClient->createDeployment($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
{
    $formattedParent = TelcoAutomationClient::orchestrationClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]'
    );
    $deploymentSourceBlueprintRevision = '[SOURCE_BLUEPRINT_REVISION]';

    create_deployment_sample($formattedParent, $deploymentSourceBlueprintRevision);
}

createEdgeSlm

Creates a new EdgeSlm in a given project and location.

The async variant is TelcoAutomationClient::createEdgeSlmAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\CreateEdgeSlmRequest

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\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\CreateEdgeSlmRequest;
use Google\Cloud\TelcoAutomation\V1\EdgeSlm;
use Google\Rpc\Status;

/**
 * @param string $formattedParent Value for parent. Please see
 *                                {@see TelcoAutomationClient::locationName()} for help formatting this field.
 * @param string $edgeSlmId       Id of the requesting object
 *                                If auto-generating Id server-side, remove this field and
 *                                edge_slm_id from the method_signature of Create RPC
 */
function create_edge_slm_sample(string $formattedParent, string $edgeSlmId): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

    // Prepare the request message.
    $edgeSlm = new EdgeSlm();
    $request = (new CreateEdgeSlmRequest())
        ->setParent($formattedParent)
        ->setEdgeSlmId($edgeSlmId)
        ->setEdgeSlm($edgeSlm);

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

        if ($response->operationSucceeded()) {
            /** @var EdgeSlm $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 = TelcoAutomationClient::locationName('[PROJECT]', '[LOCATION]');
    $edgeSlmId = '[EDGE_SLM_ID]';

    create_edge_slm_sample($formattedParent, $edgeSlmId);
}

createOrchestrationCluster

Creates a new OrchestrationCluster in a given project and location.

The async variant is TelcoAutomationClient::createOrchestrationClusterAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\CreateOrchestrationClusterRequest

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\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\CreateOrchestrationClusterRequest;
use Google\Cloud\TelcoAutomation\V1\OrchestrationCluster;
use Google\Rpc\Status;

/**
 * @param string $formattedParent        Value for parent. Please see
 *                                       {@see TelcoAutomationClient::locationName()} for help formatting this field.
 * @param string $orchestrationClusterId Id of the requesting object
 *                                       If auto-generating Id server-side, remove this field and
 *                                       orchestration_cluster_id from the method_signature of Create RPC
 */
function create_orchestration_cluster_sample(
    string $formattedParent,
    string $orchestrationClusterId
): void {
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

    // Prepare the request message.
    $orchestrationCluster = new OrchestrationCluster();
    $request = (new CreateOrchestrationClusterRequest())
        ->setParent($formattedParent)
        ->setOrchestrationClusterId($orchestrationClusterId)
        ->setOrchestrationCluster($orchestrationCluster);

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

        if ($response->operationSucceeded()) {
            /** @var OrchestrationCluster $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 = TelcoAutomationClient::locationName('[PROJECT]', '[LOCATION]');
    $orchestrationClusterId = '[ORCHESTRATION_CLUSTER_ID]';

    create_orchestration_cluster_sample($formattedParent, $orchestrationClusterId);
}

deleteBlueprint

Deletes a blueprint and all its revisions.

The async variant is TelcoAutomationClient::deleteBlueprintAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\DeleteBlueprintRequest

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.
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\DeleteBlueprintRequest;

/**
 * @param string $formattedName The name of blueprint to delete.
 *                              Blueprint name should be in the format {blueprint_id}, if
 *                              {blueprint_id}@{revision_id} is passed then the API throws invalid
 *                              argument. Please see
 *                              {@see TelcoAutomationClient::blueprintName()} for help formatting this field.
 */
function delete_blueprint_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        $telcoAutomationClient->deleteBlueprint($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = TelcoAutomationClient::blueprintName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[BLUEPRINT]'
    );

    delete_blueprint_sample($formattedName);
}

deleteEdgeSlm

Deletes a single EdgeSlm.

The async variant is TelcoAutomationClient::deleteEdgeSlmAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\DeleteEdgeSlmRequest

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\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\DeleteEdgeSlmRequest;
use Google\Rpc\Status;

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

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

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

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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 = TelcoAutomationClient::edgeSlmName('[PROJECT]', '[LOCATION]', '[EDGE_SLM]');

    delete_edge_slm_sample($formattedName);
}

deleteOrchestrationCluster

Deletes a single OrchestrationCluster.

The async variant is TelcoAutomationClient::deleteOrchestrationClusterAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\DeleteOrchestrationClusterRequest

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\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\DeleteOrchestrationClusterRequest;
use Google\Rpc\Status;

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

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

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

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } 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 = TelcoAutomationClient::orchestrationClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]'
    );

    delete_orchestration_cluster_sample($formattedName);
}

discardBlueprintChanges

Discards the changes in a blueprint and reverts the blueprint to the last approved blueprint revision. No changes take place if a blueprint does not have revisions.

The async variant is TelcoAutomationClient::discardBlueprintChangesAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\DiscardBlueprintChangesRequest

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\TelcoAutomation\V1\DiscardBlueprintChangesResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\DiscardBlueprintChangesRequest;
use Google\Cloud\TelcoAutomation\V1\DiscardBlueprintChangesResponse;

/**
 * @param string $formattedName The name of the blueprint of which changes are being discarded. Please see
 *                              {@see TelcoAutomationClient::blueprintName()} for help formatting this field.
 */
function discard_blueprint_changes_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DiscardBlueprintChangesResponse $response */
        $response = $telcoAutomationClient->discardBlueprintChanges($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 = TelcoAutomationClient::blueprintName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[BLUEPRINT]'
    );

    discard_blueprint_changes_sample($formattedName);
}

discardDeploymentChanges

Discards the changes in a deployment and reverts the deployment to the last approved deployment revision. No changes take place if a deployment does not have revisions.

The async variant is TelcoAutomationClient::discardDeploymentChangesAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\DiscardDeploymentChangesRequest

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\TelcoAutomation\V1\DiscardDeploymentChangesResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\DiscardDeploymentChangesRequest;
use Google\Cloud\TelcoAutomation\V1\DiscardDeploymentChangesResponse;

/**
 * @param string $formattedName The name of the deployment of which changes are being discarded. Please see
 *                              {@see TelcoAutomationClient::deploymentName()} for help formatting this field.
 */
function discard_deployment_changes_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DiscardDeploymentChangesResponse $response */
        $response = $telcoAutomationClient->discardDeploymentChanges($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 = TelcoAutomationClient::deploymentName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[DEPLOYMENT]'
    );

    discard_deployment_changes_sample($formattedName);
}

getBlueprint

Returns the requested blueprint.

The async variant is TelcoAutomationClient::getBlueprintAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\GetBlueprintRequest

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\TelcoAutomation\V1\Blueprint
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Blueprint;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\GetBlueprintRequest;

/**
 * @param string $formattedName The name of the blueprint.
 *                              Case 1: If the name provided in the request is
 *                              {blueprint_id}@{revision_id}, then the revision with revision_id will be
 *                              returned. Case 2: If the name provided in the request is {blueprint}, then
 *                              the current state of the blueprint is returned. Please see
 *                              {@see TelcoAutomationClient::blueprintName()} for help formatting this field.
 */
function get_blueprint_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Blueprint $response */
        $response = $telcoAutomationClient->getBlueprint($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 = TelcoAutomationClient::blueprintName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[BLUEPRINT]'
    );

    get_blueprint_sample($formattedName);
}

getDeployment

Returns the requested deployment.

The async variant is TelcoAutomationClient::getDeploymentAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\GetDeploymentRequest

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\TelcoAutomation\V1\Deployment
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\Deployment;
use Google\Cloud\TelcoAutomation\V1\GetDeploymentRequest;

/**
 * @param string $formattedName The name of the deployment.
 *                              Case 1: If the name provided in the request is
 *                              {deployment_id}@{revision_id}, then the revision with revision_id will be
 *                              returned.
 *                              Case 2: If the name provided in the request is {deployment}, then
 *                              the current state of the deployment is returned. Please see
 *                              {@see TelcoAutomationClient::deploymentName()} for help formatting this field.
 */
function get_deployment_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Deployment $response */
        $response = $telcoAutomationClient->getDeployment($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 = TelcoAutomationClient::deploymentName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[DEPLOYMENT]'
    );

    get_deployment_sample($formattedName);
}

getEdgeSlm

Gets details of a single EdgeSlm.

The async variant is TelcoAutomationClient::getEdgeSlmAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\GetEdgeSlmRequest

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\TelcoAutomation\V1\EdgeSlm
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\EdgeSlm;
use Google\Cloud\TelcoAutomation\V1\GetEdgeSlmRequest;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var EdgeSlm $response */
        $response = $telcoAutomationClient->getEdgeSlm($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 = TelcoAutomationClient::edgeSlmName('[PROJECT]', '[LOCATION]', '[EDGE_SLM]');

    get_edge_slm_sample($formattedName);
}

getHydratedDeployment

Returns the requested hydrated deployment.

The async variant is TelcoAutomationClient::getHydratedDeploymentAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\GetHydratedDeploymentRequest

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\TelcoAutomation\V1\HydratedDeployment
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\GetHydratedDeploymentRequest;
use Google\Cloud\TelcoAutomation\V1\HydratedDeployment;

/**
 * @param string $formattedName Name of the hydrated deployment. Please see
 *                              {@see TelcoAutomationClient::hydratedDeploymentName()} for help formatting this field.
 */
function get_hydrated_deployment_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var HydratedDeployment $response */
        $response = $telcoAutomationClient->getHydratedDeployment($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 = TelcoAutomationClient::hydratedDeploymentName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[DEPLOYMENT]',
        '[HYDRATED_DEPLOYMENT]'
    );

    get_hydrated_deployment_sample($formattedName);
}

getOrchestrationCluster

Gets details of a single OrchestrationCluster.

The async variant is TelcoAutomationClient::getOrchestrationClusterAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\GetOrchestrationClusterRequest

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\TelcoAutomation\V1\OrchestrationCluster
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\GetOrchestrationClusterRequest;
use Google\Cloud\TelcoAutomation\V1\OrchestrationCluster;

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

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

    // Call the API and handle any network failures.
    try {
        /** @var OrchestrationCluster $response */
        $response = $telcoAutomationClient->getOrchestrationCluster($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 = TelcoAutomationClient::orchestrationClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]'
    );

    get_orchestration_cluster_sample($formattedName);
}

getPublicBlueprint

Returns the requested public blueprint.

The async variant is TelcoAutomationClient::getPublicBlueprintAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\GetPublicBlueprintRequest

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\TelcoAutomation\V1\PublicBlueprint
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\GetPublicBlueprintRequest;
use Google\Cloud\TelcoAutomation\V1\PublicBlueprint;

/**
 * @param string $formattedName The name of the public blueprint. Please see
 *                              {@see TelcoAutomationClient::publicBlueprintName()} for help formatting this field.
 */
function get_public_blueprint_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PublicBlueprint $response */
        $response = $telcoAutomationClient->getPublicBlueprint($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 = TelcoAutomationClient::publicBlueprintName(
        '[PROJECT]',
        '[LOCATION]',
        '[PUBLIC_LUEPRINT]'
    );

    get_public_blueprint_sample($formattedName);
}

listBlueprintRevisions

List blueprint revisions of a given blueprint.

The async variant is TelcoAutomationClient::listBlueprintRevisionsAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListBlueprintRevisionsRequest

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\TelcoAutomation\V1\Blueprint;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\ListBlueprintRevisionsRequest;

/**
 * @param string $formattedName The name of the blueprint to list revisions for. Please see
 *                              {@see TelcoAutomationClient::blueprintName()} for help formatting this field.
 */
function list_blueprint_revisions_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

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

        /** @var Blueprint $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
{
    $formattedName = TelcoAutomationClient::blueprintName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[BLUEPRINT]'
    );

    list_blueprint_revisions_sample($formattedName);
}

listBlueprints

List all blueprints.

The async variant is TelcoAutomationClient::listBlueprintsAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListBlueprintsRequest

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\TelcoAutomation\V1\Blueprint;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\ListBlueprintsRequest;

/**
 * @param string $formattedParent The name of parent orchestration cluster resource.
 *                                Format should be -
 *                                "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". Please see
 *                                {@see TelcoAutomationClient::orchestrationClusterName()} for help formatting this field.
 */
function list_blueprints_sample(string $formattedParent): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

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

        /** @var Blueprint $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 = TelcoAutomationClient::orchestrationClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]'
    );

    list_blueprints_sample($formattedParent);
}

listDeploymentRevisions

List deployment revisions of a given deployment.

The async variant is TelcoAutomationClient::listDeploymentRevisionsAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListDeploymentRevisionsRequest

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\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\Deployment;
use Google\Cloud\TelcoAutomation\V1\ListDeploymentRevisionsRequest;

/**
 * @param string $formattedName The name of the deployment to list revisions for. Please see
 *                              {@see TelcoAutomationClient::deploymentName()} for help formatting this field.
 */
function list_deployment_revisions_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

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

        /** @var Deployment $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
{
    $formattedName = TelcoAutomationClient::deploymentName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[DEPLOYMENT]'
    );

    list_deployment_revisions_sample($formattedName);
}

listDeployments

List all deployments.

The async variant is TelcoAutomationClient::listDeploymentsAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListDeploymentsRequest

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\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\Deployment;
use Google\Cloud\TelcoAutomation\V1\ListDeploymentsRequest;

/**
 * @param string $formattedParent The name of parent orchestration cluster resource.
 *                                Format should be -
 *                                "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". Please see
 *                                {@see TelcoAutomationClient::orchestrationClusterName()} for help formatting this field.
 */
function list_deployments_sample(string $formattedParent): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

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

        /** @var Deployment $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 = TelcoAutomationClient::orchestrationClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]'
    );

    list_deployments_sample($formattedParent);
}

listEdgeSlms

Lists EdgeSlms in a given project and location.

The async variant is TelcoAutomationClient::listEdgeSlmsAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListEdgeSlmsRequest

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\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\EdgeSlm;
use Google\Cloud\TelcoAutomation\V1\ListEdgeSlmsRequest;

/**
 * @param string $formattedParent Parent value for ListEdgeSlmsRequest
 *                                Please see {@see TelcoAutomationClient::locationName()} for help formatting this field.
 */
function list_edge_slms_sample(string $formattedParent): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

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

        /** @var EdgeSlm $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 = TelcoAutomationClient::locationName('[PROJECT]', '[LOCATION]');

    list_edge_slms_sample($formattedParent);
}

listHydratedDeployments

List all hydrated deployments present under a deployment.

The async variant is TelcoAutomationClient::listHydratedDeploymentsAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListHydratedDeploymentsRequest

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\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\HydratedDeployment;
use Google\Cloud\TelcoAutomation\V1\ListHydratedDeploymentsRequest;

/**
 * @param string $formattedParent The deployment managing the hydrated deployments. Please see
 *                                {@see TelcoAutomationClient::deploymentName()} for help formatting this field.
 */
function list_hydrated_deployments_sample(string $formattedParent): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

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

        /** @var HydratedDeployment $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 = TelcoAutomationClient::deploymentName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[DEPLOYMENT]'
    );

    list_hydrated_deployments_sample($formattedParent);
}

listOrchestrationClusters

Lists OrchestrationClusters in a given project and location.

The async variant is TelcoAutomationClient::listOrchestrationClustersAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListOrchestrationClustersRequest

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\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\ListOrchestrationClustersRequest;
use Google\Cloud\TelcoAutomation\V1\OrchestrationCluster;

/**
 * @param string $formattedParent Parent value for ListOrchestrationClustersRequest
 *                                Please see {@see TelcoAutomationClient::locationName()} for help formatting this field.
 */
function list_orchestration_clusters_sample(string $formattedParent): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

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

        /** @var OrchestrationCluster $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 = TelcoAutomationClient::locationName('[PROJECT]', '[LOCATION]');

    list_orchestration_clusters_sample($formattedParent);
}

listPublicBlueprints

Lists the blueprints in TNA's public catalog. Default page size = 20, Max Page Size = 100.

The async variant is TelcoAutomationClient::listPublicBlueprintsAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListPublicBlueprintsRequest

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\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\ListPublicBlueprintsRequest;
use Google\Cloud\TelcoAutomation\V1\PublicBlueprint;

/**
 * @param string $formattedParent Parent value of public blueprint.
 *                                Format should be -
 *                                "projects/{project_id}/locations/{location_name}". Please see
 *                                {@see TelcoAutomationClient::locationName()} for help formatting this field.
 */
function list_public_blueprints_sample(string $formattedParent): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

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

        /** @var PublicBlueprint $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 = TelcoAutomationClient::locationName('[PROJECT]', '[LOCATION]');

    list_public_blueprints_sample($formattedParent);
}

proposeBlueprint

Proposes a blueprint for approval of changes.

The async variant is TelcoAutomationClient::proposeBlueprintAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ProposeBlueprintRequest

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\TelcoAutomation\V1\Blueprint
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Blueprint;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\ProposeBlueprintRequest;

/**
 * @param string $formattedName The name of the blueprint being proposed. Please see
 *                              {@see TelcoAutomationClient::blueprintName()} for help formatting this field.
 */
function propose_blueprint_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Blueprint $response */
        $response = $telcoAutomationClient->proposeBlueprint($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 = TelcoAutomationClient::blueprintName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[BLUEPRINT]'
    );

    propose_blueprint_sample($formattedName);
}

rejectBlueprint

Rejects a blueprint revision proposal and flips it back to Draft state.

The async variant is TelcoAutomationClient::rejectBlueprintAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\RejectBlueprintRequest

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\TelcoAutomation\V1\Blueprint
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Blueprint;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\RejectBlueprintRequest;

/**
 * @param string $formattedName The name of the blueprint being rejected. Please see
 *                              {@see TelcoAutomationClient::blueprintName()} for help formatting this field.
 */
function reject_blueprint_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Blueprint $response */
        $response = $telcoAutomationClient->rejectBlueprint($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 = TelcoAutomationClient::blueprintName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[BLUEPRINT]'
    );

    reject_blueprint_sample($formattedName);
}

removeDeployment

Removes the deployment by marking it as DELETING. Post which deployment and it's revisions gets deleted.

The async variant is TelcoAutomationClient::removeDeploymentAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\RemoveDeploymentRequest

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.
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\RemoveDeploymentRequest;

/**
 * @param string $formattedName The name of deployment to initiate delete. Please see
 *                              {@see TelcoAutomationClient::deploymentName()} for help formatting this field.
 */
function remove_deployment_sample(string $formattedName): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        $telcoAutomationClient->removeDeployment($request);
        printf('Call completed successfully.' . PHP_EOL);
    } 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 = TelcoAutomationClient::deploymentName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[DEPLOYMENT]'
    );

    remove_deployment_sample($formattedName);
}

rollbackDeployment

Rollback the active deployment to the given past approved deployment revision.

The async variant is TelcoAutomationClient::rollbackDeploymentAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\RollbackDeploymentRequest

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\TelcoAutomation\V1\Deployment
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\Deployment;
use Google\Cloud\TelcoAutomation\V1\RollbackDeploymentRequest;

/**
 * @param string $formattedName Name of the deployment. Please see
 *                              {@see TelcoAutomationClient::deploymentName()} for help formatting this field.
 * @param string $revisionId    The revision id of deployment to roll back to.
 */
function rollback_deployment_sample(string $formattedName, string $revisionId): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Deployment $response */
        $response = $telcoAutomationClient->rollbackDeployment($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 = TelcoAutomationClient::deploymentName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]',
        '[DEPLOYMENT]'
    );
    $revisionId = '[REVISION_ID]';

    rollback_deployment_sample($formattedName, $revisionId);
}

searchBlueprintRevisions

Searches across blueprint revisions.

The async variant is TelcoAutomationClient::searchBlueprintRevisionsAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\SearchBlueprintRevisionsRequest

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\TelcoAutomation\V1\Blueprint;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\SearchBlueprintRevisionsRequest;

/**
 * @param string $formattedParent The name of parent orchestration cluster resource.
 *                                Format should be -
 *                                "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". Please see
 *                                {@see TelcoAutomationClient::orchestrationClusterName()} for help formatting this field.
 * @param string $query           Supported queries:
 *                                1. ""                       : Lists all revisions across all blueprints.
 *                                2. "latest=true"            : Lists latest revisions across all blueprints.
 *                                3. "name={name}"            : Lists all revisions of blueprint with name
 *                                {name}.
 *                                4. "name={name} latest=true": Lists latest revision of blueprint with name
 *                                {name}
 */
function search_blueprint_revisions_sample(string $formattedParent, string $query): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

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

        /** @var Blueprint $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 = TelcoAutomationClient::orchestrationClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]'
    );
    $query = '[QUERY]';

    search_blueprint_revisions_sample($formattedParent, $query);
}

searchDeploymentRevisions

Searches across deployment revisions.

The async variant is TelcoAutomationClient::searchDeploymentRevisionsAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\SearchDeploymentRevisionsRequest

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\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\Deployment;
use Google\Cloud\TelcoAutomation\V1\SearchDeploymentRevisionsRequest;

/**
 * @param string $formattedParent The name of parent orchestration cluster resource.
 *                                Format should be -
 *                                "projects/{project_id}/locations/{location_name}/orchestrationClusters/{orchestration_cluster}". Please see
 *                                {@see TelcoAutomationClient::orchestrationClusterName()} for help formatting this field.
 * @param string $query           Supported queries:
 *                                1. ""                       : Lists all revisions across all deployments.
 *                                2. "latest=true"            : Lists latest revisions across all
 *                                deployments.
 *                                3. "name={name}"            : Lists all revisions of deployment with name
 *                                {name}.
 *                                4. "name={name} latest=true": Lists latest revision of deployment with name
 *                                {name}
 */
function search_deployment_revisions_sample(string $formattedParent, string $query): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

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

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

        /** @var Deployment $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 = TelcoAutomationClient::orchestrationClusterName(
        '[PROJECT]',
        '[LOCATION]',
        '[ORCHESTRATION_CLUSTER]'
    );
    $query = '[QUERY]';

    search_deployment_revisions_sample($formattedParent, $query);
}

updateBlueprint

Updates a blueprint.

The async variant is TelcoAutomationClient::updateBlueprintAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\UpdateBlueprintRequest

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\TelcoAutomation\V1\Blueprint
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Blueprint;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\UpdateBlueprintRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $blueprintSourceBlueprint Immutable. The public blueprint ID from which this blueprint was
 *                                         created.
 */
function update_blueprint_sample(string $blueprintSourceBlueprint): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

    // Prepare the request message.
    $blueprint = (new Blueprint())
        ->setSourceBlueprint($blueprintSourceBlueprint);
    $updateMask = new FieldMask();
    $request = (new UpdateBlueprintRequest())
        ->setBlueprint($blueprint)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Blueprint $response */
        $response = $telcoAutomationClient->updateBlueprint($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
{
    $blueprintSourceBlueprint = '[SOURCE_BLUEPRINT]';

    update_blueprint_sample($blueprintSourceBlueprint);
}

updateDeployment

Updates a deployment.

The async variant is TelcoAutomationClient::updateDeploymentAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\UpdateDeploymentRequest

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\TelcoAutomation\V1\Deployment
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\Deployment;
use Google\Cloud\TelcoAutomation\V1\UpdateDeploymentRequest;
use Google\Protobuf\FieldMask;

/**
 * @param string $deploymentSourceBlueprintRevision The blueprint revision from which this deployment was created.
 */
function update_deployment_sample(string $deploymentSourceBlueprintRevision): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

    // Prepare the request message.
    $deployment = (new Deployment())
        ->setSourceBlueprintRevision($deploymentSourceBlueprintRevision);
    $updateMask = new FieldMask();
    $request = (new UpdateDeploymentRequest())
        ->setDeployment($deployment)
        ->setUpdateMask($updateMask);

    // Call the API and handle any network failures.
    try {
        /** @var Deployment $response */
        $response = $telcoAutomationClient->updateDeployment($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
{
    $deploymentSourceBlueprintRevision = '[SOURCE_BLUEPRINT_REVISION]';

    update_deployment_sample($deploymentSourceBlueprintRevision);
}

updateHydratedDeployment

Updates a hydrated deployment.

The async variant is TelcoAutomationClient::updateHydratedDeploymentAsync() .

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\UpdateHydratedDeploymentRequest

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\TelcoAutomation\V1\HydratedDeployment
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\TelcoAutomation\V1\Client\TelcoAutomationClient;
use Google\Cloud\TelcoAutomation\V1\HydratedDeployment;
use Google\Cloud\TelcoAutomation\V1\UpdateHydratedDeploymentRequest;
use Google\Protobuf\FieldMask;

/**
 * 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_hydrated_deployment_sample(): void
{
    // Create a client.
    $telcoAutomationClient = new TelcoAutomationClient();

    // Prepare the request message.
    $hydratedDeployment = new HydratedDeployment();
    $updateMask = new FieldMask();
    $request = (new UpdateHydratedDeploymentRequest())
        ->setHydratedDeployment($hydratedDeployment)
        ->setUpdateMask($updateMask);

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

getLocation

Gets information about a location.

The async variant is TelcoAutomationClient::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\TelcoAutomation\V1\Client\TelcoAutomationClient;

/**
 * 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.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $telcoAutomationClient->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 TelcoAutomationClient::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\TelcoAutomation\V1\Client\TelcoAutomationClient;

/**
 * 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.
    $telcoAutomationClient = new TelcoAutomationClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $telcoAutomationClient->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());
    }
}

applyDeploymentAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ApplyDeploymentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\Deployment>

applyHydratedDeploymentAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ApplyHydratedDeploymentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\HydratedDeployment>

approveBlueprintAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ApproveBlueprintRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\Blueprint>

computeDeploymentStatusAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ComputeDeploymentStatusRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\ComputeDeploymentStatusResponse>

createBlueprintAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\CreateBlueprintRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\Blueprint>

createDeploymentAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\CreateDeploymentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\Deployment>

createEdgeSlmAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\CreateEdgeSlmRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

createOrchestrationClusterAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\CreateOrchestrationClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteBlueprintAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\DeleteBlueprintRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<void>

deleteEdgeSlmAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\DeleteEdgeSlmRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteOrchestrationClusterAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\DeleteOrchestrationClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

discardBlueprintChangesAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\DiscardBlueprintChangesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\DiscardBlueprintChangesResponse>

discardDeploymentChangesAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\DiscardDeploymentChangesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\DiscardDeploymentChangesResponse>

getBlueprintAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\GetBlueprintRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\Blueprint>

getDeploymentAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\GetDeploymentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\Deployment>

getEdgeSlmAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\GetEdgeSlmRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\EdgeSlm>

getHydratedDeploymentAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\GetHydratedDeploymentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\HydratedDeployment>

getOrchestrationClusterAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\GetOrchestrationClusterRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\OrchestrationCluster>

getPublicBlueprintAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\GetPublicBlueprintRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\PublicBlueprint>

listBlueprintRevisionsAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListBlueprintRevisionsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listBlueprintsAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListBlueprintsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listDeploymentRevisionsAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListDeploymentRevisionsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listDeploymentsAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListDeploymentsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listEdgeSlmsAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListEdgeSlmsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listHydratedDeploymentsAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListHydratedDeploymentsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listOrchestrationClustersAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListOrchestrationClustersRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listPublicBlueprintsAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ListPublicBlueprintsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

proposeBlueprintAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\ProposeBlueprintRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\Blueprint>

rejectBlueprintAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\RejectBlueprintRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\Blueprint>

removeDeploymentAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\RemoveDeploymentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<void>

rollbackDeploymentAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\RollbackDeploymentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\Deployment>

searchBlueprintRevisionsAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\SearchBlueprintRevisionsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

searchDeploymentRevisionsAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\SearchDeploymentRevisionsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

updateBlueprintAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\UpdateBlueprintRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\Blueprint>

updateDeploymentAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\UpdateDeploymentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\Deployment>

updateHydratedDeploymentAsync

Parameters
Name Description
request Google\Cloud\TelcoAutomation\V1\UpdateHydratedDeploymentRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\TelcoAutomation\V1\HydratedDeployment>

getLocationAsync

Parameters
Name Description
request Google\Cloud\Location\GetLocationRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location>

listLocationsAsync

Parameters
Name Description
request Google\Cloud\Location\ListLocationsRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

getOperationsClient

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

Returns
Type Description
Google\LongRunning\Client\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::blueprintName

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

Parameters
Name Description
project string
location string
orchestrationCluster string
blueprint string
Returns
Type Description
string The formatted blueprint resource.

static::deploymentName

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

Parameters
Name Description
project string
location string
orchestrationCluster string
deployment string
Returns
Type Description
string The formatted deployment resource.

static::edgeSlmName

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

Parameters
Name Description
project string
location string
edgeSlm string
Returns
Type Description
string The formatted edge_slm resource.

static::hydratedDeploymentName

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

Parameters
Name Description
project string
location string
orchestrationCluster string
deployment string
hydratedDeployment string
Returns
Type Description
string The formatted hydrated_deployment 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::orchestrationClusterName

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

Parameters
Name Description
project string
location string
orchestrationCluster string
Returns
Type Description
string The formatted orchestration_cluster resource.

static::publicBlueprintName

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

Parameters
Name Description
project string
location string
publicLueprint string
Returns
Type Description
string The formatted public_blueprint 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

  • blueprint: projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/blueprints/{blueprint}
  • deployment: projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/deployments/{deployment}
  • edgeSlm: projects/{project}/locations/{location}/edgeSlms/{edge_slm}
  • hydratedDeployment: projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}/deployments/{deployment}/hydratedDeployments/{hydrated_deployment}
  • location: projects/{project}/locations/{location}
  • orchestrationCluster: projects/{project}/locations/{location}/orchestrationClusters/{orchestration_cluster}
  • publicBlueprint: projects/{project}/locations/{location}/publicBlueprints/{public_lueprint}

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.