CloudRedisAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.redis_v1beta1.services.cloud_redis.transports.base.CloudRedisTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
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
Inheritance
builtins.object > CloudRedisAsyncClientProperties
transport
Returns the transport used by the client instance.
Type | Description |
CloudRedisTransport | The transport used by the client instance. |
Methods
CloudRedisAsyncClient
CloudRedisAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.redis_v1beta1.services.cloud_redis.transports.base.CloudRedisTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the cloud redis client.
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, `.CloudRedisTransport`]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_instance
create_instance(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.CreateInstanceRequest, dict]] = None, *, parent: Optional[str] = None, instance_id: Optional[str] = None, instance: Optional[google.cloud.redis_v1beta1.types.cloud_redis.Instance] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Creates a Redis instance based on the specified tier and memory size.
By default, the instance is accessible from the project's
default network <https://cloud.google.com/vpc/docs/vpc>
__.
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.
from google.cloud import redis_v1beta1
def sample_create_instance():
# Create a client
client = redis_v1beta1.CloudRedisClient()
# Initialize request argument(s)
instance = redis_v1beta1.Instance()
instance.name = "name_value"
instance.tier = "STANDARD_HA"
instance.memory_size_gb = 1499
request = redis_v1beta1.CreateInstanceRequest(
parent="parent_value",
instance_id="instance_id_value",
instance=instance,
)
# Make the request
operation = client.create_instance(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.redis_v1beta1.types.CreateInstanceRequest, dict]
The request object. Request for CreateInstance. |
parent |
`str`
Required. The resource name of the instance location using the form: |
instance_id |
`str`
Required. 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 This corresponds to the |
instance |
Instance
Required. A Redis [Instance] resource This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance A Memorystore for Redis instance. |
delete_instance
delete_instance(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.DeleteInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Deletes a specific Redis instance. Instance stops serving and data is deleted.
from google.cloud import redis_v1beta1
def sample_delete_instance():
# Create a client
client = redis_v1beta1.CloudRedisClient()
# Initialize request argument(s)
request = redis_v1beta1.DeleteInstanceRequest(
name="name_value",
)
# Make the request
operation = client.delete_instance(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.redis_v1beta1.types.DeleteInstanceRequest, dict]
The request object. Request for DeleteInstance. |
name |
`str`
Required. Redis instance resource name using the form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
export_instance
export_instance(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.ExportInstanceRequest, dict]] = None, *, name: Optional[str] = None, output_config: Optional[google.cloud.redis_v1beta1.types.cloud_redis.OutputConfig] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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.
from google.cloud import redis_v1beta1
def sample_export_instance():
# Create a client
client = redis_v1beta1.CloudRedisClient()
# Initialize request argument(s)
output_config = redis_v1beta1.OutputConfig()
output_config.gcs_destination.uri = "uri_value"
request = redis_v1beta1.ExportInstanceRequest(
name="name_value",
output_config=output_config,
)
# Make the request
operation = client.export_instance(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.redis_v1beta1.types.ExportInstanceRequest, dict]
The request object. Request for Export. |
name |
`str`
Required. Redis instance resource name using the form: |
output_config |
OutputConfig
Required. Specify data to be exported. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance A Memorystore for Redis instance. |
failover_instance
failover_instance(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.FailoverInstanceRequest, dict]] = None, *, name: Optional[str] = None, data_protection_mode: Optional[google.cloud.redis_v1beta1.types.cloud_redis.FailoverInstanceRequest.DataProtectionMode] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Initiates a failover of the primary node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
from google.cloud import redis_v1beta1
def sample_failover_instance():
# Create a client
client = redis_v1beta1.CloudRedisClient()
# Initialize request argument(s)
request = redis_v1beta1.FailoverInstanceRequest(
name="name_value",
)
# Make the request
operation = client.failover_instance(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.redis_v1beta1.types.FailoverInstanceRequest, dict]
The request object. Request for Failover. |
name |
`str`
Required. Redis instance resource name using the form: |
data_protection_mode |
DataProtectionMode
Optional. Available data protection modes that the user can choose. If it's unspecified, data protection mode will be LIMITED_DATA_LOSS by default. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance A Memorystore for Redis instance. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
CloudRedisAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Name | Description |
info |
dict
The service account private key info. |
Type | Description |
CloudRedisAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Name | Description |
filename |
str
The path to the service account private key json file. |
Type | Description |
CloudRedisAsyncClient | The constructed client. |
get_instance
get_instance(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.GetInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Gets the details of a specific Redis instance.
from google.cloud import redis_v1beta1
def sample_get_instance():
# Create a client
client = redis_v1beta1.CloudRedisClient()
# Initialize request argument(s)
request = redis_v1beta1.GetInstanceRequest(
name="name_value",
)
# Make the request
response = client.get_instance(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.redis_v1beta1.types.GetInstanceRequest, dict]
The request object. Request for GetInstance. |
name |
`str`
Required. Redis instance resource name using the form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.redis_v1beta1.types.Instance | A Memorystore for Redis instance. |
get_instance_auth_string
get_instance_auth_string(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.GetInstanceAuthStringRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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.
from google.cloud import redis_v1beta1
def sample_get_instance_auth_string():
# Create a client
client = redis_v1beta1.CloudRedisClient()
# Initialize request argument(s)
request = redis_v1beta1.GetInstanceAuthStringRequest(
name="name_value",
)
# Make the request
response = client.get_instance_auth_string(request=request)
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.redis_v1beta1.types.GetInstanceAuthStringRequest, dict]
The request object. Request for GetInstanceAuthString. |
name |
`str`
Required. Redis instance resource name using the form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.redis_v1beta1.types.InstanceAuthString | Instance AUTH string details. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
import_instance
import_instance(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.ImportInstanceRequest, dict]] = None, *, name: Optional[str] = None, input_config: Optional[google.cloud.redis_v1beta1.types.cloud_redis.InputConfig] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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.
from google.cloud import redis_v1beta1
def sample_import_instance():
# Create a client
client = redis_v1beta1.CloudRedisClient()
# Initialize request argument(s)
input_config = redis_v1beta1.InputConfig()
input_config.gcs_source.uri = "uri_value"
request = redis_v1beta1.ImportInstanceRequest(
name="name_value",
input_config=input_config,
)
# Make the request
operation = client.import_instance(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.redis_v1beta1.types.ImportInstanceRequest, dict]
The request object. Request for Import. |
name |
`str`
Required. Redis instance resource name using the form: |
input_config |
InputConfig
Required. Specify data to be imported. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance A Memorystore for Redis instance. |
instance_path
instance_path(project: str, location: str, instance: str)
Returns a fully-qualified instance string.
list_instances
list_instances(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.ListInstancesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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.
from google.cloud import redis_v1beta1
def sample_list_instances():
# Create a client
client = redis_v1beta1.CloudRedisClient()
# Initialize request argument(s)
request = redis_v1beta1.ListInstancesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_instances(request=request)
# Handle the response
for response in page_result:
print(response)
Name | Description |
request |
Union[google.cloud.redis_v1beta1.types.ListInstancesRequest, dict]
The request object. Request for ListInstances. |
parent |
`str`
Required. The resource name of the instance location using the form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.cloud.redis_v1beta1.services.cloud_redis.pagers.ListInstancesAsyncPager | Response for ListInstances. Iterating over this object will yield results and resolve additional pages automatically. |
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_instance_path
parse_instance_path(path: str)
Parses a instance path into its component segments.
reschedule_maintenance
reschedule_maintenance(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.RescheduleMaintenanceRequest, dict]] = None, *, name: Optional[str] = None, reschedule_type: Optional[google.cloud.redis_v1beta1.types.cloud_redis.RescheduleMaintenanceRequest.RescheduleType] = None, schedule_time: Optional[google.protobuf.timestamp_pb2.Timestamp] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Reschedule maintenance for a given instance in a given project and location.
from google.cloud import redis_v1beta1
def sample_reschedule_maintenance():
# Create a client
client = redis_v1beta1.CloudRedisClient()
# Initialize request argument(s)
request = redis_v1beta1.RescheduleMaintenanceRequest(
name="name_value",
reschedule_type="SPECIFIC_TIME",
)
# Make the request
operation = client.reschedule_maintenance(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.redis_v1beta1.types.RescheduleMaintenanceRequest, dict]
The request object. Request for RescheduleMaintenance. |
name |
`str`
Required. Redis instance resource name using the form: |
reschedule_type |
RescheduleType
Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well. This corresponds to the |
schedule_time |
`google.protobuf.timestamp_pb2.Timestamp`
Optional. Timestamp when the maintenance shall be rescheduled to if reschedule_type=SPECIFIC_TIME, in RFC 3339 format, for example |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance A Memorystore for Redis instance. |
update_instance
update_instance(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.UpdateInstanceRequest, dict]] = None, *, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, instance: Optional[google.cloud.redis_v1beta1.types.cloud_redis.Instance] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
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.
from google.cloud import redis_v1beta1
def sample_update_instance():
# Create a client
client = redis_v1beta1.CloudRedisClient()
# Initialize request argument(s)
instance = redis_v1beta1.Instance()
instance.name = "name_value"
instance.tier = "STANDARD_HA"
instance.memory_size_gb = 1499
request = redis_v1beta1.UpdateInstanceRequest(
instance=instance,
)
# Make the request
operation = client.update_instance(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.redis_v1beta1.types.UpdateInstanceRequest, dict]
The request object. Request for UpdateInstance. |
update_mask |
`google.protobuf.field_mask_pb2.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 |
Instance
Required. Update description. Only fields specified in update_mask are updated. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance A Memorystore for Redis instance. |
upgrade_instance
upgrade_instance(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.UpgradeInstanceRequest, dict]] = None, *, name: Optional[str] = None, redis_version: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Upgrades Redis instance to the newer Redis version specified in the request.
from google.cloud import redis_v1beta1
def sample_upgrade_instance():
# Create a client
client = redis_v1beta1.CloudRedisClient()
# Initialize request argument(s)
request = redis_v1beta1.UpgradeInstanceRequest(
name="name_value",
redis_version="redis_version_value",
)
# Make the request
operation = client.upgrade_instance(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Name | Description |
request |
Union[google.cloud.redis_v1beta1.types.UpgradeInstanceRequest, dict]
The request object. Request for UpgradeInstance. |
name |
`str`
Required. Redis instance resource name using the form: |
redis_version |
`str`
Required. Specifies the target version of Redis software to upgrade to. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance A Memorystore for Redis instance. |