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.
Namespace
Google \ Cloud \ AppEngine \ V1 \ ClientMethods
__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 |
↳ 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 |
↳ 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.
The async variant is Google\Cloud\AppEngine\V1\Client\AuthorizedCertificatesClient::createAuthorizedCertificateAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AppEngine\V1\CreateAuthorizedCertificateRequest
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\AuthorizedCertificate |
use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\AuthorizedCertificate;
use Google\Cloud\AppEngine\V1\Client\AuthorizedCertificatesClient;
use Google\Cloud\AppEngine\V1\CreateAuthorizedCertificateRequest;
/**
* 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();
// Prepare the request message.
$request = new CreateAuthorizedCertificateRequest();
// Call the API and handle any network failures.
try {
/** @var AuthorizedCertificate $response */
$response = $authorizedCertificatesClient->createAuthorizedCertificate($request);
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.
The async variant is Google\Cloud\AppEngine\V1\Client\AuthorizedCertificatesClient::deleteAuthorizedCertificateAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AppEngine\V1\DeleteAuthorizedCertificateRequest
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. |
use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\Client\AuthorizedCertificatesClient;
use Google\Cloud\AppEngine\V1\DeleteAuthorizedCertificateRequest;
/**
* 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();
// Prepare the request message.
$request = new DeleteAuthorizedCertificateRequest();
// Call the API and handle any network failures.
try {
$authorizedCertificatesClient->deleteAuthorizedCertificate($request);
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.
The async variant is Google\Cloud\AppEngine\V1\Client\AuthorizedCertificatesClient::getAuthorizedCertificateAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AppEngine\V1\GetAuthorizedCertificateRequest
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\AuthorizedCertificate |
use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\AuthorizedCertificate;
use Google\Cloud\AppEngine\V1\Client\AuthorizedCertificatesClient;
use Google\Cloud\AppEngine\V1\GetAuthorizedCertificateRequest;
/**
* 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();
// Prepare the request message.
$request = new GetAuthorizedCertificateRequest();
// Call the API and handle any network failures.
try {
/** @var AuthorizedCertificate $response */
$response = $authorizedCertificatesClient->getAuthorizedCertificate($request);
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.
The async variant is Google\Cloud\AppEngine\V1\Client\AuthorizedCertificatesClient::listAuthorizedCertificatesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AppEngine\V1\ListAuthorizedCertificatesRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\AppEngine\V1\AuthorizedCertificate;
use Google\Cloud\AppEngine\V1\Client\AuthorizedCertificatesClient;
use Google\Cloud\AppEngine\V1\ListAuthorizedCertificatesRequest;
/**
* 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();
// Prepare the request message.
$request = new ListAuthorizedCertificatesRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $authorizedCertificatesClient->listAuthorizedCertificates($request);
/** @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.
The async variant is Google\Cloud\AppEngine\V1\Client\AuthorizedCertificatesClient::updateAuthorizedCertificateAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AppEngine\V1\UpdateAuthorizedCertificateRequest
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\AuthorizedCertificate |
use Google\ApiCore\ApiException;
use Google\Cloud\AppEngine\V1\AuthorizedCertificate;
use Google\Cloud\AppEngine\V1\Client\AuthorizedCertificatesClient;
use Google\Cloud\AppEngine\V1\UpdateAuthorizedCertificateRequest;
/**
* 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();
// Prepare the request message.
$request = new UpdateAuthorizedCertificateRequest();
// Call the API and handle any network failures.
try {
/** @var AuthorizedCertificate $response */
$response = $authorizedCertificatesClient->updateAuthorizedCertificate($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
createAuthorizedCertificateAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AppEngine\V1\CreateAuthorizedCertificateRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteAuthorizedCertificateAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AppEngine\V1\DeleteAuthorizedCertificateRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getAuthorizedCertificateAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AppEngine\V1\GetAuthorizedCertificateRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listAuthorizedCertificatesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AppEngine\V1\ListAuthorizedCertificatesRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateAuthorizedCertificateAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\AppEngine\V1\UpdateAuthorizedCertificateRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |