Google Cloud Appengine Admin V1 Client - Class DomainMappingsClient (2.0.0)

Reference documentation and code samples for the Google Cloud Appengine Admin V1 Client class DomainMappingsClient.

Service Description: Manages domains serving an application.

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

Namespace

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

createDomainMapping

Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.

The async variant is Google\Cloud\AppEngine\V1\Client\DomainMappingsClient::createDomainMappingAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\CreateDomainMappingRequest` 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\AppEngine\V1\Client\DomainMappingsClient;
use Google\Cloud\AppEngine\V1\CreateDomainMappingRequest;
use Google\Cloud\AppEngine\V1\DomainMapping;
use Google\Rpc\Status;

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

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

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

        if ($response->operationSucceeded()) {
            /** @var DomainMapping $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());
    }
}

deleteDomainMapping

Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.

The async variant is Google\Cloud\AppEngine\V1\Client\DomainMappingsClient::deleteDomainMappingAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\DeleteDomainMappingRequest` 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\AppEngine\V1\Client\DomainMappingsClient;
use Google\Cloud\AppEngine\V1\DeleteDomainMappingRequest;
use Google\Rpc\Status;

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

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

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

getDomainMapping

Gets the specified domain mapping.

The async variant is Google\Cloud\AppEngine\V1\Client\DomainMappingsClient::getDomainMappingAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\GetDomainMappingRequest` 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\AppEngine\V1\DomainMapping`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\Client\DomainMappingsClient;
use Google\Cloud\AppEngine\V1\DomainMapping;
use Google\Cloud\AppEngine\V1\GetDomainMappingRequest;

/**
 * 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_domain_mapping_sample(): void
{
    // Create a client.
    $domainMappingsClient = new DomainMappingsClient();

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

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

listDomainMappings

Lists the domain mappings on an application.

The async variant is Google\Cloud\AppEngine\V1\Client\DomainMappingsClient::listDomainMappingsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\ListDomainMappingsRequest` 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\AppEngine\V1\Client\DomainMappingsClient;
use Google\Cloud\AppEngine\V1\DomainMapping;
use Google\Cloud\AppEngine\V1\ListDomainMappingsRequest;

/**
 * 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_domain_mappings_sample(): void
{
    // Create a client.
    $domainMappingsClient = new DomainMappingsClient();

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

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

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

updateDomainMapping

Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.

The async variant is Google\Cloud\AppEngine\V1\Client\DomainMappingsClient::updateDomainMappingAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\UpdateDomainMappingRequest` 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\AppEngine\V1\Client\DomainMappingsClient;
use Google\Cloud\AppEngine\V1\DomainMapping;
use Google\Cloud\AppEngine\V1\UpdateDomainMappingRequest;
use Google\Rpc\Status;

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

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

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

        if ($response->operationSucceeded()) {
            /** @var DomainMapping $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());
    }
}

createDomainMappingAsync

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\CreateDomainMappingRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteDomainMappingAsync

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\DeleteDomainMappingRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getDomainMappingAsync

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\GetDomainMappingRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listDomainMappingsAsync

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\ListDomainMappingsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateDomainMappingAsync

Parameters
Name	Description
`request`	`Google\Cloud\AppEngine\V1\UpdateDomainMappingRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

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`