CloudRedis¶
- class google.cloud.redis_v1.services.cloud_redis.CloudRedisAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.redis_v1.services.cloud_redis.transports.base.CloudRedisTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/usr/lib/python3.10/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>)[source]¶
Configures and manages Cloud Memorystore for Redis instances
Google Cloud Memorystore for Redis v1
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
Instantiates the cloud redis client.
- Parameters
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) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.
- static common_billing_account_path(billing_account: str) str ¶
Returns a fully-qualified billing_account string.
- static common_folder_path(folder: str) str ¶
Returns a fully-qualified folder string.
- static common_location_path(project: str, location: str) str ¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str ¶
Returns a fully-qualified organization string.
- static common_project_path(project: str) str ¶
Returns a fully-qualified project string.
- async create_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.CreateInstanceRequest] = None, *, parent: Optional[str] = None, instance_id: Optional[str] = None, instance: Optional[google.cloud.redis_v1.types.cloud_redis.Instance] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
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. 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
request (
google.cloud.redis_v1.types.CreateInstanceRequest
) – The request object. Request for [CreateInstance][google.cloud.redis.v1.CloudRedis.CreateInstance].parent (
str
) –Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
wherelocation_id
refers to a GCP region.This corresponds to the
parent
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
is provided, this should not be set.instance (
google.cloud.redis_v1.types.Instance
) – Required. A Redis [Instance] resource This corresponds to theinstance
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.redis_v1.types.Instance
A Google Cloud Redis instance.- Return type
google.api_core.operation_async.AsyncOperation
- async delete_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.DeleteInstanceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Deletes a specific Redis instance. Instance stops serving and data is deleted.
- Parameters
request (
google.cloud.redis_v1.types.DeleteInstanceRequest
) – The request object. Request for [DeleteInstance][google.cloud.redis.v1.CloudRedis.DeleteInstance].name (
str
) –Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.This corresponds to the
name
field on therequest
instance; ifrequest
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
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 {}.
- The result type for the operation will be
- Return type
google.api_core.operation_async.AsyncOperation
- async export_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.ExportInstanceRequest] = None, *, name: Optional[str] = None, output_config: Optional[google.cloud.redis_v1.types.cloud_redis.OutputConfig] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
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
request (
google.cloud.redis_v1.types.ExportInstanceRequest
) – The request object. Request for [Export][google.cloud.redis.v1.CloudRedis.ExportInstance].name (
str
) –Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.output_config (
google.cloud.redis_v1.types.OutputConfig
) –Required. Specify data to be exported.
This corresponds to the
output_config
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.redis_v1.types.Instance
A Google Cloud Redis instance.- Return type
google.api_core.operation_async.AsyncOperation
- async failover_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.FailoverInstanceRequest] = None, *, name: Optional[str] = None, data_protection_mode: Optional[google.cloud.redis_v1.types.cloud_redis.FailoverInstanceRequest.DataProtectionMode] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
- Parameters
request (
google.cloud.redis_v1.types.FailoverInstanceRequest
) – The request object. Request for [Failover][google.cloud.redis.v1.CloudRedis.FailoverInstance].name (
str
) –Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.data_protection_mode (
google.cloud.redis_v1.types.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 therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.redis_v1.types.Instance
A Google Cloud Redis instance.- Return type
google.api_core.operation_async.AsyncOperation
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- async get_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.GetInstanceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.redis_v1.types.cloud_redis.Instance [source]¶
Gets the details of a specific Redis instance.
- Parameters
request (
google.cloud.redis_v1.types.GetInstanceRequest
) – The request object. Request for [GetInstance][google.cloud.redis.v1.CloudRedis.GetInstance].name (
str
) –Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.This corresponds to the
name
field on therequest
instance; ifrequest
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
A Google Cloud Redis instance.
- Return type
- get_transport_class() Type[google.cloud.redis_v1.services.cloud_redis.transports.base.CloudRedisTransport] ¶
Returns an appropriate transport class.
- Parameters
label – The name of the desired transport. If none is provided, then the first transport in the registry is used.
- Returns
The transport class to use.
- async import_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.ImportInstanceRequest] = None, *, name: Optional[str] = None, input_config: Optional[google.cloud.redis_v1.types.cloud_redis.InputConfig] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
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
request (
google.cloud.redis_v1.types.ImportInstanceRequest
) – The request object. Request for [Import][google.cloud.redis.v1.CloudRedis.ImportInstance].name (
str
) –Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.input_config (
google.cloud.redis_v1.types.InputConfig
) –Required. Specify data to be imported.
This corresponds to the
input_config
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.redis_v1.types.Instance
A Google Cloud Redis instance.- Return type
google.api_core.operation_async.AsyncOperation
- static instance_path(project: str, location: str, instance: str) str ¶
Returns a fully-qualified instance string.
- async list_instances(request: Optional[google.cloud.redis_v1.types.cloud_redis.ListInstancesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.redis_v1.services.cloud_redis.pagers.ListInstancesAsyncPager [source]¶
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
request (
google.cloud.redis_v1.types.ListInstancesRequest
) – The request object. Request for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].parent (
str
) –Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
wherelocation_id
refers to a GCP region.This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.redis_v1.services.cloud_redis.pagers.ListInstancesAsyncPager
- static parse_common_billing_account_path(path: str) Dict[str, str] ¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] ¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] ¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] ¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] ¶
Parse a project path into its component segments.
- static parse_instance_path(path: str) Dict[str, str] ¶
Parses a instance path into its component segments.
- property transport: google.cloud.redis_v1.services.cloud_redis.transports.base.CloudRedisTransport¶
Returns the transport used by the client instance.
- Returns
The transport used by the client instance.
- Return type
CloudRedisTransport
- async update_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.UpdateInstanceRequest] = None, *, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, instance: Optional[google.cloud.redis_v1.types.cloud_redis.Instance] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
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
request (
google.cloud.redis_v1.types.UpdateInstanceRequest
) – The request object. Request for [UpdateInstance][google.cloud.redis.v1.CloudRedis.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][google.cloud.redis.v1.Instance]:
displayName
labels
memorySizeGb
redisConfig
This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.instance (
google.cloud.redis_v1.types.Instance
) –Required. Update description. Only fields specified in update_mask are updated.
This corresponds to the
instance
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.redis_v1.types.Instance
A Google Cloud Redis instance.- Return type
google.api_core.operation_async.AsyncOperation
- async upgrade_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.UpgradeInstanceRequest] = None, *, name: Optional[str] = None, redis_version: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation_async.AsyncOperation [source]¶
Upgrades Redis instance to the newer Redis version specified in the request.
- Parameters
request (
google.cloud.redis_v1.types.UpgradeInstanceRequest
) – The request object. Request for [UpgradeInstance][google.cloud.redis.v1.CloudRedis.UpgradeInstance].name (
str
) –Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.This corresponds to the
name
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.redis_v1.types.Instance
A Google Cloud Redis instance.- Return type
google.api_core.operation_async.AsyncOperation
- class google.cloud.redis_v1.services.cloud_redis.CloudRedisClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.redis_v1.services.cloud_redis.transports.base.CloudRedisTransport]] = None, 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>)[source]¶
Configures and manages Cloud Memorystore for Redis instances
Google Cloud Memorystore for Redis v1
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
Instantiates the cloud redis client.
- Parameters
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 (google.api_core.client_options.ClientOptions) – Custom options for the client. It won’t take effect if a
transport
instance is provided. (1) Theapi_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, theapi_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then theclient_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.
- Raises
google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.
- static common_billing_account_path(billing_account: str) str [source]¶
Returns a fully-qualified billing_account string.
- static common_location_path(project: str, location: str) str [source]¶
Returns a fully-qualified location string.
- static common_organization_path(organization: str) str [source]¶
Returns a fully-qualified organization string.
- create_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.CreateInstanceRequest] = None, *, parent: Optional[str] = None, instance_id: Optional[str] = None, instance: Optional[google.cloud.redis_v1.types.cloud_redis.Instance] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
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. 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
request (google.cloud.redis_v1.types.CreateInstanceRequest) – The request object. Request for [CreateInstance][google.cloud.redis.v1.CloudRedis.CreateInstance].
parent (str) –
Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
wherelocation_id
refers to a GCP region.This corresponds to the
parent
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
is provided, this should not be set.instance (google.cloud.redis_v1.types.Instance) – Required. A Redis [Instance] resource This corresponds to the
instance
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.redis_v1.types.Instance
A Google Cloud Redis instance.- Return type
google.api_core.operation.Operation
- delete_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.DeleteInstanceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Deletes a specific Redis instance. Instance stops serving and data is deleted.
- Parameters
request (google.cloud.redis_v1.types.DeleteInstanceRequest) – The request object. Request for [DeleteInstance][google.cloud.redis.v1.CloudRedis.DeleteInstance].
name (str) –
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.This corresponds to the
name
field on therequest
instance; ifrequest
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
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 {}.
- The result type for the operation will be
- Return type
google.api_core.operation.Operation
- export_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.ExportInstanceRequest] = None, *, name: Optional[str] = None, output_config: Optional[google.cloud.redis_v1.types.cloud_redis.OutputConfig] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
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
request (google.cloud.redis_v1.types.ExportInstanceRequest) – The request object. Request for [Export][google.cloud.redis.v1.CloudRedis.ExportInstance].
name (str) –
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.output_config (google.cloud.redis_v1.types.OutputConfig) –
Required. Specify data to be exported.
This corresponds to the
output_config
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.redis_v1.types.Instance
A Google Cloud Redis instance.- Return type
google.api_core.operation.Operation
- failover_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.FailoverInstanceRequest] = None, *, name: Optional[str] = None, data_protection_mode: Optional[google.cloud.redis_v1.types.cloud_redis.FailoverInstanceRequest.DataProtectionMode] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Initiates a failover of the master node to current replica node for a specific STANDARD tier Cloud Memorystore for Redis instance.
- Parameters
request (google.cloud.redis_v1.types.FailoverInstanceRequest) – The request object. Request for [Failover][google.cloud.redis.v1.CloudRedis.FailoverInstance].
name (str) –
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.data_protection_mode (google.cloud.redis_v1.types.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 therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.redis_v1.types.Instance
A Google Cloud Redis instance.- Return type
google.api_core.operation.Operation
- classmethod from_service_account_file(filename: str, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_info(info: dict, *args, **kwargs)[source]¶
- Creates an instance of this client using the provided credentials
info.
- Parameters
info (dict) – The service account private key info.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- classmethod from_service_account_json(filename: str, *args, **kwargs)¶
- Creates an instance of this client using the provided credentials
file.
- Parameters
filename (str) – The path to the service account private key json file.
args – Additional arguments to pass to the constructor.
kwargs – Additional arguments to pass to the constructor.
- Returns
The constructed client.
- Return type
- get_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.GetInstanceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.redis_v1.types.cloud_redis.Instance [source]¶
Gets the details of a specific Redis instance.
- Parameters
request (google.cloud.redis_v1.types.GetInstanceRequest) – The request object. Request for [GetInstance][google.cloud.redis.v1.CloudRedis.GetInstance].
name (str) –
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.This corresponds to the
name
field on therequest
instance; ifrequest
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
A Google Cloud Redis instance.
- Return type
- import_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.ImportInstanceRequest] = None, *, name: Optional[str] = None, input_config: Optional[google.cloud.redis_v1.types.cloud_redis.InputConfig] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
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
request (google.cloud.redis_v1.types.ImportInstanceRequest) – The request object. Request for [Import][google.cloud.redis.v1.CloudRedis.ImportInstance].
name (str) –
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.This corresponds to the
name
field on therequest
instance; ifrequest
is provided, this should not be set.input_config (google.cloud.redis_v1.types.InputConfig) –
Required. Specify data to be imported.
This corresponds to the
input_config
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.redis_v1.types.Instance
A Google Cloud Redis instance.- Return type
google.api_core.operation.Operation
- static instance_path(project: str, location: str, instance: str) str [source]¶
Returns a fully-qualified instance string.
- list_instances(request: Optional[google.cloud.redis_v1.types.cloud_redis.ListInstancesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.cloud.redis_v1.services.cloud_redis.pagers.ListInstancesPager [source]¶
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
request (google.cloud.redis_v1.types.ListInstancesRequest) – The request object. Request for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].
parent (str) –
Required. The resource name of the instance location using the form:
projects/{project_id}/locations/{location_id}
wherelocation_id
refers to a GCP region.This corresponds to the
parent
field on therequest
instance; ifrequest
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
Response for [ListInstances][google.cloud.redis.v1.CloudRedis.ListInstances].
Iterating over this object will yield results and resolve additional pages automatically.
- Return type
google.cloud.redis_v1.services.cloud_redis.pagers.ListInstancesPager
- static parse_common_billing_account_path(path: str) Dict[str, str] [source]¶
Parse a billing_account path into its component segments.
- static parse_common_folder_path(path: str) Dict[str, str] [source]¶
Parse a folder path into its component segments.
- static parse_common_location_path(path: str) Dict[str, str] [source]¶
Parse a location path into its component segments.
- static parse_common_organization_path(path: str) Dict[str, str] [source]¶
Parse a organization path into its component segments.
- static parse_common_project_path(path: str) Dict[str, str] [source]¶
Parse a project path into its component segments.
- static parse_instance_path(path: str) Dict[str, str] [source]¶
Parses a instance path into its component segments.
- property transport: google.cloud.redis_v1.services.cloud_redis.transports.base.CloudRedisTransport¶
Returns the transport used by the client instance.
- Returns
- The transport used by the client
instance.
- Return type
CloudRedisTransport
- update_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.UpdateInstanceRequest] = None, *, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, instance: Optional[google.cloud.redis_v1.types.cloud_redis.Instance] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
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
request (google.cloud.redis_v1.types.UpdateInstanceRequest) – The request object. Request for [UpdateInstance][google.cloud.redis.v1.CloudRedis.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][google.cloud.redis.v1.Instance]:
displayName
labels
memorySizeGb
redisConfig
This corresponds to the
update_mask
field on therequest
instance; ifrequest
is provided, this should not be set.instance (google.cloud.redis_v1.types.Instance) –
Required. Update description. Only fields specified in update_mask are updated.
This corresponds to the
instance
field on therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.redis_v1.types.Instance
A Google Cloud Redis instance.- Return type
google.api_core.operation.Operation
- upgrade_instance(request: Optional[google.cloud.redis_v1.types.cloud_redis.UpgradeInstanceRequest] = None, *, name: Optional[str] = None, redis_version: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ()) google.api_core.operation.Operation [source]¶
Upgrades Redis instance to the newer Redis version specified in the request.
- Parameters
request (google.cloud.redis_v1.types.UpgradeInstanceRequest) – The request object. Request for [UpgradeInstance][google.cloud.redis.v1.CloudRedis.UpgradeInstance].
name (str) –
Required. Redis instance resource name using the form:
projects/{project_id}/locations/{location_id}/instances/{instance_id}
wherelocation_id
refers to a GCP region.This corresponds to the
name
field on therequest
instance; ifrequest
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 therequest
instance; ifrequest
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
An object representing a long-running operation.
The result type for the operation will be
google.cloud.redis_v1.types.Instance
A Google Cloud Redis instance.- Return type
google.api_core.operation.Operation
- class google.cloud.redis_v1.services.cloud_redis.pagers.ListInstancesAsyncPager(method: Callable[[...], Awaitable[google.cloud.redis_v1.types.cloud_redis.ListInstancesResponse]], request: google.cloud.redis_v1.types.cloud_redis.ListInstancesRequest, response: google.cloud.redis_v1.types.cloud_redis.ListInstancesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_instances
requests.This class thinly wraps an initial
google.cloud.redis_v1.types.ListInstancesResponse
object, and provides an__aiter__
method to iterate through itsinstances
field.If there are more pages, the
__aiter__
method will make additionalListInstances
requests and continue to iterate through theinstances
field on the corresponding responses.All the usual
google.cloud.redis_v1.types.ListInstancesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiates the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.redis_v1.types.ListInstancesRequest) – The initial request object.
response (google.cloud.redis_v1.types.ListInstancesResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.
- class google.cloud.redis_v1.services.cloud_redis.pagers.ListInstancesPager(method: Callable[[...], google.cloud.redis_v1.types.cloud_redis.ListInstancesResponse], request: google.cloud.redis_v1.types.cloud_redis.ListInstancesRequest, response: google.cloud.redis_v1.types.cloud_redis.ListInstancesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]¶
A pager for iterating through
list_instances
requests.This class thinly wraps an initial
google.cloud.redis_v1.types.ListInstancesResponse
object, and provides an__iter__
method to iterate through itsinstances
field.If there are more pages, the
__iter__
method will make additionalListInstances
requests and continue to iterate through theinstances
field on the corresponding responses.All the usual
google.cloud.redis_v1.types.ListInstancesResponse
attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.Instantiate the pager.
- Parameters
method (Callable) – The method that was originally called, and which instantiated this pager.
request (google.cloud.redis_v1.types.ListInstancesRequest) – The initial request object.
response (google.cloud.redis_v1.types.ListInstancesResponse) – The initial response object.
metadata (Sequence[Tuple[str, str]]) – Strings which should be sent along with the request as metadata.