Google Cloud AlloyDB for PostgreSQL V1 Client - Class AlloyDBAdminClient (0.2.1)

Version 0.2.1

• 1.1.2 (latest)
• 1.1.1
• 1.0.0
• 0.10.3
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.3

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class AlloyDBAdminClient.

Service Description: Service describing handlers for resources

This class is currently experimental and may be subject to changes.

Namespace

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

batchCreateInstances

Creates new instances under the given project, location and cluster.

There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::batchCreateInstancesAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\BatchCreateInstancesRequest 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

createBackup

Creates a new Backup in a given project and location.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::createBackupAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\CreateBackupRequest 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

createCluster

Creates a new Cluster in a given project and location.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::createClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\CreateClusterRequest 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

createInstance

Creates a new Instance in a given project and location.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::createInstanceAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\CreateInstanceRequest 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

deleteBackup

Deletes a single Backup.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::deleteBackupAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\DeleteBackupRequest 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

deleteCluster

Deletes a single Cluster.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::deleteClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\DeleteClusterRequest 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

deleteInstance

Deletes a single Instance.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::deleteInstanceAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\DeleteInstanceRequest 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

failoverInstance

Forces a Failover for a highly available instance.

Failover promotes the HA standby instance as the new primary. Imperative only.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::failoverInstanceAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\FailoverInstanceRequest 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

getBackup

Gets details of a single Backup.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::getBackupAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\GetBackupRequest 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\AlloyDb\V1\Backup

getCluster

Gets details of a single Cluster.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::getClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\GetClusterRequest 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\AlloyDb\V1\Cluster

getInstance

Gets details of a single Instance.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::getInstanceAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\GetInstanceRequest 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\AlloyDb\V1\Instance

listBackups

Lists Backups in a given project and location.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::listBackupsAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\ListBackupsRequest 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

listClusters

Lists Clusters in a given project and location.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::listClustersAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\ListClustersRequest 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

listInstances

Lists Instances in a given project and location.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::listInstancesAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\ListInstancesRequest 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

listSupportedDatabaseFlags

Lists SupportedDatabaseFlags for a given project and location.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::listSupportedDatabaseFlagsAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\ListSupportedDatabaseFlagsRequest 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

restartInstance

Restart an Instance in a cluster.

Imperative only.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::restartInstanceAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\RestartInstanceRequest 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

restoreCluster

Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::restoreClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\RestoreClusterRequest 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

updateBackup

Updates the parameters of a single Backup.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::updateBackupAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\UpdateBackupRequest 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

updateCluster

Updates the parameters of a single Cluster.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::updateClusterAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\UpdateClusterRequest 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

updateInstance

Updates the parameters of a single Instance.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::updateInstanceAsync() .

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\UpdateInstanceRequest 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

getLocation

Gets information about a location.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::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

listLocations

Lists information about the supported locations for this service.

The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::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

batchCreateInstancesAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\BatchCreateInstancesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createBackupAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\CreateBackupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createClusterAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\CreateClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

createInstanceAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\CreateInstanceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteBackupAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\DeleteBackupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteClusterAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\DeleteClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

deleteInstanceAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\DeleteInstanceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

failoverInstanceAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\FailoverInstanceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getBackupAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\GetBackupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getClusterAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\GetClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getInstanceAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\GetInstanceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listBackupsAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\ListBackupsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listClustersAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\ListClustersRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listInstancesAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\ListInstancesRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listSupportedDatabaseFlagsAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\ListSupportedDatabaseFlagsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

restartInstanceAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\RestartInstanceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

restoreClusterAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\RestoreClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateBackupAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\UpdateBackupRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateClusterAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\UpdateClusterRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

updateInstanceAsync

Parameters
Name	Description
request	Google\Cloud\AlloyDb\V1\UpdateInstanceRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getLocationAsync

Parameters
Name	Description
request	Google\Cloud\Location\GetLocationRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

listLocationsAsync

Parameters
Name	Description
request	Google\Cloud\Location\ListLocationsRequest
optionalArgs = []	array

Returns
Type	Description
GuzzleHttp\Promise\PromiseInterface

getOperationsClient

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

Returns
Type	Description
Google\ApiCore\LongRunning\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::backupName

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

Parameters
Name	Description
project	string
location	string
backup	string

Returns
Type	Description
string	The formatted backup resource.

static::clusterName

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

Parameters
Name	Description
project	string
location	string
cluster	string

Returns
Type	Description
string	The formatted cluster resource.

static::cryptoKeyVersionName

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

Parameters
Name	Description
project	string
location	string
keyRing	string
cryptoKey	string
cryptoKeyVersion	string

Returns
Type	Description
string	The formatted crypto_key_version resource.

static::instanceName

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

Parameters
Name	Description
project	string
location	string
cluster	string
instance	string

Returns
Type	Description
string	The formatted instance 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::networkName

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

Parameters
Name	Description
project	string
network	string

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

• backup: projects/{project}/locations/{location}/backups/{backup}
• cluster: projects/{project}/locations/{location}/clusters/{cluster}
• cryptoKeyVersion: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}
• instance: projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}
• location: projects/{project}/locations/{location}
• network: projects/{project}/global/networks/{network}

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.