Reference documentation and code samples for the Google Cloud Redis V1beta1 Client class CloudRedisClient.
Service Description: Configures and manages Cloud Memorystore for Redis instances
Google Cloud Memorystore for Redis v1beta1
The redis.googleapis.com service implements the Google Cloud Memorystore
for Redis API and defines the following resource model for managing Redis
instances:
- The service works with a collection of cloud projects, named:
/projects/* - Each project has a collection of available locations, named:
/locations/* - Each location has a collection of Redis instances, named:
/instances/* - As such, Redis instances are resources of the form:
/projects/{project_id}/locations/{location_id}/instances/{instance_id}
Note that location_id must be referring to a GCP region; for example:
projects/redpepper-1290/locations/us-central1/instances/my-redis
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$cloudRedisClient = new Google\Cloud\Redis\V1beta1\CloudRedisClient();
try {
$formattedParent = $cloudRedisClient->locationName('[PROJECT]', '[LOCATION]');
$instanceId = 'instance_id';
$instance = new Google\Cloud\Redis\V1beta1\Instance();
$operationResponse = $cloudRedisClient->createInstance($formattedParent, $instanceId, $instance);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
$result = $operationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $cloudRedisClient->createInstance($formattedParent, $instanceId, $instance);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $cloudRedisClient->resumeOperation($operationName, 'createInstance');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
$result = $newOperationResponse->getResult();
// doSomethingWith($result)
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$cloudRedisClient->close();
}
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 \ Redis \ V1beta1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
createInstance
Creates a Redis instance based on the specified tier and memory size.
By default, the instance is accessible from the project's default network.
The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. The completed longrunning.Operation will contain the new instance object in the response field.
The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The resource name of the instance location using the form:
|
instanceId |
string
Required. The logical name of the Redis instance in the customer project with the following restrictions:
|
instance |
Google\Cloud\Redis\V1beta1\Instance
Required. A Redis [Instance] resource |
optionalArgs |
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\Redis\V1beta1\CloudRedisClient;
use Google\Cloud\Redis\V1beta1\Instance;
use Google\Cloud\Redis\V1beta1\Instance\Tier;
use Google\Rpc\Status;
/**
* @param string $formattedParent The resource name of the instance location using the form:
* `projects/{project_id}/locations/{location_id}`
* where `location_id` refers to a GCP region. Please see
* {@see CloudRedisClient::locationName()} for help formatting this field.
* @param string $instanceId The logical name of the Redis instance in the customer project
* with the following restrictions:
*
* * Must contain only lowercase letters, numbers, and hyphens.
* * Must start with a letter.
* * Must be between 1-40 characters.
* * Must end with a number or a letter.
* * Must be unique within the customer project / location
* @param string $instanceName Unique name of the resource in this scope including project and
* location using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
*
* Note: Redis instances are managed and addressed at regional level so
* location_id here refers to a GCP region; however, users may choose which
* specific zone (or collection of zones for cross-zone instances) an instance
* should be provisioned in. Refer to [location_id][google.cloud.redis.v1beta1.Instance.location_id] and
* [alternative_location_id][google.cloud.redis.v1beta1.Instance.alternative_location_id] fields for more details.
* @param int $instanceTier The service tier of the instance.
* @param int $instanceMemorySizeGb Redis memory size in GiB.
*/
function create_instance_sample(
string $formattedParent,
string $instanceId,
string $instanceName,
int $instanceTier,
int $instanceMemorySizeGb
): void {
// Create a client.
$cloudRedisClient = new CloudRedisClient();
// Prepare any non-scalar elements to be passed along with the request.
$instance = (new Instance())
->setName($instanceName)
->setTier($instanceTier)
->setMemorySizeGb($instanceMemorySizeGb);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudRedisClient->createInstance($formattedParent, $instanceId, $instance);
$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 = CloudRedisClient::locationName('[PROJECT]', '[LOCATION]');
$instanceId = '[INSTANCE_ID]';
$instanceName = '[NAME]';
$instanceTier = Tier::TIER_UNSPECIFIED;
$instanceMemorySizeGb = 0;
create_instance_sample(
$formattedParent,
$instanceId,
$instanceName,
$instanceTier,
$instanceMemorySizeGb
);
}
deleteInstance
Deletes a specific Redis instance. Instance stops serving and data is deleted.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Redis instance resource name using the form:
|
optionalArgs |
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\Redis\V1beta1\CloudRedisClient;
use Google\Rpc\Status;
/**
* @param string $formattedName Redis instance resource name using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a GCP region. Please see
* {@see CloudRedisClient::instanceName()} for help formatting this field.
*/
function delete_instance_sample(string $formattedName): void
{
// Create a client.
$cloudRedisClient = new CloudRedisClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudRedisClient->deleteInstance($formattedName);
$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 = CloudRedisClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
delete_instance_sample($formattedName);
}
exportInstance
Export Redis instance data into a Redis RDB format file in Cloud Storage.
Redis will continue serving during this operation.
The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Redis instance resource name using the form:
|
outputConfig |
Google\Cloud\Redis\V1beta1\OutputConfig
Required. Specify data to be exported. |
optionalArgs |
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\Redis\V1beta1\CloudRedisClient;
use Google\Cloud\Redis\V1beta1\Instance;
use Google\Cloud\Redis\V1beta1\OutputConfig;
use Google\Rpc\Status;
/**
* @param string $name Redis instance resource name using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a GCP region.
*/
function export_instance_sample(string $name): void
{
// Create a client.
$cloudRedisClient = new CloudRedisClient();
// Prepare any non-scalar elements to be passed along with the request.
$outputConfig = new OutputConfig();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudRedisClient->exportInstance($name, $outputConfig);
$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
{
$name = '[NAME]';
export_instance_sample($name);
}
failoverInstance
Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Redis instance resource name using the form:
|
optionalArgs |
array
Optional. |
↳ dataProtectionMode |
int
Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default. For allowed values, use constants defined on Google\Cloud\Redis\V1beta1\FailoverInstanceRequest\DataProtectionMode |
↳ 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\Redis\V1beta1\CloudRedisClient;
use Google\Cloud\Redis\V1beta1\Instance;
use Google\Rpc\Status;
/**
* @param string $formattedName Redis instance resource name using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a GCP region. Please see
* {@see CloudRedisClient::instanceName()} for help formatting this field.
*/
function failover_instance_sample(string $formattedName): void
{
// Create a client.
$cloudRedisClient = new CloudRedisClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudRedisClient->failoverInstance($formattedName);
$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 = CloudRedisClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
failover_instance_sample($formattedName);
}
getInstance
Gets the details of a specific Redis instance.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Redis instance resource name using the form:
|
optionalArgs |
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\Redis\V1beta1\Instance | |
use Google\ApiCore\ApiException;
use Google\Cloud\Redis\V1beta1\CloudRedisClient;
use Google\Cloud\Redis\V1beta1\Instance;
/**
* @param string $formattedName Redis instance resource name using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a GCP region. Please see
* {@see CloudRedisClient::instanceName()} for help formatting this field.
*/
function get_instance_sample(string $formattedName): void
{
// Create a client.
$cloudRedisClient = new CloudRedisClient();
// Call the API and handle any network failures.
try {
/** @var Instance $response */
$response = $cloudRedisClient->getInstance($formattedName);
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 = CloudRedisClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
get_instance_sample($formattedName);
}
getInstanceAuthString
Gets the AUTH string for a Redis instance. If AUTH is not enabled for the instance the response will be empty. This information is not included in the details returned to GetInstance.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Redis instance resource name using the form:
|
optionalArgs |
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\Redis\V1beta1\InstanceAuthString | |
use Google\ApiCore\ApiException;
use Google\Cloud\Redis\V1beta1\CloudRedisClient;
use Google\Cloud\Redis\V1beta1\InstanceAuthString;
/**
* @param string $formattedName Redis instance resource name using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a GCP region. Please see
* {@see CloudRedisClient::instanceName()} for help formatting this field.
*/
function get_instance_auth_string_sample(string $formattedName): void
{
// Create a client.
$cloudRedisClient = new CloudRedisClient();
// Call the API and handle any network failures.
try {
/** @var InstanceAuthString $response */
$response = $cloudRedisClient->getInstanceAuthString($formattedName);
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 = CloudRedisClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
get_instance_auth_string_sample($formattedName);
}
importInstance
Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.
Redis may stop serving during this operation. Instance state will be IMPORTING for entire operation. When complete, the instance will contain only data from the imported file.
The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Redis instance resource name using the form:
|
inputConfig |
Google\Cloud\Redis\V1beta1\InputConfig
Required. Specify data to be imported. |
optionalArgs |
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\Redis\V1beta1\CloudRedisClient;
use Google\Cloud\Redis\V1beta1\InputConfig;
use Google\Cloud\Redis\V1beta1\Instance;
use Google\Rpc\Status;
/**
* @param string $name Redis instance resource name using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a GCP region.
*/
function import_instance_sample(string $name): void
{
// Create a client.
$cloudRedisClient = new CloudRedisClient();
// Prepare any non-scalar elements to be passed along with the request.
$inputConfig = new InputConfig();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudRedisClient->importInstance($name, $inputConfig);
$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
{
$name = '[NAME]';
import_instance_sample($name);
}
listInstances
Lists all Redis instances owned by a project in either the specified location (region) or all locations.
The location should have the following format:
projects/{project_id}/locations/{location_id}
If location_id is specified as - (wildcard), then all regions
available to the project are queried, and the results are aggregated.
| Parameters | |
|---|---|
| Name | Description |
parent |
string
Required. The resource name of the instance location using the form:
|
optionalArgs |
array
Optional. |
↳ pageSize |
int
The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved. |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\PagedListResponse | |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Redis\V1beta1\CloudRedisClient;
use Google\Cloud\Redis\V1beta1\Instance;
/**
* @param string $formattedParent The resource name of the instance location using the form:
* `projects/{project_id}/locations/{location_id}`
* where `location_id` refers to a GCP region. Please see
* {@see CloudRedisClient::locationName()} for help formatting this field.
*/
function list_instances_sample(string $formattedParent): void
{
// Create a client.
$cloudRedisClient = new CloudRedisClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $cloudRedisClient->listInstances($formattedParent);
/** @var Instance $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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 = CloudRedisClient::locationName('[PROJECT]', '[LOCATION]');
list_instances_sample($formattedParent);
}
rescheduleMaintenance
Reschedule maintenance for a given instance in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Redis instance resource name using the form:
|
rescheduleType |
int
Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well. For allowed values, use constants defined on Google\Cloud\Redis\V1beta1\RescheduleMaintenanceRequest\RescheduleType |
optionalArgs |
array
Optional. |
↳ scheduleTime |
Timestamp
Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example |
↳ 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\Redis\V1beta1\CloudRedisClient;
use Google\Cloud\Redis\V1beta1\Instance;
use Google\Cloud\Redis\V1beta1\RescheduleMaintenanceRequest\RescheduleType;
use Google\Rpc\Status;
/**
* @param string $formattedName Redis instance resource name using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a GCP region. Please see
* {@see CloudRedisClient::instanceName()} for help formatting this field.
* @param int $rescheduleType If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.
*/
function reschedule_maintenance_sample(string $formattedName, int $rescheduleType): void
{
// Create a client.
$cloudRedisClient = new CloudRedisClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudRedisClient->rescheduleMaintenance($formattedName, $rescheduleType);
$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 = CloudRedisClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
$rescheduleType = RescheduleType::RESCHEDULE_TYPE_UNSPECIFIED;
reschedule_maintenance_sample($formattedName, $rescheduleType);
}
updateInstance
Updates the metadata and configuration of a specific Redis instance.
Completed longrunning.Operation will contain the new instance object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.
| Parameters | |
|---|---|
| Name | Description |
updateMask |
Google\Protobuf\FieldMask
Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Instance:
|
instance |
Google\Cloud\Redis\V1beta1\Instance
Required. Update description. Only fields specified in update_mask are updated. |
optionalArgs |
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\Redis\V1beta1\CloudRedisClient;
use Google\Cloud\Redis\V1beta1\Instance;
use Google\Cloud\Redis\V1beta1\Instance\Tier;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;
/**
* @param string $instanceName Unique name of the resource in this scope including project and
* location using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
*
* Note: Redis instances are managed and addressed at regional level so
* location_id here refers to a GCP region; however, users may choose which
* specific zone (or collection of zones for cross-zone instances) an instance
* should be provisioned in. Refer to [location_id][google.cloud.redis.v1beta1.Instance.location_id] and
* [alternative_location_id][google.cloud.redis.v1beta1.Instance.alternative_location_id] fields for more details.
* @param int $instanceTier The service tier of the instance.
* @param int $instanceMemorySizeGb Redis memory size in GiB.
*/
function update_instance_sample(
string $instanceName,
int $instanceTier,
int $instanceMemorySizeGb
): void {
// Create a client.
$cloudRedisClient = new CloudRedisClient();
// Prepare any non-scalar elements to be passed along with the request.
$updateMask = new FieldMask();
$instance = (new Instance())
->setName($instanceName)
->setTier($instanceTier)
->setMemorySizeGb($instanceMemorySizeGb);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudRedisClient->updateInstance($updateMask, $instance);
$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
{
$instanceName = '[NAME]';
$instanceTier = Tier::TIER_UNSPECIFIED;
$instanceMemorySizeGb = 0;
update_instance_sample($instanceName, $instanceTier, $instanceMemorySizeGb);
}
upgradeInstance
Upgrades Redis instance to the newer Redis version specified in the request.
| Parameters | |
|---|---|
| Name | Description |
name |
string
Required. Redis instance resource name using the form:
|
redisVersion |
string
Required. Specifies the target version of Redis software to upgrade to. |
optionalArgs |
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\Redis\V1beta1\CloudRedisClient;
use Google\Cloud\Redis\V1beta1\Instance;
use Google\Rpc\Status;
/**
* @param string $formattedName Redis instance resource name using the form:
* `projects/{project_id}/locations/{location_id}/instances/{instance_id}`
* where `location_id` refers to a GCP region. Please see
* {@see CloudRedisClient::instanceName()} for help formatting this field.
* @param string $redisVersion Specifies the target version of Redis software to upgrade to.
*/
function upgrade_instance_sample(string $formattedName, string $redisVersion): void
{
// Create a client.
$cloudRedisClient = new CloudRedisClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $cloudRedisClient->upgradeInstance($formattedName, $redisVersion);
$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 = CloudRedisClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
$redisVersion = '[REDIS_VERSION]';
upgrade_instance_sample($formattedName, $redisVersion);
}
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::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::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
- instance: projects/{project}/locations/{location}/instances/{instance}
- location: projects/{project}/locations/{location}
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. |
Constants
SERVICE_NAME
Value: 'google.cloud.redis.v1beta1.CloudRedis'The name of the service.
SERVICE_ADDRESS
Value: 'redis.googleapis.com'The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443The default port of the service.
CODEGEN_NAME
Value: 'gapic'The name of the code generator, to be included in the agent header.