Class CloudRedisClient (2.0.0)

CloudRedisClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.redis_v1beta1.services.cloud_redis.transports.base.CloudRedisTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-redis/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = 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 refering to a GCP region; for example:

projects/redpepper-1290/locations/us-central1/instances/my-redis

Methods

CloudRedisClient

CloudRedisClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.redis_v1beta1.services.cloud_redis.transports.base.CloudRedisTransport] = None, client_options: <module 'google.api_core.client_options' from '/workspace/python-redis/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate the cloud redis client.

Parameters
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 `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If mutual TLS transport creation failed for any reason.

create_instance

create_instance(request: Optional[google.cloud.redis_v1beta1.types.cloud_redis.CreateInstanceRequest] = None, *, parent: Optional[str] = None, instance_id: Optional[str] = None, instance: Optional[google.cloud.redis_v1beta1.types.cloud_redis.Instance] = None, retry: google.api_core.retry.Retry = <_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. 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
`request`	`.cloud_redis.CreateInstanceRequest` The request object. Request for CreateInstance.
`parent`	`str` Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`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_id` field on the `request` instance; if `request` is provided, this should not be set.
`instance`	`.cloud_redis.Instance` Required. A Redis [Instance] resource This corresponds to the `instance` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`.operation.Operation`	An object representing a long-running operation. The result type for the operation will be .cloud_redis.Instance : A Google Cloud Redis instance.

delete_instance

delete_instance(request: Optional[google.cloud.redis_v1beta1.types.cloud_redis.DeleteInstanceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_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.

Parameters
Name	Description
`request`	`.cloud_redis.DeleteInstanceRequest` The request object. Request for DeleteInstance.
`name`	`str` Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns

Type Description

.operation.Operation

An object representing a long-running operation. The result type for the operation will be

.empty.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[google.cloud.redis_v1beta1.types.cloud_redis.ExportInstanceRequest] = None, *, name: Optional[str] = None, output_config: Optional[google.cloud.redis_v1beta1.types.cloud_redis.OutputConfig] = None, retry: google.api_core.retry.Retry = <_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.

Parameters
Name	Description
`request`	`.cloud_redis.ExportInstanceRequest` The request object. Request for Export.
`name`	`str` Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`output_config`	`.cloud_redis.OutputConfig` Required. Specify data to be exported. This corresponds to the `output_config` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`.operation.Operation`	An object representing a long-running operation. The result type for the operation will be .cloud_redis.Instance : A Google Cloud Redis instance.

failover_instance

failover_instance(request: Optional[google.cloud.redis_v1beta1.types.cloud_redis.FailoverInstanceRequest] = None, *, name: Optional[str] = None, data_protection_mode: Optional[google.cloud.redis_v1beta1.types.cloud_redis.FailoverInstanceRequest.DataProtectionMode] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.

Parameters
Name	Description
`request`	`.cloud_redis.FailoverInstanceRequest` The request object. Request for Failover.
`name`	`str` Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`data_protection_mode`	`.cloud_redis.FailoverInstanceRequest.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 `data_protection_mode` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`.operation.Operation`	An object representing a long-running operation. The result type for the operation will be .cloud_redis.Instance : A Google Cloud 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.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	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.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`{@api.name}`	The constructed client.

get_instance

get_instance(request: Optional[google.cloud.redis_v1beta1.types.cloud_redis.GetInstanceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the details of a specific Redis instance.

Parameters
Name	Description
`request`	`.cloud_redis.GetInstanceRequest` The request object. Request for GetInstance.
`name`	`str` Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`.cloud_redis.Instance`	A Google Cloud Redis instance.

import_instance

import_instance(request: Optional[google.cloud.redis_v1beta1.types.cloud_redis.ImportInstanceRequest] = None, *, name: Optional[str] = None, input_config: Optional[google.cloud.redis_v1beta1.types.cloud_redis.InputConfig] = None, retry: google.api_core.retry.Retry = <_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.

Parameters
Name	Description
`request`	`.cloud_redis.ImportInstanceRequest` The request object. Request for Import.
`name`	`str` Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`input_config`	`.cloud_redis.InputConfig` Required. Specify data to be imported. This corresponds to the `input_config` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`.operation.Operation`	An object representing a long-running operation. The result type for the operation will be .cloud_redis.Instance : A Google Cloud Redis instance.

instance_path

instance_path(project: str, location: str, instance: str)

Return a fully-qualified instance string.

list_instances

list_instances(request: Optional[google.cloud.redis_v1beta1.types.cloud_redis.ListInstancesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_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.

Parameters
Name	Description
`request`	`.cloud_redis.ListInstancesRequest` The request object. Request for ListInstances.
`parent`	`str` Required. The resource name of the instance location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`.pagers.ListInstancesPager`	Response for ListInstances. Iterating over this object will yield results and resolve additional pages automatically.

parse_instance_path

parse_instance_path(path: str)

Parse a instance path into its component segments.

update_instance

update_instance(request: Optional[google.cloud.redis_v1beta1.types.cloud_redis.UpdateInstanceRequest] = None, *, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, instance: Optional[google.cloud.redis_v1beta1.types.cloud_redis.Instance] = None, retry: google.api_core.retry.Retry = <_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.

Parameters
Name	Description
`request`	`.cloud_redis.UpdateInstanceRequest` The request object. Request for UpdateInstance.
`update_mask`	`.field_mask.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: - `displayName` - `labels` - `memorySizeGb` - `redisConfig` This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`instance`	`.cloud_redis.Instance` Required. Update description. Only fields specified in update_mask are updated. This corresponds to the `instance` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`.operation.Operation`	An object representing a long-running operation. The result type for the operation will be .cloud_redis.Instance : A Google Cloud Redis instance.

upgrade_instance

upgrade_instance(request: Optional[google.cloud.redis_v1beta1.types.cloud_redis.UpgradeInstanceRequest] = None, *, name: Optional[str] = None, redis_version: Optional[str] = None, retry: google.api_core.retry.Retry = <_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.

Parameters
Name	Description
`request`	`.cloud_redis.UpgradeInstanceRequest` The request object. Request for UpgradeInstance.
`name`	`str` Required. Redis instance resource name using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` where `location_id` refers to a GCP region. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`redis_version`	`str` Required. Specifies the target version of Redis software to upgrade to. This corresponds to the `redis_version` field on the `request` instance; if `request` is provided, this should not be set.
`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.

Returns
Type	Description
`.operation.Operation`	An object representing a long-running operation. The result type for the operation will be .cloud_redis.Instance : A Google Cloud Redis instance.