As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

CloudRedis

class google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.redis_v1beta1.services.cloud_redis.transports.base.CloudRedisTransport, typing.Callable[[...], google.cloud.redis_v1beta1.services.cloud_redis.transports.base.CloudRedisTransport]]] = 'grpc_asyncio', client_options: typing.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

Instantiates the cloud redis async 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 (Optional[Union[str,CloudRedisTransport,Callable[..., CloudRedisTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the CloudRedisTransport constructor. If set to None, a transport is chosen automatically.

• client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

  Custom options for the client.

  1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

  2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

  3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

• 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.

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

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[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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

Creates a Redis instance based on the specified tier and memory size.

By default, the instance is accessible from the project’s default network.

The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. The completed longrunning.Operation will contain the new instance object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import redis_v1beta1

async def sample_create_instance():
    # Create a client
    client = redis_v1beta1.CloudRedisAsyncClient()

    # 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 = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.redis_v1beta1.types.CreateInstanceRequest, dict]]) – The request object. Request for [CreateInstance][google.cloud.redis.v1beta1.CloudRedis.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 (google.cloud.redis_v1beta1.types.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_async.AsyncRetry) – 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_v1beta1.types.Instance A Memorystore for Redis instance.

Return type

google.api_core.operation_async.AsyncOperation

async delete_instance(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.DeleteInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

Deletes a specific Redis instance. Instance stops serving and data is deleted.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import redis_v1beta1

async def sample_delete_instance():
    # Create a client
    client = redis_v1beta1.CloudRedisAsyncClient()

    # 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 = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.redis_v1beta1.types.DeleteInstanceRequest, dict]]) – The request object. Request for [DeleteInstance][google.cloud.redis.v1beta1.CloudRedis.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_async.AsyncRetry) – 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);

}

Return type

google.api_core.operation_async.AsyncOperation

async 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import redis_v1beta1

async def sample_export_instance():
    # Create a client
    client = redis_v1beta1.CloudRedisAsyncClient()

    # 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 = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.redis_v1beta1.types.ExportInstanceRequest, dict]]) – The request object. Request for [Export][google.cloud.redis.v1beta1.CloudRedis.ExportInstance].

• 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 (google.cloud.redis_v1beta1.types.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_async.AsyncRetry) – 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_v1beta1.types.Instance A Memorystore for Redis instance.

Return type

google.api_core.operation_async.AsyncOperation

async 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import redis_v1beta1

async def sample_failover_instance():
    # Create a client
    client = redis_v1beta1.CloudRedisAsyncClient()

    # 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 = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.redis_v1beta1.types.FailoverInstanceRequest, dict]]) – The request object. Request for [Failover][google.cloud.redis.v1beta1.CloudRedis.FailoverInstance].

• 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 (google.cloud.redis_v1beta1.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 the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry_async.AsyncRetry) – 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_v1beta1.types.Instance A Memorystore for Redis instance.

Return type

google.api_core.operation_async.AsyncOperation

classmethod from_service_account_file(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

CloudRedisAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)

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

CloudRedisAsyncClient

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

CloudRedisAsyncClient

async get_instance(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.GetInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.redis_v1beta1.types.cloud_redis.Instance

Gets the details of a specific Redis instance.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import redis_v1beta1

async def sample_get_instance():
    # Create a client
    client = redis_v1beta1.CloudRedisAsyncClient()

    # Initialize request argument(s)
    request = redis_v1beta1.GetInstanceRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_instance(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.redis_v1beta1.types.GetInstanceRequest, dict]]) – The request object. Request for [GetInstance][google.cloud.redis.v1beta1.CloudRedis.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_async.AsyncRetry) – 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 Memorystore for Redis instance.

Return type

google.cloud.redis_v1beta1.types.Instance

async get_instance_auth_string(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.GetInstanceAuthStringRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.redis_v1beta1.types.cloud_redis.InstanceAuthString

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import redis_v1beta1

async def sample_get_instance_auth_string():
    # Create a client
    client = redis_v1beta1.CloudRedisAsyncClient()

    # Initialize request argument(s)
    request = redis_v1beta1.GetInstanceAuthStringRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_instance_auth_string(request=request)

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.redis_v1beta1.types.GetInstanceAuthStringRequest, dict]]) – The request object. Request for [GetInstanceAuthString][google.cloud.redis.v1beta1.CloudRedis.GetInstanceAuthString].

• 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_async.AsyncRetry) – 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

Instance AUTH string details.

Return type

google.cloud.redis_v1beta1.types.InstanceAuthString

classmethod 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 variable 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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

classmethod get_transport_class(label: Optional[str] = None) → Type[google.cloud.redis_v1beta1.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[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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import redis_v1beta1

async def sample_import_instance():
    # Create a client
    client = redis_v1beta1.CloudRedisAsyncClient()

    # 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 = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.redis_v1beta1.types.ImportInstanceRequest, dict]]) – The request object. Request for [Import][google.cloud.redis.v1beta1.CloudRedis.ImportInstance].

• 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 (google.cloud.redis_v1beta1.types.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_async.AsyncRetry) – 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_v1beta1.types.Instance A Memorystore for 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[Union[google.cloud.redis_v1beta1.types.cloud_redis.ListInstancesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.redis_v1beta1.services.cloud_redis.pagers.ListInstancesAsyncPager

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import redis_v1beta1

async def sample_list_instances():
    # Create a client
    client = redis_v1beta1.CloudRedisAsyncClient()

    # Initialize request argument(s)
    request = redis_v1beta1.ListInstancesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_instances(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

• request (Optional[Union[google.cloud.redis_v1beta1.types.ListInstancesRequest, dict]]) – The request object. Request for [ListInstances][google.cloud.redis.v1beta1.CloudRedis.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_async.AsyncRetry) – 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.v1beta1.CloudRedis.ListInstances].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.redis_v1beta1.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.

async 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

Reschedule maintenance for a given instance in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import redis_v1beta1

async def sample_reschedule_maintenance():
    # Create a client
    client = redis_v1beta1.CloudRedisAsyncClient()

    # 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 = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.redis_v1beta1.types.RescheduleMaintenanceRequest, dict]]) – The request object. Request for [RescheduleMaintenance][google.cloud.redis.v1beta1.CloudRedis.RescheduleMaintenance].

• 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.

• reschedule_type (google.cloud.redis_v1beta1.types.RescheduleMaintenanceRequest.RescheduleType) –

  Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.

  This corresponds to the reschedule_type field on the request instance; if request is provided, this should not be set.

• 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 2012-11-15T16:19:00.094Z.

  This corresponds to the schedule_time field on the request instance; if request is provided, this should not be set.

• retry (google.api_core.retry_async.AsyncRetry) – 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_v1beta1.types.Instance A Memorystore for Redis instance.

Return type

google.api_core.operation_async.AsyncOperation

property transport: google.cloud.redis_v1beta1.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

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used

by the client instance.

Return type

str

async 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import redis_v1beta1

async def sample_update_instance():
    # Create a client
    client = redis_v1beta1.CloudRedisAsyncClient()

    # 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 = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.redis_v1beta1.types.UpdateInstanceRequest, dict]]) – The request object. Request for [UpdateInstance][google.cloud.redis.v1beta1.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.v1beta1.Instance]:

  • displayName

  • labels

  • memorySizeGb

  • redisConfig

  • replica_count

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• instance (google.cloud.redis_v1beta1.types.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_async.AsyncRetry) – 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_v1beta1.types.Instance A Memorystore for Redis instance.

Return type

google.api_core.operation_async.AsyncOperation

async 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: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation_async.AsyncOperation

Upgrades Redis instance to the newer Redis version specified in the request.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import redis_v1beta1

async def sample_upgrade_instance():
    # Create a client
    client = redis_v1beta1.CloudRedisAsyncClient()

    # 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 = (await operation).result()

    # Handle the response
    print(response)

Parameters

• request (Optional[Union[google.cloud.redis_v1beta1.types.UpgradeInstanceRequest, dict]]) – The request object. Request for [UpgradeInstance][google.cloud.redis.v1beta1.CloudRedis.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_async.AsyncRetry) – 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_v1beta1.types.Instance A Memorystore for Redis instance.

Return type

google.api_core.operation_async.AsyncOperation

class google.cloud.redis_v1beta1.services.cloud_redis.CloudRedisClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.redis_v1beta1.services.cloud_redis.transports.base.CloudRedisTransport, typing.Callable[[...], google.cloud.redis_v1beta1.services.cloud_redis.transports.base.CloudRedisTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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

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 (Optional[Union[str,CloudRedisTransport,Callable[..., CloudRedisTransport]]]) – The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the CloudRedisTransport constructor. If set to None, a transport is chosen automatically.

• client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]) –

  Custom options for the client.

  1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: “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).

  2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide a client certificate for mTLS 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.

  3. The universe_domain property can be used to override the default “googleapis.com” universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.

• 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.

__exit__(type, value, traceback)

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

property api_endpoint

Return the API endpoint used by the client instance.

Returns

The API endpoint used by the client instance.

Return type

str

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.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

Creates a Redis instance based on the specified tier and memory size.

By default, the instance is accessible from the project’s default network.

The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis instance will be fully functional. The completed longrunning.Operation will contain the new instance object in the response field.

The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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)

Parameters

• request (Union[google.cloud.redis_v1beta1.types.CreateInstanceRequest, dict]) – The request object. Request for [CreateInstance][google.cloud.redis.v1beta1.CloudRedis.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 (google.cloud.redis_v1beta1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.redis_v1beta1.types.Instance A Memorystore for Redis instance.

Return type

google.api_core.operation.Operation

delete_instance(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.DeleteInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

Deletes a specific Redis instance. Instance stops serving and data is deleted.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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)

Parameters

• request (Union[google.cloud.redis_v1beta1.types.DeleteInstanceRequest, dict]) – The request object. Request for [DeleteInstance][google.cloud.redis.v1beta1.CloudRedis.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

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);

}

Return type

google.api_core.operation.Operation

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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)

Parameters

• request (Union[google.cloud.redis_v1beta1.types.ExportInstanceRequest, dict]) – The request object. Request for [Export][google.cloud.redis.v1beta1.CloudRedis.ExportInstance].

• 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 (google.cloud.redis_v1beta1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.redis_v1beta1.types.Instance A Memorystore for Redis instance.

Return type

google.api_core.operation.Operation

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

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

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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)

Parameters

• request (Union[google.cloud.redis_v1beta1.types.FailoverInstanceRequest, dict]) – The request object. Request for [Failover][google.cloud.redis.v1beta1.CloudRedis.FailoverInstance].

• 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 (google.cloud.redis_v1beta1.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 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.redis_v1beta1.types.Instance A Memorystore for Redis instance.

Return type

google.api_core.operation.Operation

classmethod from_service_account_file(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

CloudRedisClient

classmethod from_service_account_info(info: dict, *args, **kwargs)

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

CloudRedisClient

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

CloudRedisClient

get_instance(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.GetInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.redis_v1beta1.types.cloud_redis.Instance

Gets the details of a specific Redis instance.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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)

Parameters

• request (Union[google.cloud.redis_v1beta1.types.GetInstanceRequest, dict]) – The request object. Request for [GetInstance][google.cloud.redis.v1beta1.CloudRedis.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

A Memorystore for Redis instance.

Return type

google.cloud.redis_v1beta1.types.Instance

get_instance_auth_string(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.GetInstanceAuthStringRequest, dict]] = None, *, name: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.redis_v1beta1.types.cloud_redis.InstanceAuthString

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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)

Parameters

• request (Union[google.cloud.redis_v1beta1.types.GetInstanceAuthStringRequest, dict]) – The request object. Request for [GetInstanceAuthString][google.cloud.redis.v1beta1.CloudRedis.GetInstanceAuthString].

• 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

Instance AUTH string details.

Return type

google.cloud.redis_v1beta1.types.InstanceAuthString

classmethod get_mtls_endpoint_and_cert_source(client_options: Optional[google.api_core.client_options.ClientOptions] = None)

Deprecated. 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 variable 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.

Parameters

client_options (google.api_core.client_options.ClientOptions) – Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Returns

returns the API endpoint and the

client cert source to use.

Return type

Tuple[str, Callable[[], Tuple[bytes, bytes]]]

Raises

google.auth.exceptions.MutualTLSChannelError – If any errors happen.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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)

Parameters

• request (Union[google.cloud.redis_v1beta1.types.ImportInstanceRequest, dict]) – The request object. Request for [Import][google.cloud.redis.v1beta1.CloudRedis.ImportInstance].

• 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 (google.cloud.redis_v1beta1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.redis_v1beta1.types.Instance A Memorystore for Redis instance.

Return type

google.api_core.operation.Operation

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

Returns a fully-qualified instance string.

list_instances(request: Optional[Union[google.cloud.redis_v1beta1.types.cloud_redis.ListInstancesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.cloud.redis_v1beta1.services.cloud_redis.pagers.ListInstancesPager

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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)

Parameters

• request (Union[google.cloud.redis_v1beta1.types.ListInstancesRequest, dict]) – The request object. Request for [ListInstances][google.cloud.redis.v1beta1.CloudRedis.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

Response for [ListInstances][google.cloud.redis.v1beta1.CloudRedis.ListInstances].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.redis_v1beta1.services.cloud_redis.pagers.ListInstancesPager

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.

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

Reschedule maintenance for a given instance in a given project and location.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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)

Parameters

• request (Union[google.cloud.redis_v1beta1.types.RescheduleMaintenanceRequest, dict]) – The request object. Request for [RescheduleMaintenance][google.cloud.redis.v1beta1.CloudRedis.RescheduleMaintenance].

• 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.

• reschedule_type (google.cloud.redis_v1beta1.types.RescheduleMaintenanceRequest.RescheduleType) –

  Required. If reschedule type is SPECIFIC_TIME, must set up schedule_time as well.

  This corresponds to the reschedule_type field on the request instance; if request is provided, this should not be set.

• 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 2012-11-15T16:19:00.094Z.

  This corresponds to the schedule_time 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.redis_v1beta1.types.Instance A Memorystore for Redis instance.

Return type

google.api_core.operation.Operation

property transport: google.cloud.redis_v1beta1.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

property universe_domain: str

Return the universe domain used by the client instance.

Returns

The universe domain used by the client instance.

Return type

str

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

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.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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)

Parameters

• request (Union[google.cloud.redis_v1beta1.types.UpdateInstanceRequest, dict]) – The request object. Request for [UpdateInstance][google.cloud.redis.v1beta1.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.v1beta1.Instance]:

  • displayName

  • labels

  • memorySizeGb

  • redisConfig

  • replica_count

  This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

• instance (google.cloud.redis_v1beta1.types.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.redis_v1beta1.types.Instance A Memorystore for Redis instance.

Return type

google.api_core.operation.Operation

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: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ()) → google.api_core.operation.Operation

Upgrades Redis instance to the newer Redis version specified in the request.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
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)

Parameters

• request (Union[google.cloud.redis_v1beta1.types.UpgradeInstanceRequest, dict]) – The request object. Request for [UpgradeInstance][google.cloud.redis.v1beta1.CloudRedis.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

An object representing a long-running operation.

The result type for the operation will be google.cloud.redis_v1beta1.types.Instance A Memorystore for Redis instance.

Return type

google.api_core.operation.Operation

class google.cloud.redis_v1beta1.services.cloud_redis.pagers.ListInstancesAsyncPager(method: Callable[[...], Awaitable[google.cloud.redis_v1beta1.types.cloud_redis.ListInstancesResponse]], request: google.cloud.redis_v1beta1.types.cloud_redis.ListInstancesRequest, response: google.cloud.redis_v1beta1.types.cloud_redis.ListInstancesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_instances requests.

This class thinly wraps an initial google.cloud.redis_v1beta1.types.ListInstancesResponse object, and provides an __aiter__ method to iterate through its instances field.

If there are more pages, the __aiter__ method will make additional ListInstances requests and continue to iterate through the instances field on the corresponding responses.

All the usual google.cloud.redis_v1beta1.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_v1beta1.types.ListInstancesRequest) – The initial request object.

• response (google.cloud.redis_v1beta1.types.ListInstancesResponse) – The initial response object.

• retry (google.api_core.retry.AsyncRetry) – 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.

class google.cloud.redis_v1beta1.services.cloud_redis.pagers.ListInstancesPager(method: Callable[[...], google.cloud.redis_v1beta1.types.cloud_redis.ListInstancesResponse], request: google.cloud.redis_v1beta1.types.cloud_redis.ListInstancesRequest, response: google.cloud.redis_v1beta1.types.cloud_redis.ListInstancesResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())

A pager for iterating through list_instances requests.

This class thinly wraps an initial google.cloud.redis_v1beta1.types.ListInstancesResponse object, and provides an __iter__ method to iterate through its instances field.

If there are more pages, the __iter__ method will make additional ListInstances requests and continue to iterate through the instances field on the corresponding responses.

All the usual google.cloud.redis_v1beta1.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_v1beta1.types.ListInstancesRequest) – The initial request object.

• response (google.cloud.redis_v1beta1.types.ListInstancesResponse) – The initial response object.

• 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.