Class AlloyDBAdminClient (0.4.0)

Service describing handlers for resources

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 alloy db admin client.

Releases underlying transport's resources.

Returns a fully-qualified backup string.

Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.

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

def sample_batch_create_instances():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    requests = alloydb_v1alpha.CreateInstanceRequests()
    requests.create_instance_requests.parent = "parent_value"
    requests.create_instance_requests.instance_id = "instance_id_value"
    requests.create_instance_requests.instance.instance_type = "SECONDARY"

    request = alloydb_v1alpha.BatchCreateInstancesRequest(
        parent="parent_value",
        requests=requests,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

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.

Returns a fully-qualified connection_info string.

Creates a new Backup 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 alloydb_v1alpha

def sample_create_backup():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    backup = alloydb_v1alpha.Backup()
    backup.cluster_name = "cluster_name_value"

    request = alloydb_v1alpha.CreateBackupRequest(
        parent="parent_value",
        backup_id="backup_id_value",
        backup=backup,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Creates a new Cluster 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 alloydb_v1alpha

def sample_create_cluster():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    cluster = alloydb_v1alpha.Cluster()
    cluster.backup_source.backup_name = "backup_name_value"
    cluster.network = "network_value"

    request = alloydb_v1alpha.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)

Creates a new 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 alloydb_v1alpha

def sample_create_instance():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    instance = alloydb_v1alpha.Instance()
    instance.instance_type = "SECONDARY"

    request = alloydb_v1alpha.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)

Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.

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

def sample_create_secondary_cluster():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    cluster = alloydb_v1alpha.Cluster()
    cluster.backup_source.backup_name = "backup_name_value"
    cluster.network = "network_value"

    request = alloydb_v1alpha.CreateSecondaryClusterRequest(
        parent="parent_value",
        cluster_id="cluster_id_value",
        cluster=cluster,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Creates a new SECONDARY 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 alloydb_v1alpha

def sample_create_secondary_instance():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    instance = alloydb_v1alpha.Instance()
    instance.instance_type = "SECONDARY"

    request = alloydb_v1alpha.CreateSecondaryInstanceRequest(
        parent="parent_value",
        instance_id="instance_id_value",
        instance=instance,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Creates a new User in a given project, location, and 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 alloydb_v1alpha

def sample_create_user():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.CreateUserRequest(
        parent="parent_value",
        user_id="user_id_value",
    )

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

    # Handle the response
    print(response)

Returns a fully-qualified crypto_key_version string.

Returns a fully-qualified database string.

Deletes a single Backup.

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

def sample_delete_backup():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.DeleteBackupRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Deletes a single 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 alloydb_v1alpha

def sample_delete_cluster():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.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 single 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 alloydb_v1alpha

def sample_delete_instance():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.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)

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.

Deletes a single User.

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

def sample_delete_user():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.DeleteUserRequest(
        name="name_value",
    )

    # Make the request
    client.delete_user(request=request)

Executes a SQL statement in a database inside an AlloyDB 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 alloydb_v1alpha

def sample_execute_sql():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.ExecuteSqlRequest(
        password="password_value",
        instance="instance_value",
        database="database_value",
        user="user_value",
        sql_statement="sql_statement_value",
    )

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

    # Handle the response
    print(response)

Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.

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

def sample_failover_instance():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.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)

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.

Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.

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

