Google Workspace Add-ons V1 Client - Class GSuiteAddOnsClient (1.0.1)

Reference documentation and code samples for the Google Workspace Add-ons V1 Client class GSuiteAddOnsClient.

Service Description: A service for managing Google Workspace Add-ons deployments.

A Google Workspace Add-on is a third-party embedded component that can be installed in Google Workspace Applications like Gmail, Calendar, Drive, and the Google Docs, Sheets, and Slides editors. Google Workspace Add-ons can display UI cards, receive contextual information from the host application, and perform actions in the host application (See: https://developers.google.com/gsuite/add-ons/overview for more information).

A Google Workspace Add-on deployment resource specifies metadata about the add-on, including a specification of the entry points in the host application that trigger add-on executions (see: https://developers.google.com/gsuite/add-ons/concepts/gsuite-manifests). Add-on deployments defined via the Google Workspace Add-ons API define their entrypoints using HTTPS URLs (See: https://developers.google.com/gsuite/add-ons/guides/alternate-runtimes),

A Google Workspace Add-on deployment can be installed in developer mode, which allows an add-on developer to test the experience an end-user would see when installing and running the add-on in their G Suite applications. When running in developer mode, more detailed error messages are exposed in the add-on UI to aid in debugging.

A Google Workspace Add-on deployment can be published to Google Workspace Marketplace, which allows other Google Workspace users to discover and install the add-on. See: https://developers.google.com/gsuite/add-ons/how-tos/publish-add-on-overview for details.

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 \ GSuiteAddOns \ 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.

createDeployment

Creates a deployment with the specified name and configuration.

The async variant is GSuiteAddOnsClient::createDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\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\GSuiteAddOns\V1\Deployment`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\GSuiteAddOns\V1\Client\GSuiteAddOnsClient;
use Google\Cloud\GSuiteAddOns\V1\CreateDeploymentRequest;
use Google\Cloud\GSuiteAddOns\V1\Deployment;

/**
 * @param string $formattedParent Name of the project in which to create the deployment.
 *
 *                                Example: `projects/my_project`. Please see
 *                                {@see GSuiteAddOnsClient::projectName()} for help formatting this field.
 * @param string $deploymentId    The id to use for this deployment.  The full name of the created
 *                                resource will be `projects/<project_number>/deployments/<deployment_id>`.
 */
function create_deployment_sample(string $formattedParent, string $deploymentId): void
{
    // Create a client.
    $gSuiteAddOnsClient = new GSuiteAddOnsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Deployment $response */
        $response = $gSuiteAddOnsClient->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 = GSuiteAddOnsClient::projectName('[PROJECT]');
    $deploymentId = '[DEPLOYMENT_ID]';

    create_deployment_sample($formattedParent, $deploymentId);
}

deleteDeployment

Deletes the deployment with the given name.

The async variant is GSuiteAddOnsClient::deleteDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\DeleteDeploymentRequest` 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\GSuiteAddOns\V1\Client\GSuiteAddOnsClient;
use Google\Cloud\GSuiteAddOns\V1\DeleteDeploymentRequest;

/**
 * @param string $formattedName The full resource name of the deployment to delete.
 *
 *                              Example:  `projects/my_project/deployments/my_deployment`. Please see
 *                              {@see GSuiteAddOnsClient::deploymentName()} for help formatting this field.
 */
function delete_deployment_sample(string $formattedName): void
{
    // Create a client.
    $gSuiteAddOnsClient = new GSuiteAddOnsClient();

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

    // Call the API and handle any network failures.
    try {
        $gSuiteAddOnsClient->deleteDeployment($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 = GSuiteAddOnsClient::deploymentName('[PROJECT]', '[DEPLOYMENT]');

    delete_deployment_sample($formattedName);
}

getAuthorization

Gets the authorization information for deployments in a given project.

The async variant is GSuiteAddOnsClient::getAuthorizationAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\GetAuthorizationRequest` 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\GSuiteAddOns\V1\Authorization`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\GSuiteAddOns\V1\Authorization;
use Google\Cloud\GSuiteAddOns\V1\Client\GSuiteAddOnsClient;
use Google\Cloud\GSuiteAddOns\V1\GetAuthorizationRequest;

/**
 * @param string $formattedName Name of the project for which to get the Google Workspace Add-ons
 *                              authorization information.
 *
 *                              Example: `projects/my_project/authorization`. Please see
 *                              {@see GSuiteAddOnsClient::authorizationName()} for help formatting this field.
 */
function get_authorization_sample(string $formattedName): void
{
    // Create a client.
    $gSuiteAddOnsClient = new GSuiteAddOnsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Authorization $response */
        $response = $gSuiteAddOnsClient->getAuthorization($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 = GSuiteAddOnsClient::authorizationName('[PROJECT]');

    get_authorization_sample($formattedName);
}

getDeployment

Gets the deployment with the specified name.

The async variant is GSuiteAddOnsClient::getDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\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\GSuiteAddOns\V1\Deployment`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\GSuiteAddOns\V1\Client\GSuiteAddOnsClient;
use Google\Cloud\GSuiteAddOns\V1\Deployment;
use Google\Cloud\GSuiteAddOns\V1\GetDeploymentRequest;

/**
 * @param string $formattedName The full resource name of the deployment to get.
 *
 *                              Example:  `projects/my_project/deployments/my_deployment`. Please see
 *                              {@see GSuiteAddOnsClient::deploymentName()} for help formatting this field.
 */
function get_deployment_sample(string $formattedName): void
{
    // Create a client.
    $gSuiteAddOnsClient = new GSuiteAddOnsClient();

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

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

    get_deployment_sample($formattedName);
}

getInstallStatus

Fetches the install status of a developer mode deployment.

The async variant is GSuiteAddOnsClient::getInstallStatusAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\GetInstallStatusRequest` 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\GSuiteAddOns\V1\InstallStatus`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\GSuiteAddOns\V1\Client\GSuiteAddOnsClient;
use Google\Cloud\GSuiteAddOns\V1\GetInstallStatusRequest;
use Google\Cloud\GSuiteAddOns\V1\InstallStatus;

/**
 * @param string $formattedName The full resource name of the deployment.
 *
 *                              Example:  `projects/my_project/deployments/my_deployment/installStatus`. Please see
 *                              {@see GSuiteAddOnsClient::installStatusName()} for help formatting this field.
 */
function get_install_status_sample(string $formattedName): void
{
    // Create a client.
    $gSuiteAddOnsClient = new GSuiteAddOnsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var InstallStatus $response */
        $response = $gSuiteAddOnsClient->getInstallStatus($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 = GSuiteAddOnsClient::installStatusName('[PROJECT]', '[DEPLOYMENT]');

    get_install_status_sample($formattedName);
}

installDeployment

Installs a deployment in developer mode.

See: https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.

The async variant is GSuiteAddOnsClient::installDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\InstallDeploymentRequest` 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\GSuiteAddOns\V1\Client\GSuiteAddOnsClient;
use Google\Cloud\GSuiteAddOns\V1\InstallDeploymentRequest;

/**
 * @param string $formattedName The full resource name of the deployment to install.
 *
 *                              Example:  `projects/my_project/deployments/my_deployment`. Please see
 *                              {@see GSuiteAddOnsClient::deploymentName()} for help formatting this field.
 */
function install_deployment_sample(string $formattedName): void
{
    // Create a client.
    $gSuiteAddOnsClient = new GSuiteAddOnsClient();

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

    // Call the API and handle any network failures.
    try {
        $gSuiteAddOnsClient->installDeployment($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 = GSuiteAddOnsClient::deploymentName('[PROJECT]', '[DEPLOYMENT]');

    install_deployment_sample($formattedName);
}

listDeployments

Lists all deployments in a particular project.

The async variant is GSuiteAddOnsClient::listDeploymentsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\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\GSuiteAddOns\V1\Client\GSuiteAddOnsClient;
use Google\Cloud\GSuiteAddOns\V1\Deployment;
use Google\Cloud\GSuiteAddOns\V1\ListDeploymentsRequest;

/**
 * @param string $formattedParent Name of the project in which to create the deployment.
 *
 *                                Example: `projects/my_project`. Please see
 *                                {@see GSuiteAddOnsClient::projectName()} for help formatting this field.
 */
function list_deployments_sample(string $formattedParent): void
{
    // Create a client.
    $gSuiteAddOnsClient = new GSuiteAddOnsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $gSuiteAddOnsClient->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 = GSuiteAddOnsClient::projectName('[PROJECT]');

    list_deployments_sample($formattedParent);
}

replaceDeployment

Creates or replaces a deployment with the specified name.

The async variant is GSuiteAddOnsClient::replaceDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\ReplaceDeploymentRequest` 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\GSuiteAddOns\V1\Deployment`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\GSuiteAddOns\V1\Client\GSuiteAddOnsClient;
use Google\Cloud\GSuiteAddOns\V1\Deployment;
use Google\Cloud\GSuiteAddOns\V1\ReplaceDeploymentRequest;

/**
 * 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 replace_deployment_sample(): void
{
    // Create a client.
    $gSuiteAddOnsClient = new GSuiteAddOnsClient();

    // Prepare the request message.
    $deployment = new Deployment();
    $request = (new ReplaceDeploymentRequest())
        ->setDeployment($deployment);

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

uninstallDeployment

Uninstalls a developer mode deployment.

See: https://developers.google.com/gsuite/add-ons/how-tos/testing-gsuite-addons.

The async variant is GSuiteAddOnsClient::uninstallDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\UninstallDeploymentRequest` 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\GSuiteAddOns\V1\Client\GSuiteAddOnsClient;
use Google\Cloud\GSuiteAddOns\V1\UninstallDeploymentRequest;

/**
 * @param string $formattedName The full resource name of the deployment to install.
 *
 *                              Example:  `projects/my_project/deployments/my_deployment`. Please see
 *                              {@see GSuiteAddOnsClient::deploymentName()} for help formatting this field.
 */
function uninstall_deployment_sample(string $formattedName): void
{
    // Create a client.
    $gSuiteAddOnsClient = new GSuiteAddOnsClient();

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

    // Call the API and handle any network failures.
    try {
        $gSuiteAddOnsClient->uninstallDeployment($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 = GSuiteAddOnsClient::deploymentName('[PROJECT]', '[DEPLOYMENT]');

    uninstall_deployment_sample($formattedName);
}

createDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\CreateDeploymentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\GSuiteAddOns\V1\Deployment>`

deleteDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\DeleteDeploymentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<void>`

getAuthorizationAsync

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\GetAuthorizationRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\GSuiteAddOns\V1\Authorization>`

getDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\GetDeploymentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\GSuiteAddOns\V1\Deployment>`

getInstallStatusAsync

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\GetInstallStatusRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\GSuiteAddOns\V1\InstallStatus>`

installDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\InstallDeploymentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<void>`

listDeploymentsAsync

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\ListDeploymentsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

replaceDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\ReplaceDeploymentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\GSuiteAddOns\V1\Deployment>`

uninstallDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\GSuiteAddOns\V1\UninstallDeploymentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<void>`

static::authorizationName

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

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted authorization resource.

static::deploymentName

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

Parameters
Name	Description
`project`	`string`
`deployment`	`string`

Returns
Type	Description
`string`	The formatted deployment resource.

static::installStatusName

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

Parameters
Name	Description
`project`	`string`
`deployment`	`string`

Returns
Type	Description
`string`	The formatted install_status resource.

static::projectName

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

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project 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

authorization: projects/{project}/authorization
deployment: projects/{project}/deployments/{deployment}
installStatus: projects/{project}/deployments/{deployment}/installStatus
project: projects/{project}

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.