Google Cloud Appengine Admin V1 Client - Class AuthorizedCertificatesClient (1.0.6)

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

Service Description: Manages SSL certificates a user is authorized to administer. A user can administer any SSL certificates applicable to their authorized domains.

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

$authorizedCertificatesClient = new AuthorizedCertificatesClient();
try {
    $response = $authorizedCertificatesClient->createAuthorizedCertificate();
} finally {
    $authorizedCertificatesClient->close();
}

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.

createAuthorizedCertificate

Uploads the specified SSL certificate.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ parent`	`string` Name of the parent `Application` resource. Example: `apps/myapp`.
`↳ certificate`	`AuthorizedCertificate` SSL certificate data.
`↳ 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\AuthorizedCertificate`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\AuthorizedCertificate;
use Google\Cloud\AppEngine\V1\AuthorizedCertificatesClient;

/**
 * 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_authorized_certificate_sample(): void
{
    // Create a client.
    $authorizedCertificatesClient = new AuthorizedCertificatesClient();

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

deleteAuthorizedCertificate

Deletes the specified SSL certificate.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` Name of the resource to delete. Example: `apps/myapp/authorizedCertificates/12345`.
`↳ 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\AppEngine\V1\AuthorizedCertificatesClient;

/**
 * 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_authorized_certificate_sample(): void
{
    // Create a client.
    $authorizedCertificatesClient = new AuthorizedCertificatesClient();

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

getAuthorizedCertificate

Gets the specified SSL certificate.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` Name of the resource requested. Example: `apps/myapp/authorizedCertificates/12345`.
`↳ view`	`int` Controls the set of fields returned in the `GET` response. For allowed values, use constants defined on Google\Cloud\AppEngine\V1\AuthorizedCertificateView
`↳ 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\AuthorizedCertificate`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\AuthorizedCertificate;
use Google\Cloud\AppEngine\V1\AuthorizedCertificatesClient;

/**
 * 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_authorized_certificate_sample(): void
{
    // Create a client.
    $authorizedCertificatesClient = new AuthorizedCertificatesClient();

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

listAuthorizedCertificates

Lists all SSL certificates the user is authorized to administer.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ parent`	`string` Name of the parent `Application` resource. Example: `apps/myapp`.
`↳ view`	`int` Controls the set of fields returned in the `LIST` response. For allowed values, use constants defined on Google\Cloud\AppEngine\V1\AuthorizedCertificateView
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AppEngine\V1\AuthorizedCertificate;
use Google\Cloud\AppEngine\V1\AuthorizedCertificatesClient;

/**
 * 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_authorized_certificates_sample(): void
{
    // Create a client.
    $authorizedCertificatesClient = new AuthorizedCertificatesClient();

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

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

updateAuthorizedCertificate

Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ name`	`string` Name of the resource to update. Example: `apps/myapp/authorizedCertificates/12345`.
`↳ certificate`	`AuthorizedCertificate` An `AuthorizedCertificate` containing the updated resource. Only fields set in the field mask will be updated.
`↳ updateMask`	`FieldMask` Standard field mask for the set of fields to be updated. Updates are only supported on the `certificate_raw_data` and `display_name` fields.
`↳ 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\AuthorizedCertificate`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\AuthorizedCertificate;
use Google\Cloud\AppEngine\V1\AuthorizedCertificatesClient;

/**
 * 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_authorized_certificate_sample(): void
{
    // Create a client.
    $authorizedCertificatesClient = new AuthorizedCertificatesClient();

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

Constants

SERVICE_NAME

Value: 'google.appengine.v1.AuthorizedCertificates'

The name of the service.

SERVICE_ADDRESS

Value: 'appengine.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

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