def sample_generate_client_certificate():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.GenerateClientCertificateRequest(
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Gets details of a single Backup.

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

def sample_get_backup():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.GetBackupRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Gets details of a single 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 alloydb_v1alpha

def sample_get_cluster():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

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

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

    # Handle the response
    print(response)

Get instance metadata used for a connection.

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

def sample_get_connection_info():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.GetConnectionInfoRequest(
        parent="parent_value",
    )

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

    # Handle the response
    print(response)

Gets details of a single 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 alloydb_v1alpha

def sample_get_instance():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

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

    # Make the request
    response = client.get_instance(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.

Gets details of a single User.

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

def sample_get_user():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.GetUserRequest(
        name="name_value",
    )

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

    # Handle the response
    print(response)

Injects fault in an instance. Imperative only.

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

def sample_inject_fault():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.InjectFaultRequest(
        fault_type="STOP_VM",
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Returns a fully-qualified instance string.

Lists Backups 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 alloydb_v1alpha

def sample_list_backups():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.ListBackupsRequest(
        parent="parent_value",
    )

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

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

Lists Clusters 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 alloydb_v1alpha

def sample_list_clusters():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.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 Databases 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 alloydb_v1alpha

def sample_list_databases():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.ListDatabasesRequest(
        parent="parent_value",
    )

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

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

Lists Instances 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 alloydb_v1alpha

def sample_list_instances():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

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

    # Make the request
    page_result = client.list_instances(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.

Lists SupportedDatabaseFlags for 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 alloydb_v1alpha

def sample_list_supported_database_flags():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.ListSupportedDatabaseFlagsRequest(
        parent="parent_value",
    )

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

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

Lists Users 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 alloydb_v1alpha

def sample_list_users():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.ListUsersRequest(
        parent="parent_value",
    )

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

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

Returns a fully-qualified network string.

Parses a backup path into its component segments.

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.

Parses a connection_info path into its component segments.

Parses a crypto_key_version path into its component segments.

Parses a database path into its component segments.

Parses a instance path into its component segments.

Parses a network path into its component segments.

Parses a supported_database_flag path into its component segments.

Parses a user path into its component segments.

Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.

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

def sample_promote_cluster():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.PromoteClusterRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Restart an Instance in a cluster. Imperative only.

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

def sample_restart_instance():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.RestartInstanceRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source 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 alloydb_v1alpha

def sample_restore_cluster():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    backup_source = alloydb_v1alpha.BackupSource()
    backup_source.backup_name = "backup_name_value"

    cluster = alloydb_v1alpha.Cluster()
    cluster.backup_source.backup_name = "backup_name_value"
    cluster.network = "network_value"

    request = alloydb_v1alpha.RestoreClusterRequest(
        backup_source=backup_source,
        parent="parent_value",
        cluster_id="cluster_id_value",
        cluster=cluster,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Returns a fully-qualified supported_database_flag string.

Switches the roles of PRIMARY and SECONDARY clusters without any data loss. This promotes the SECONDARY cluster to PRIMARY and sets up the original PRIMARY cluster to replicate from this newly promoted 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 alloydb_v1alpha

def sample_switchover_cluster():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.SwitchoverClusterRequest(
        name="name_value",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Updates the parameters of a single Backup.

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

def sample_update_backup():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    backup = alloydb_v1alpha.Backup()
    backup.cluster_name = "cluster_name_value"

    request = alloydb_v1alpha.UpdateBackupRequest(
        backup=backup,
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Updates the parameters of a single 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 alloydb_v1alpha

def sample_update_cluster():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    cluster = alloydb_v1alpha.Cluster()
    cluster.backup_source.backup_name = "backup_name_value"
    cluster.network = "network_value"

    request = alloydb_v1alpha.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)

Updates the parameters of a single 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 alloydb_v1alpha

def sample_update_instance():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    instance = alloydb_v1alpha.Instance()
    instance.instance_type = "SECONDARY"

    request = alloydb_v1alpha.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)

Updates the parameters of a single User.

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

def sample_update_user():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.UpdateUserRequest(
    )

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

    # Handle the response
    print(response)

Upgrades a single Cluster. Imperative only.

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

def sample_upgrade_cluster():
    # Create a client
    client = alloydb_v1alpha.AlloyDBAdminClient()

    # Initialize request argument(s)
    request = alloydb_v1alpha.UpgradeClusterRequest(
        name="name_value",
        version="POSTGRES_16",
    )

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

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

    response = operation.result()

    # Handle the response
    print(response)

Returns a fully-qualified user string.