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 \ ClientMethods
__construct
Constructor.
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() .
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.
createBackup
Creates a new Backup in a given project and location.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::createBackupAsync() .
request
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.
createCluster
Creates a new Cluster in a given project and location.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::createClusterAsync() .
request
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.
createInstance
Creates a new Instance in a given project and location.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::createInstanceAsync() .
request
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.
deleteBackup
Deletes a single Backup.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::deleteBackupAsync() .
request
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.
deleteCluster
Deletes a single Cluster.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::deleteClusterAsync() .
request
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.
deleteInstance
Deletes a single Instance.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::deleteInstanceAsync() .
request
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.
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() .
request
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.
getBackup
Gets details of a single Backup.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::getBackupAsync() .
request
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.
getCluster
Gets details of a single Cluster.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::getClusterAsync() .
request
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.
getInstance
Gets details of a single Instance.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::getInstanceAsync() .
request
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.
listBackups
Lists Backups in a given project and location.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::listBackupsAsync() .
request
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.
listClusters
Lists Clusters in a given project and location.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::listClustersAsync() .
request
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.
listInstances
Lists Instances in a given project and location.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::listInstancesAsync() .
request
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.
listSupportedDatabaseFlags
Lists SupportedDatabaseFlags for a given project and location.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::listSupportedDatabaseFlagsAsync() .
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.
restartInstance
Restart an Instance in a cluster.
Imperative only.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::restartInstanceAsync() .
request
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.
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() .
request
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.
updateBackup
Updates the parameters of a single Backup.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::updateBackupAsync() .
request
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.
updateCluster
Updates the parameters of a single Cluster.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::updateClusterAsync() .
request
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.
updateInstance
Updates the parameters of a single Instance.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::updateInstanceAsync() .
request
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.
getLocation
Gets information about a location.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::getLocationAsync() .
request
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.
listLocations
Lists information about the supported locations for this service.
The async variant is Google\Cloud\AlloyDb\V1\Client\BaseClient\self::listLocationsAsync() .
request
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.
batchCreateInstancesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createBackupAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createClusterAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createInstanceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteBackupAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteClusterAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteInstanceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
failoverInstanceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getBackupAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getClusterAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getInstanceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listBackupsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listClustersAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listInstancesAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listSupportedDatabaseFlagsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
restartInstanceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
restoreClusterAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateBackupAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateClusterAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
updateInstanceAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getLocationAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listLocationsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
static::backupName
Formats a string containing the fully-qualified path to represent a backup resource.
project
string
location
string
backup
string
string
static::clusterName
Formats a string containing the fully-qualified path to represent a cluster resource.
project
string
location
string
cluster
string
string
static::cryptoKeyVersionName
Formats a string containing the fully-qualified path to represent a crypto_key_version resource.
project
string
location
string
keyRing
string
cryptoKey
string
cryptoKeyVersion
string
string
static::instanceName
Formats a string containing the fully-qualified path to represent a instance resource.
project
string
location
string
cluster
string
instance
string
string
static::locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
static::networkName
Formats a string containing the fully-qualified path to represent a network resource.
project
string
network
string
string
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
