Reference documentation and code samples for the Google Cloud Memorystore V1 Client class MemorystoreClient.
Service Description: Service describing handlers for resources
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ Memorystore \ 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. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials |
↳ 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. At the moment, supports only |
↳ 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 = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method 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. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
backupInstance
Backup Instance.
If this is the first time a backup is being created, a backup collection will be created at the backend, and this backup belongs to this collection. Both collection and backup will have a resource name. Backup will be executed for each shard. A replica (primary if nonHA) will be selected to perform the execution. Backup call will be rejected if there is an ongoing backup or update operation. Be aware that during preview, if the instance's internal software version is too old, critical update will be performed before actual backup. Once the internal software version is updated to the minimum version required by the backup feature, subsequent backups will not require critical update. After preview, there will be no critical update needed for backup.
The async variant is MemorystoreClient::backupInstanceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\BackupInstanceRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memorystore\V1\BackupInstanceRequest;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\Instance;
use Google\Rpc\Status;
/**
* @param string $formattedName Instance resource name using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a Google Cloud region. Please see
* {@see MemorystoreClient::instanceName()} for help formatting this field.
*/
function backup_instance_sample(string $formattedName): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = (new BackupInstanceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $memorystoreClient->backupInstance($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Instance $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());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedName = MemorystoreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
backup_instance_sample($formattedName);
}
createInstance
Creates a new Instance in a given project and location.
The async variant is MemorystoreClient::createInstanceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\CreateInstanceRequest;
use Google\Cloud\Memorystore\V1\Instance;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent resource where this instance will be created.
* Format: projects/{project}/locations/{location}
* Please see {@see MemorystoreClient::locationName()} for help formatting this field.
* @param string $instanceId The ID to use for the instance, which will become the final
* component of the instance's resource name.
*
* This value is subject to the following restrictions:
*
* * Must be 4-63 characters in length
* * Must begin with a letter or digit
* * Must contain only lowercase letters, digits, and hyphens
* * Must not end with a hyphen
* * Must be unique within a location
*/
function create_instance_sample(string $formattedParent, string $instanceId): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$instance = new Instance();
$request = (new CreateInstanceRequest())
->setParent($formattedParent)
->setInstanceId($instanceId)
->setInstance($instance);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $memorystoreClient->createInstance($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Instance $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());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedParent = MemorystoreClient::locationName('[PROJECT]', '[LOCATION]');
$instanceId = '[INSTANCE_ID]';
create_instance_sample($formattedParent, $instanceId);
}
deleteBackup
Deletes a specific backup.
The async variant is MemorystoreClient::deleteBackupAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\DeleteBackupRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName Instance backup resource name using the form:
* `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
* Please see {@see MemorystoreClient::backupName()} for help formatting this field.
*/
function delete_backup_sample(string $formattedName): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = (new DeleteBackupRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $memorystoreClient->deleteBackup($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());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedName = MemorystoreClient::backupName(
'[PROJECT]',
'[LOCATION]',
'[BACKUP_COLLECTION]',
'[BACKUP]'
);
delete_backup_sample($formattedName);
}
deleteInstance
Deletes a single Instance.
The async variant is MemorystoreClient::deleteInstanceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\DeleteInstanceRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the instance to delete.
* Format: projects/{project}/locations/{location}/instances/{instance}
* Please see {@see MemorystoreClient::instanceName()} for help formatting this field.
*/
function delete_instance_sample(string $formattedName): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = (new DeleteInstanceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $memorystoreClient->deleteInstance($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());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedName = MemorystoreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
delete_instance_sample($formattedName);
}
exportBackup
Exports a specific backup to a customer target Cloud Storage URI.
The async variant is MemorystoreClient::exportBackupAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\ExportBackupRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memorystore\V1\Backup;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\ExportBackupRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName Instance backup resource name using the form:
* `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
* Please see {@see MemorystoreClient::backupName()} for help formatting this field.
*/
function export_backup_sample(string $formattedName): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = (new ExportBackupRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $memorystoreClient->exportBackup($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Backup $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());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedName = MemorystoreClient::backupName(
'[PROJECT]',
'[LOCATION]',
'[BACKUP_COLLECTION]',
'[BACKUP]'
);
export_backup_sample($formattedName);
}
getBackup
Gets the details of a specific backup.
The async variant is MemorystoreClient::getBackupAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\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\Memorystore\V1\Backup |
use Google\ApiCore\ApiException;
use Google\Cloud\Memorystore\V1\Backup;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\GetBackupRequest;
/**
* @param string $formattedName Instance backup resource name using the form:
* `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}/backups/{backup_id}`
* Please see {@see MemorystoreClient::backupName()} for help formatting this field.
*/
function get_backup_sample(string $formattedName): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = (new GetBackupRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Backup $response */
$response = $memorystoreClient->getBackup($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedName = MemorystoreClient::backupName(
'[PROJECT]',
'[LOCATION]',
'[BACKUP_COLLECTION]',
'[BACKUP]'
);
get_backup_sample($formattedName);
}
getBackupCollection
Get a backup collection.
The async variant is MemorystoreClient::getBackupCollectionAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\GetBackupCollectionRequest
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\Memorystore\V1\BackupCollection |
use Google\ApiCore\ApiException;
use Google\Cloud\Memorystore\V1\BackupCollection;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\GetBackupCollectionRequest;
/**
* @param string $formattedName Instance backupCollection resource name using the form:
* `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}`
* where `location_id` refers to a Google Cloud region. Please see
* {@see MemorystoreClient::backupCollectionName()} for help formatting this field.
*/
function get_backup_collection_sample(string $formattedName): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = (new GetBackupCollectionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var BackupCollection $response */
$response = $memorystoreClient->getBackupCollection($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedName = MemorystoreClient::backupCollectionName(
'[PROJECT]',
'[LOCATION]',
'[BACKUP_COLLECTION]'
);
get_backup_collection_sample($formattedName);
}
getCertificateAuthority
Gets details about the certificate authority for an Instance.
The async variant is MemorystoreClient::getCertificateAuthorityAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\GetCertificateAuthorityRequest
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\Memorystore\V1\CertificateAuthority |
use Google\ApiCore\ApiException;
use Google\Cloud\Memorystore\V1\CertificateAuthority;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\GetCertificateAuthorityRequest;
/**
* @param string $formattedName The name of the certificate authority.
* Format:
* projects/{project}/locations/{location}/instances/{instance}/certificateAuthority
* Please see {@see MemorystoreClient::instanceName()} for help formatting this field.
*/
function get_certificate_authority_sample(string $formattedName): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = (new GetCertificateAuthorityRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var CertificateAuthority $response */
$response = $memorystoreClient->getCertificateAuthority($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedName = MemorystoreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
get_certificate_authority_sample($formattedName);
}
getInstance
Gets details of a single Instance.
The async variant is MemorystoreClient::getInstanceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\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\Memorystore\V1\Instance |
use Google\ApiCore\ApiException;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\GetInstanceRequest;
use Google\Cloud\Memorystore\V1\Instance;
/**
* @param string $formattedName The name of the instance to retrieve.
* Format: projects/{project}/locations/{location}/instances/{instance}
* Please see {@see MemorystoreClient::instanceName()} for help formatting this field.
*/
function get_instance_sample(string $formattedName): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = (new GetInstanceRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Instance $response */
$response = $memorystoreClient->getInstance($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedName = MemorystoreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
get_instance_sample($formattedName);
}
listBackupCollections
Lists all backup collections owned by a consumer project in either the specified location (region) or all locations.
If location_id
is specified as -
(wildcard), then all regions
available to the project are queried, and the results are aggregated.
The async variant is MemorystoreClient::listBackupCollectionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\ListBackupCollectionsRequest
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\Memorystore\V1\ListBackupCollectionsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\ListBackupCollectionsRequest;
use Google\Cloud\Memorystore\V1\ListBackupCollectionsResponse;
/**
* @param string $formattedParent The resource name of the backupCollection location using the
* form:
* `projects/{project_id}/locations/{location_id}`
* where `location_id` refers to a Google Cloud region. Please see
* {@see MemorystoreClient::locationName()} for help formatting this field.
*/
function list_backup_collections_sample(string $formattedParent): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = (new ListBackupCollectionsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var ListBackupCollectionsResponse $response */
$response = $memorystoreClient->listBackupCollections($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedParent = MemorystoreClient::locationName('[PROJECT]', '[LOCATION]');
list_backup_collections_sample($formattedParent);
}
listBackups
Lists all backups owned by a backup collection.
The async variant is MemorystoreClient::listBackupsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\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\Cloud\Memorystore\V1\ListBackupsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\ListBackupsRequest;
use Google\Cloud\Memorystore\V1\ListBackupsResponse;
/**
* @param string $formattedParent The resource name of the backupCollection using the form:
* `projects/{project_id}/locations/{location_id}/backupCollections/{backup_collection_id}`
* Please see {@see MemorystoreClient::backupCollectionName()} for help formatting this field.
*/
function list_backups_sample(string $formattedParent): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = (new ListBackupsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var ListBackupsResponse $response */
$response = $memorystoreClient->listBackups($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedParent = MemorystoreClient::backupCollectionName(
'[PROJECT]',
'[LOCATION]',
'[BACKUP_COLLECTION]'
);
list_backups_sample($formattedParent);
}
listInstances
Lists Instances in a given project and location.
The async variant is MemorystoreClient::listInstancesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\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\Cloud\Memorystore\V1\ListInstancesResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\ListInstancesRequest;
use Google\Cloud\Memorystore\V1\ListInstancesResponse;
/**
* @param string $formattedParent The parent to list instances from.
* Format: projects/{project}/locations/{location}
* Please see {@see MemorystoreClient::locationName()} for help formatting this field.
*/
function list_instances_sample(string $formattedParent): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = (new ListInstancesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var ListInstancesResponse $response */
$response = $memorystoreClient->listInstances($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedParent = MemorystoreClient::locationName('[PROJECT]', '[LOCATION]');
list_instances_sample($formattedParent);
}
rescheduleMaintenance
Reschedules upcoming maintenance event.
The async variant is MemorystoreClient::rescheduleMaintenanceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\RescheduleMaintenanceRequest
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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\Instance;
use Google\Cloud\Memorystore\V1\RescheduleMaintenanceRequest;
use Google\Cloud\Memorystore\V1\RescheduleMaintenanceRequest\RescheduleType;
use Google\Rpc\Status;
/**
* @param string $formattedName Name of the instance to reschedule maintenance for:
* `projects/{project}/locations/{location_id}/instances/{instance}`
* Please see {@see MemorystoreClient::instanceName()} for help formatting this field.
* @param int $rescheduleType If reschedule type is SPECIFIC_TIME, schedule_time must be set.
*/
function reschedule_maintenance_sample(string $formattedName, int $rescheduleType): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = (new RescheduleMaintenanceRequest())
->setName($formattedName)
->setRescheduleType($rescheduleType);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $memorystoreClient->rescheduleMaintenance($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Instance $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());
}
}
/**
* Helper to execute the sample.
*
* 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 callSample(): void
{
$formattedName = MemorystoreClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
$rescheduleType = RescheduleType::RESCHEDULE_TYPE_UNSPECIFIED;
reschedule_maintenance_sample($formattedName, $rescheduleType);
}
updateInstance
Updates the parameters of a single Instance.
The async variant is MemorystoreClient::updateInstanceAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
use Google\Cloud\Memorystore\V1\Instance;
use Google\Cloud\Memorystore\V1\UpdateInstanceRequest;
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_instance_sample(): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$instance = new Instance();
$request = (new UpdateInstanceRequest())
->setInstance($instance);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $memorystoreClient->updateInstance($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Instance $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());
}
}
getLocation
Gets information about a location.
The async variant is MemorystoreClient::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
/**
* 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_location_sample(): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $memorystoreClient->getLocation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
The async variant is MemorystoreClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Memorystore\V1\Client\MemorystoreClient;
/**
* 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_locations_sample(): void
{
// Create a client.
$memorystoreClient = new MemorystoreClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $memorystoreClient->listLocations($request);
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());
}
}
backupInstanceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\BackupInstanceRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
createInstanceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\CreateInstanceRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
deleteBackupAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\DeleteBackupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
deleteInstanceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\DeleteInstanceRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
exportBackupAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\ExportBackupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getBackupAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\GetBackupRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Memorystore\V1\Backup> |
getBackupCollectionAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\GetBackupCollectionRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Memorystore\V1\BackupCollection> |
getCertificateAuthorityAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\GetCertificateAuthorityRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Memorystore\V1\CertificateAuthority> |
getInstanceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\GetInstanceRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Memorystore\V1\Instance> |
listBackupCollectionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\ListBackupCollectionsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Memorystore\V1\ListBackupCollectionsResponse> |
listBackupsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\ListBackupsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Memorystore\V1\ListBackupsResponse> |
listInstancesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\ListInstancesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Memorystore\V1\ListInstancesResponse> |
rescheduleMaintenanceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\RescheduleMaintenanceRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
updateInstanceAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Memorystore\V1\UpdateInstanceRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getLocationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location> |
listLocationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
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 |
static::backupName
Formats a string containing the fully-qualified path to represent a backup resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
backupCollection |
string
|
backup |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted backup resource. |
static::backupCollectionName
Formats a string containing the fully-qualified path to represent a backup_collection resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
backupCollection |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted backup_collection resource. |
static::forwardingRuleName
Formats a string containing the fully-qualified path to represent a forwarding_rule resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
region |
string
|
forwardingRule |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted forwarding_rule resource. |
static::instanceName
Formats a string containing the fully-qualified path to represent a instance resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
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::serviceAttachmentName
Formats a string containing the fully-qualified path to represent a service_attachment resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
region |
string
|
serviceAttachment |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted service_attachment 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}/backupCollections/{backup_collection}/backups/{backup}
- backupCollection: projects/{project}/locations/{location}/backupCollections/{backup_collection}
- forwardingRule: projects/{project}/regions/{region}/forwardingRules/{forwarding_rule}
- instance: projects/{project}/locations/{location}/instances/{instance}
- location: projects/{project}/locations/{location}
- network: projects/{project}/global/networks/{network}
- serviceAttachment: projects/{project}/regions/{region}/serviceAttachments/{service_attachment}
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. |