Class CloudRedisClusterClient (0.1.4)

Configures and manages Cloud Memorystore for Redis clusters

Google Cloud Memorystore for Redis Cluster

The redis.googleapis.com service implements the Google Cloud Memorystore for Redis API and defines the following resource model for managing Redis clusters:

• 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 clusters, named: /clusters/*
• As such, Redis clusters are resources of the form: /projects/{project_id}/locations/{location_id}/clusters/{instance_id}

Note that location_id must be a GCP region; for example:

• projects/redpepper-1290/locations/us-central1/clusters/my-redis

We use API version selector for Flex APIs

• The versioning strategy is release-based versioning
• Our backend CLH only deals with the superset version (called v1main)
• Existing backend for Redis Gen1 and MRR is not touched.
• More details in go/redis-flex-api-versioning

Return the API endpoint used by the client instance.

Returns the transport used by the client instance.

Return the universe domain used by the client instance.

Instantiates the cloud redis cluster client.

Releases underlying transport's resources.

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Returns a fully-qualified cluster string.

Returns a fully-qualified billing_account string.

Returns a fully-qualified folder string.

Returns a fully-qualified location string.

Returns a fully-qualified organization string.

Returns a fully-qualified project string.

Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster 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_cluster_v1beta1

def sample_create_cluster():
    # Create a client
    client = redis_cluster_v1beta1.CloudRedisClusterClient()

    # Initialize request argument(s)
    cluster = redis_cluster_v1beta1.Cluster()
    cluster.name = "name_value"
    cluster.psc_configs.network = "network_value"

    request = redis_cluster_v1beta1.CreateClusterRequest(
        parent="parent_value",
        cluster_id="cluster_id_value",
        cluster=cluster,
    )

    # Make the request
    operation = client.create_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Deletes a specific Redis cluster. Cluster 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_cluster_v1beta1

def sample_delete_cluster():
    # Create a client
    client = redis_cluster_v1beta1.CloudRedisClusterClient()

    # Initialize request argument(s)
    request = redis_cluster_v1beta1.DeleteClusterRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)

Deletes a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Creates an instance of this client using the provided credentials file.

Creates an instance of this client using the provided credentials info.

Creates an instance of this client using the provided credentials file.

Gets the details of a specific Redis cluster.

# 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_cluster_v1beta1

def sample_get_cluster():
    # Create a client
    client = redis_cluster_v1beta1.CloudRedisClusterClient()

    # Initialize request argument(s)
    request = redis_cluster_v1beta1.GetClusterRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_cluster(request=request)

    # Handle the response
    print(response)

Gets information about a location.

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.

Gets the latest state of a long-running operation.

Lists all Redis clusters 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_cluster_v1beta1

def sample_list_clusters():
    # Create a client
    client = redis_cluster_v1beta1.CloudRedisClusterClient()

    # Initialize request argument(s)
    request = redis_cluster_v1beta1.ListClustersRequest(
        parent="parent_value",
    )

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

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

Lists information about the supported locations for this service.

Lists operations that match the specified filter in the request.

Parses a cluster path into its component segments.

Parse a billing_account path into its component segments.

Parse a folder path into its component segments.

Parse a location path into its component segments.

Parse a organization path into its component segments.

Parse a project path into its component segments.

Updates the metadata and configuration of a specific Redis cluster. Completed longrunning.Operation will contain the new cluster 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_cluster_v1beta1

def sample_update_cluster():
    # Create a client
    client = redis_cluster_v1beta1.CloudRedisClusterClient()

    # Initialize request argument(s)
    cluster = redis_cluster_v1beta1.Cluster()
    cluster.name = "name_value"
    cluster.psc_configs.network = "network_value"

    request = redis_cluster_v1beta1.UpdateClusterRequest(
        cluster=cluster,
    )

    # Make the request
    operation = client.update_cluster(request=request)

    print("Waiting for operation to complete...")

    response = operation.result()

    # Handle the response
    print(response)