Summary of entries of Methods for alloydb.
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient
AlloyDBAdminAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.alloydb_v1.services.alloy_db_admin.transports.base.AlloyDBAdminTransport, typing.Callable[[...], google.cloud.alloydb_v1.services.alloy_db_admin.transports.base.AlloyDBAdminTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the alloy db admin async client.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.backup_path
backup_path(project: str, location: str, backup: str) -> str
Returns a fully-qualified backup string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.backup_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.batch_create_instances
batch_create_instances(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.BatchCreateInstancesRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates new instances under the given project, location and cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.batch_create_instances
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.cancel_operation
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.cluster_path
cluster_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified cluster string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.cluster_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_billing_account_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_folder_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_location_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_organization_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_project_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.connection_info_path
connection_info_path(
project: str, location: str, cluster: str, instance: str
) -> str
Returns a fully-qualified connection_info string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.connection_info_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_backup
create_backup(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.CreateBackupRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
backup: typing.Optional[google.cloud.alloydb_v1.types.resources.Backup] = None,
backup_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Backup in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_backup
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_cluster
create_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.CreateClusterRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[google.cloud.alloydb_v1.types.resources.Cluster] = None,
cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Cluster in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.CreateInstanceRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[google.cloud.alloydb_v1.types.resources.Instance] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Instance in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_secondary_cluster
create_secondary_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.CreateSecondaryClusterRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[google.cloud.alloydb_v1.types.resources.Cluster] = None,
cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_secondary_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_secondary_instance
create_secondary_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.CreateSecondaryInstanceRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[google.cloud.alloydb_v1.types.resources.Instance] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new SECONDARY Instance in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_secondary_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_user
create_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.CreateUserRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
user: typing.Optional[google.cloud.alloydb_v1.types.resources.User] = None,
user_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.User
Creates a new User in a given project, location, and cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_user
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.crypto_key_version_path
crypto_key_version_path(
project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str
Returns a fully-qualified crypto_key_version string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.crypto_key_version_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.database_path
database_path(project: str, location: str, cluster: str, database: str) -> str
Returns a fully-qualified database string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.database_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_backup
delete_backup(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.DeleteBackupRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Backup.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_backup
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_cluster
delete_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.DeleteClusterRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.DeleteInstanceRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Instance.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_operation
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_user
delete_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.DeleteUserRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a single User.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_user
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.execute_sql
execute_sql(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.ExecuteSqlRequest, dict]
] = None,
*,
instance: typing.Optional[str] = None,
database: typing.Optional[str] = None,
user: typing.Optional[str] = None,
sql_statement: typing.Optional[str] = None,
password: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.service.ExecuteSqlResponse
Executes a SQL statement in a database inside an AlloyDB instance.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.execute_sql
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.failover_instance
failover_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.FailoverInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Forces a Failover for a highly available instance.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.failover_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.from_service_account_file
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.from_service_account_info
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.from_service_account_json
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.generate_client_certificate
generate_client_certificate(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.GenerateClientCertificateRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.service.GenerateClientCertificateResponse
Generate a client certificate signed by a Cluster CA.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.generate_client_certificate
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_backup
get_backup(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.GetBackupRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.Backup
Gets details of a single Backup.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_backup
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_cluster
get_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.GetClusterRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.Cluster
Gets details of a single Cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_connection_info
get_connection_info(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.GetConnectionInfoRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.ConnectionInfo
Get instance metadata used for a connection.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_connection_info
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.GetInstanceRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.Instance
Gets details of a single Instance.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_location
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_operation
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.alloydb_v1.services.alloy_db_admin.transports.base.AlloyDBAdminTransport
]
Returns an appropriate transport class.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_transport_class
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_user
get_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.GetUserRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.User
Gets details of a single User.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_user
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.inject_fault
inject_fault(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.InjectFaultRequest, dict]
] = None,
*,
fault_type: typing.Optional[
google.cloud.alloydb_v1.types.service.InjectFaultRequest.FaultType
] = None,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Injects fault in an instance.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.inject_fault
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.instance_path
instance_path(project: str, location: str, cluster: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.instance_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_backups
list_backups(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.ListBackupsRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListBackupsAsyncPager
Lists Backups in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_backups
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_clusters
list_clusters(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.ListClustersRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListClustersAsyncPager
Lists Clusters in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_clusters
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_databases
list_databases(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.ListDatabasesRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListDatabasesAsyncPager
Lists Databases in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_databases
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.ListInstancesRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListInstancesAsyncPager
Lists Instances in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_instances
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_locations
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_operations
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_supported_database_flags
list_supported_database_flags(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.ListSupportedDatabaseFlagsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsAsyncPager
)
Lists SupportedDatabaseFlags for a given project and location.
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_users
list_users(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.ListUsersRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListUsersAsyncPager
Lists Users in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_users
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.network_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_backup_path
parse_backup_path(path: str) -> typing.Dict[str, str]
Parses a backup path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_backup_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_cluster_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_folder_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_location_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_project_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_connection_info_path
parse_connection_info_path(path: str) -> typing.Dict[str, str]
Parses a connection_info path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_connection_info_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_crypto_key_version_path
parse_crypto_key_version_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key_version path into its component segments.
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_database_path
parse_database_path(path: str) -> typing.Dict[str, str]
Parses a database path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_database_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_instance_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_network_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_supported_database_flag_path
parse_supported_database_flag_path(path: str) -> typing.Dict[str, str]
Parses a supported_database_flag path into its component segments.
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_user_path
parse_user_path(path: str) -> typing.Dict[str, str]
Parses a user path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_user_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.promote_cluster
promote_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.PromoteClusterRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Promotes a SECONDARY cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.promote_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.restart_instance
restart_instance(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.RestartInstanceRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Restart an Instance in a cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.restart_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.restore_cluster
restore_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.RestoreClusterRequest, dict]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
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.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.restore_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.supported_database_flag_path
supported_database_flag_path(project: str, location: str, flag: str) -> str
Returns a fully-qualified supported_database_flag string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.supported_database_flag_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.switchover_cluster
switchover_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.SwitchoverClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Switches the roles of PRIMARY and SECONDARY clusters without any data loss.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.switchover_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_backup
update_backup(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.UpdateBackupRequest, dict]
] = None,
*,
backup: typing.Optional[google.cloud.alloydb_v1.types.resources.Backup] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Backup.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_backup
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_cluster
update_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.UpdateClusterRequest, dict]
] = None,
*,
cluster: typing.Optional[google.cloud.alloydb_v1.types.resources.Cluster] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_instance
update_instance(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.UpdateInstanceRequest, dict]
] = None,
*,
instance: typing.Optional[google.cloud.alloydb_v1.types.resources.Instance] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Instance.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_user
update_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.UpdateUserRequest, dict]
] = None,
*,
user: typing.Optional[google.cloud.alloydb_v1.types.resources.User] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.User
Updates the parameters of a single User.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_user
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.user_path
user_path(project: str, location: str, cluster: str, user: str) -> str
Returns a fully-qualified user string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminAsyncClient.user_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient
AlloyDBAdminClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.alloydb_v1.services.alloy_db_admin.transports.base.AlloyDBAdminTransport, typing.Callable[[...], google.cloud.alloydb_v1.services.alloy_db_admin.transports.base.AlloyDBAdminTransport]]] = 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 =
Instantiates the alloy db admin client.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.exit
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.backup_path
backup_path(project: str, location: str, backup: str) -> str
Returns a fully-qualified backup string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.backup_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.batch_create_instances
batch_create_instances(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.BatchCreateInstancesRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates new instances under the given project, location and cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.batch_create_instances
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.cancel_operation
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.cluster_path
cluster_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified cluster string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.cluster_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.common_billing_account_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.common_folder_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.common_location_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.common_organization_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.common_project_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.connection_info_path
connection_info_path(
project: str, location: str, cluster: str, instance: str
) -> str
Returns a fully-qualified connection_info string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.connection_info_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.create_backup
create_backup(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.CreateBackupRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
backup: typing.Optional[google.cloud.alloydb_v1.types.resources.Backup] = None,
backup_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new Backup in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.create_backup
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.create_cluster
create_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.CreateClusterRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[google.cloud.alloydb_v1.types.resources.Cluster] = None,
cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new Cluster in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.create_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.CreateInstanceRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[google.cloud.alloydb_v1.types.resources.Instance] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new Instance in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.create_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.create_secondary_cluster
create_secondary_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.CreateSecondaryClusterRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[google.cloud.alloydb_v1.types.resources.Cluster] = None,
cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.create_secondary_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.create_secondary_instance
create_secondary_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.CreateSecondaryInstanceRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[google.cloud.alloydb_v1.types.resources.Instance] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new SECONDARY Instance in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.create_secondary_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.create_user
create_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.CreateUserRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
user: typing.Optional[google.cloud.alloydb_v1.types.resources.User] = None,
user_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.User
Creates a new User in a given project, location, and cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.create_user
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.crypto_key_version_path
crypto_key_version_path(
project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str
Returns a fully-qualified crypto_key_version string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.crypto_key_version_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.database_path
database_path(project: str, location: str, cluster: str, database: str) -> str
Returns a fully-qualified database string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.database_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.delete_backup
delete_backup(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.DeleteBackupRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Deletes a single Backup.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.delete_backup
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.delete_cluster
delete_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.DeleteClusterRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Deletes a single Cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.delete_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.DeleteInstanceRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Deletes a single Instance.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.delete_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.delete_operation
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.delete_user
delete_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.DeleteUserRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a single User.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.delete_user
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.execute_sql
execute_sql(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.ExecuteSqlRequest, dict]
] = None,
*,
instance: typing.Optional[str] = None,
database: typing.Optional[str] = None,
user: typing.Optional[str] = None,
sql_statement: typing.Optional[str] = None,
password: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.service.ExecuteSqlResponse
Executes a SQL statement in a database inside an AlloyDB instance.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.execute_sql
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.failover_instance
failover_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.FailoverInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Forces a Failover for a highly available instance.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.failover_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_file
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_info
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_json
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.generate_client_certificate
generate_client_certificate(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.GenerateClientCertificateRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.service.GenerateClientCertificateResponse
Generate a client certificate signed by a Cluster CA.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.generate_client_certificate
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_backup
get_backup(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.GetBackupRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.Backup
Gets details of a single Backup.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_backup
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_cluster
get_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.GetClusterRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.Cluster
Gets details of a single Cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_connection_info
get_connection_info(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.GetConnectionInfoRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.ConnectionInfo
Get instance metadata used for a connection.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_connection_info
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.GetInstanceRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.Instance
Gets details of a single Instance.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_location
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_mtls_endpoint_and_cert_source
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_operation
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_user
get_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.GetUserRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.User
Gets details of a single User.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.get_user
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.inject_fault
inject_fault(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.InjectFaultRequest, dict]
] = None,
*,
fault_type: typing.Optional[
google.cloud.alloydb_v1.types.service.InjectFaultRequest.FaultType
] = None,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Injects fault in an instance.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.inject_fault
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.instance_path
instance_path(project: str, location: str, cluster: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.instance_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_backups
list_backups(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.ListBackupsRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListBackupsPager
Lists Backups in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_backups
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_clusters
list_clusters(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.ListClustersRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListClustersPager
Lists Clusters in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_clusters
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_databases
list_databases(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.ListDatabasesRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListDatabasesPager
Lists Databases in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_databases
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.ListInstancesRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListInstancesPager
Lists Instances in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_instances
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_locations
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_operations
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_supported_database_flags
list_supported_database_flags(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.ListSupportedDatabaseFlagsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsPager
)
Lists SupportedDatabaseFlags for a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_supported_database_flags
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_users
list_users(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.ListUsersRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListUsersPager
Lists Users in a given project and location.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.list_users
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.network_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_backup_path
parse_backup_path(path: str) -> typing.Dict[str, str]
Parses a backup path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_backup_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_cluster_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_common_billing_account_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_common_folder_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_common_location_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_common_organization_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_common_project_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_connection_info_path
parse_connection_info_path(path: str) -> typing.Dict[str, str]
Parses a connection_info path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_connection_info_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_crypto_key_version_path
parse_crypto_key_version_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key_version path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_crypto_key_version_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_database_path
parse_database_path(path: str) -> typing.Dict[str, str]
Parses a database path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_database_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_instance_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_network_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_supported_database_flag_path
parse_supported_database_flag_path(path: str) -> typing.Dict[str, str]
Parses a supported_database_flag path into its component segments.
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_user_path
parse_user_path(path: str) -> typing.Dict[str, str]
Parses a user path into its component segments.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.parse_user_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.promote_cluster
promote_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.PromoteClusterRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Promotes a SECONDARY cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.promote_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.restart_instance
restart_instance(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.RestartInstanceRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Restart an Instance in a cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.restart_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.restore_cluster
restore_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.RestoreClusterRequest, dict]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
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.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.restore_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.supported_database_flag_path
supported_database_flag_path(project: str, location: str, flag: str) -> str
Returns a fully-qualified supported_database_flag string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.supported_database_flag_path
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.switchover_cluster
switchover_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1.types.service.SwitchoverClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Switches the roles of PRIMARY and SECONDARY clusters without any data loss.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.switchover_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.update_backup
update_backup(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.UpdateBackupRequest, dict]
] = None,
*,
backup: typing.Optional[google.cloud.alloydb_v1.types.resources.Backup] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single Backup.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.update_backup
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.update_cluster
update_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.UpdateClusterRequest, dict]
] = None,
*,
cluster: typing.Optional[google.cloud.alloydb_v1.types.resources.Cluster] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single Cluster.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.update_cluster
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.update_instance
update_instance(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.UpdateInstanceRequest, dict]
] = None,
*,
instance: typing.Optional[google.cloud.alloydb_v1.types.resources.Instance] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single Instance.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.update_instance
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.update_user
update_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1.types.service.UpdateUserRequest, dict]
] = None,
*,
user: typing.Optional[google.cloud.alloydb_v1.types.resources.User] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1.types.resources.User
Updates the parameters of a single User.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.update_user
google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.user_path
user_path(project: str, location: str, cluster: str, user: str) -> str
Returns a fully-qualified user string.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.AlloyDBAdminClient.user_path
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListBackupsAsyncPager
ListBackupsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[google.cloud.alloydb_v1.types.service.ListBackupsResponse],
],
request: google.cloud.alloydb_v1.types.service.ListBackupsRequest,
response: google.cloud.alloydb_v1.types.service.ListBackupsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListBackupsAsyncPager
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListBackupsPager
ListBackupsPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1.types.service.ListBackupsResponse
],
request: google.cloud.alloydb_v1.types.service.ListBackupsRequest,
response: google.cloud.alloydb_v1.types.service.ListBackupsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListBackupsPager
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListClustersAsyncPager
ListClustersAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[google.cloud.alloydb_v1.types.service.ListClustersResponse],
],
request: google.cloud.alloydb_v1.types.service.ListClustersRequest,
response: google.cloud.alloydb_v1.types.service.ListClustersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListClustersAsyncPager
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListClustersPager
ListClustersPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1.types.service.ListClustersResponse
],
request: google.cloud.alloydb_v1.types.service.ListClustersRequest,
response: google.cloud.alloydb_v1.types.service.ListClustersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListClustersPager
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListDatabasesAsyncPager
ListDatabasesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[google.cloud.alloydb_v1.types.service.ListDatabasesResponse],
],
request: google.cloud.alloydb_v1.types.service.ListDatabasesRequest,
response: google.cloud.alloydb_v1.types.service.ListDatabasesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListDatabasesAsyncPager
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListDatabasesPager
ListDatabasesPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1.types.service.ListDatabasesResponse
],
request: google.cloud.alloydb_v1.types.service.ListDatabasesRequest,
response: google.cloud.alloydb_v1.types.service.ListDatabasesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListDatabasesPager
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListInstancesAsyncPager
ListInstancesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[google.cloud.alloydb_v1.types.service.ListInstancesResponse],
],
request: google.cloud.alloydb_v1.types.service.ListInstancesRequest,
response: google.cloud.alloydb_v1.types.service.ListInstancesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListInstancesAsyncPager
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListInstancesPager
ListInstancesPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1.types.service.ListInstancesResponse
],
request: google.cloud.alloydb_v1.types.service.ListInstancesRequest,
response: google.cloud.alloydb_v1.types.service.ListInstancesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListInstancesPager
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsAsyncPager
ListSupportedDatabaseFlagsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.alloydb_v1.types.service.ListSupportedDatabaseFlagsResponse
],
],
request: google.cloud.alloydb_v1.types.service.ListSupportedDatabaseFlagsRequest,
response: google.cloud.alloydb_v1.types.service.ListSupportedDatabaseFlagsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsAsyncPager
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsPager
ListSupportedDatabaseFlagsPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1.types.service.ListSupportedDatabaseFlagsResponse
],
request: google.cloud.alloydb_v1.types.service.ListSupportedDatabaseFlagsRequest,
response: google.cloud.alloydb_v1.types.service.ListSupportedDatabaseFlagsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsPager
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListUsersAsyncPager
ListUsersAsyncPager(
method: typing.Callable[
[...], typing.Awaitable[google.cloud.alloydb_v1.types.service.ListUsersResponse]
],
request: google.cloud.alloydb_v1.types.service.ListUsersRequest,
response: google.cloud.alloydb_v1.types.service.ListUsersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListUsersAsyncPager
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListUsersPager
ListUsersPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1.types.service.ListUsersResponse
],
request: google.cloud.alloydb_v1.types.service.ListUsersRequest,
response: google.cloud.alloydb_v1.types.service.ListUsersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListUsersPager
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient
AlloyDBAdminAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.alloydb_v1alpha.services.alloy_db_admin.transports.base.AlloyDBAdminTransport, typing.Callable[[...], google.cloud.alloydb_v1alpha.services.alloy_db_admin.transports.base.AlloyDBAdminTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the alloy db admin async client.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.backup_path
backup_path(project: str, location: str, backup: str) -> str
Returns a fully-qualified backup string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.backup_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.batch_create_instances
batch_create_instances(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.BatchCreateInstancesRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates new instances under the given project, location and cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.batch_create_instances
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.cancel_operation
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.cluster_path
cluster_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified cluster string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.cluster_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_folder_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_location_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_project_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.connection_info_path
connection_info_path(
project: str, location: str, cluster: str, instance: str
) -> str
Returns a fully-qualified connection_info string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.connection_info_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_backup
create_backup(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.CreateBackupRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
backup: typing.Optional[google.cloud.alloydb_v1alpha.types.resources.Backup] = None,
backup_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Backup in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_backup
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_cluster
create_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.CreateClusterRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.Cluster
] = None,
cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Cluster in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.CreateInstanceRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.Instance
] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Instance in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_instance
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_secondary_cluster
create_secondary_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.CreateSecondaryClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.Cluster
] = None,
cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_secondary_instance
create_secondary_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.CreateSecondaryInstanceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.Instance
] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new SECONDARY Instance in a given project and location.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_user
create_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.CreateUserRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
user: typing.Optional[google.cloud.alloydb_v1alpha.types.resources.User] = None,
user_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.User
Creates a new User in a given project, location, and cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_user
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.crypto_key_version_path
crypto_key_version_path(
project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str
Returns a fully-qualified crypto_key_version string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.crypto_key_version_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.database_path
database_path(project: str, location: str, cluster: str, database: str) -> str
Returns a fully-qualified database string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.database_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_backup
delete_backup(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.DeleteBackupRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Backup.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_backup
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_cluster
delete_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.DeleteClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.DeleteInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Instance.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_instance
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_operation
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_user
delete_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.DeleteUserRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a single User.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_user
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.execute_sql
execute_sql(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.ExecuteSqlRequest, dict]
] = None,
*,
instance: typing.Optional[str] = None,
database: typing.Optional[str] = None,
user: typing.Optional[str] = None,
sql_statement: typing.Optional[str] = None,
password: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.service.ExecuteSqlResponse
Executes a SQL statement in a database inside an AlloyDB instance.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.execute_sql
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.failover_instance
failover_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.FailoverInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Forces a Failover for a highly available instance.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.failover_instance
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.generate_client_certificate
generate_client_certificate(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.GenerateClientCertificateRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.service.GenerateClientCertificateResponse
Generate a client certificate signed by a Cluster CA.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_backup
get_backup(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.GetBackupRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.Backup
Gets details of a single Backup.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_backup
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_cluster
get_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.GetClusterRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.Cluster
Gets details of a single Cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_connection_info
get_connection_info(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.GetConnectionInfoRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.ConnectionInfo
Get instance metadata used for a connection.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_connection_info
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.GetInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.Instance
Gets details of a single Instance.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_instance
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_location
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_operation
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.alloydb_v1alpha.services.alloy_db_admin.transports.base.AlloyDBAdminTransport
]
Returns an appropriate transport class.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_transport_class
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_user
get_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.GetUserRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.User
Gets details of a single User.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_user
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.inject_fault
inject_fault(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.InjectFaultRequest, dict
]
] = None,
*,
fault_type: typing.Optional[
google.cloud.alloydb_v1alpha.types.service.InjectFaultRequest.FaultType
] = None,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Injects fault in an instance.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.inject_fault
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.instance_path
instance_path(project: str, location: str, cluster: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.instance_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_backups
list_backups(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.ListBackupsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListBackupsAsyncPager
Lists Backups in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_backups
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_clusters
list_clusters(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.ListClustersRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListClustersAsyncPager
Lists Clusters in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_clusters
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_databases
list_databases(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.ListDatabasesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListDatabasesAsyncPager
)
Lists Databases in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_databases
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.ListInstancesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListInstancesAsyncPager
)
Lists Instances in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_instances
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_locations
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_operations
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_supported_database_flags
list_supported_database_flags(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.ListSupportedDatabaseFlagsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsAsyncPager
)
Lists SupportedDatabaseFlags for a given project and location.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_users
list_users(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.ListUsersRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListUsersAsyncPager
Lists Users in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_users
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.network_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_backup_path
parse_backup_path(path: str) -> typing.Dict[str, str]
Parses a backup path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_backup_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_cluster_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_connection_info_path
parse_connection_info_path(path: str) -> typing.Dict[str, str]
Parses a connection_info path into its component segments.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_crypto_key_version_path
parse_crypto_key_version_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key_version path into its component segments.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_database_path
parse_database_path(path: str) -> typing.Dict[str, str]
Parses a database path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_database_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_instance_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_network_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_supported_database_flag_path
parse_supported_database_flag_path(path: str) -> typing.Dict[str, str]
Parses a supported_database_flag path into its component segments.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_user_path
parse_user_path(path: str) -> typing.Dict[str, str]
Parses a user path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_user_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.promote_cluster
promote_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.PromoteClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Promotes a SECONDARY cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.promote_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.restart_instance
restart_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.RestartInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Restart an Instance in a cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.restart_instance
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.restore_cluster
restore_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.RestoreClusterRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
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.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.restore_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.supported_database_flag_path
supported_database_flag_path(project: str, location: str, flag: str) -> str
Returns a fully-qualified supported_database_flag string.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.switchover_cluster
switchover_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.SwitchoverClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Switches the roles of PRIMARY and SECONDARY clusters without any data loss.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.switchover_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_backup
update_backup(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.UpdateBackupRequest, dict
]
] = None,
*,
backup: typing.Optional[google.cloud.alloydb_v1alpha.types.resources.Backup] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Backup.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_backup
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_cluster
update_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.UpdateClusterRequest, dict
]
] = None,
*,
cluster: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.Cluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_instance
update_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.UpdateInstanceRequest, dict
]
] = None,
*,
instance: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.Instance
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Instance.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_instance
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_user
update_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.UpdateUserRequest, dict]
] = None,
*,
user: typing.Optional[google.cloud.alloydb_v1alpha.types.resources.User] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.User
Updates the parameters of a single User.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_user
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.upgrade_cluster
upgrade_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.UpgradeClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
version: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.DatabaseVersion
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Upgrades a single Cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.upgrade_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.user_path
user_path(project: str, location: str, cluster: str, user: str) -> str
Returns a fully-qualified user string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminAsyncClient.user_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient
AlloyDBAdminClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.alloydb_v1alpha.services.alloy_db_admin.transports.base.AlloyDBAdminTransport, typing.Callable[[...], google.cloud.alloydb_v1alpha.services.alloy_db_admin.transports.base.AlloyDBAdminTransport]]] = 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 =
Instantiates the alloy db admin client.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.exit
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.backup_path
backup_path(project: str, location: str, backup: str) -> str
Returns a fully-qualified backup string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.backup_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.batch_create_instances
batch_create_instances(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.BatchCreateInstancesRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates new instances under the given project, location and cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.batch_create_instances
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.cancel_operation
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.cluster_path
cluster_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified cluster string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.cluster_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.common_billing_account_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.common_folder_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.common_location_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.common_organization_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.common_project_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.connection_info_path
connection_info_path(
project: str, location: str, cluster: str, instance: str
) -> str
Returns a fully-qualified connection_info string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.connection_info_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.create_backup
create_backup(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.CreateBackupRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
backup: typing.Optional[google.cloud.alloydb_v1alpha.types.resources.Backup] = None,
backup_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new Backup in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.create_backup
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.create_cluster
create_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.CreateClusterRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.Cluster
] = None,
cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new Cluster in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.create_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.CreateInstanceRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.Instance
] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new Instance in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.create_instance
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.create_secondary_cluster
create_secondary_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.CreateSecondaryClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.Cluster
] = None,
cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.create_secondary_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.create_secondary_instance
create_secondary_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.CreateSecondaryInstanceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.Instance
] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new SECONDARY Instance in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.create_secondary_instance
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.create_user
create_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.CreateUserRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
user: typing.Optional[google.cloud.alloydb_v1alpha.types.resources.User] = None,
user_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.User
Creates a new User in a given project, location, and cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.create_user
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.crypto_key_version_path
crypto_key_version_path(
project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str
Returns a fully-qualified crypto_key_version string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.crypto_key_version_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.database_path
database_path(project: str, location: str, cluster: str, database: str) -> str
Returns a fully-qualified database string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.database_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.delete_backup
delete_backup(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.DeleteBackupRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Deletes a single Backup.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.delete_backup
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.delete_cluster
delete_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.DeleteClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Deletes a single Cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.delete_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.DeleteInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Deletes a single Instance.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.delete_instance
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.delete_operation
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.delete_user
delete_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.DeleteUserRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a single User.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.delete_user
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.execute_sql
execute_sql(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.ExecuteSqlRequest, dict]
] = None,
*,
instance: typing.Optional[str] = None,
database: typing.Optional[str] = None,
user: typing.Optional[str] = None,
sql_statement: typing.Optional[str] = None,
password: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.service.ExecuteSqlResponse
Executes a SQL statement in a database inside an AlloyDB instance.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.execute_sql
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.failover_instance
failover_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.FailoverInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Forces a Failover for a highly available instance.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.failover_instance
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_file
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_info
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_json
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.generate_client_certificate
generate_client_certificate(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.GenerateClientCertificateRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.service.GenerateClientCertificateResponse
Generate a client certificate signed by a Cluster CA.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.generate_client_certificate
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_backup
get_backup(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.GetBackupRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.Backup
Gets details of a single Backup.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_backup
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_cluster
get_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.GetClusterRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.Cluster
Gets details of a single Cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_connection_info
get_connection_info(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.GetConnectionInfoRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.ConnectionInfo
Get instance metadata used for a connection.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_connection_info
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.GetInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.Instance
Gets details of a single Instance.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_instance
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_location
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_operation
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_user
get_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.GetUserRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.User
Gets details of a single User.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.get_user
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.inject_fault
inject_fault(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.InjectFaultRequest, dict
]
] = None,
*,
fault_type: typing.Optional[
google.cloud.alloydb_v1alpha.types.service.InjectFaultRequest.FaultType
] = None,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Injects fault in an instance.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.inject_fault
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.instance_path
instance_path(project: str, location: str, cluster: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.instance_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_backups
list_backups(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.ListBackupsRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListBackupsPager
Lists Backups in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_backups
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_clusters
list_clusters(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.ListClustersRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListClustersPager
Lists Clusters in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_clusters
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_databases
list_databases(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.ListDatabasesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListDatabasesPager
Lists Databases in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_databases
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.ListInstancesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListInstancesPager
Lists Instances in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_instances
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_locations
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_operations
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_supported_database_flags
list_supported_database_flags(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.ListSupportedDatabaseFlagsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsPager
)
Lists SupportedDatabaseFlags for a given project and location.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_users
list_users(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.ListUsersRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListUsersPager
Lists Users in a given project and location.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.list_users
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.network_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_backup_path
parse_backup_path(path: str) -> typing.Dict[str, str]
Parses a backup path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_backup_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_cluster_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_common_folder_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_common_location_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_common_project_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_connection_info_path
parse_connection_info_path(path: str) -> typing.Dict[str, str]
Parses a connection_info path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_connection_info_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_crypto_key_version_path
parse_crypto_key_version_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key_version path into its component segments.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_database_path
parse_database_path(path: str) -> typing.Dict[str, str]
Parses a database path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_database_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_instance_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_network_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_supported_database_flag_path
parse_supported_database_flag_path(path: str) -> typing.Dict[str, str]
Parses a supported_database_flag path into its component segments.
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_user_path
parse_user_path(path: str) -> typing.Dict[str, str]
Parses a user path into its component segments.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.parse_user_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.promote_cluster
promote_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.PromoteClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Promotes a SECONDARY cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.promote_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.restart_instance
restart_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.RestartInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Restart an Instance in a cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.restart_instance
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.restore_cluster
restore_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.RestoreClusterRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
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.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.restore_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.supported_database_flag_path
supported_database_flag_path(project: str, location: str, flag: str) -> str
Returns a fully-qualified supported_database_flag string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.supported_database_flag_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.switchover_cluster
switchover_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.SwitchoverClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Switches the roles of PRIMARY and SECONDARY clusters without any data loss.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.switchover_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.update_backup
update_backup(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.UpdateBackupRequest, dict
]
] = None,
*,
backup: typing.Optional[google.cloud.alloydb_v1alpha.types.resources.Backup] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single Backup.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.update_backup
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.update_cluster
update_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.UpdateClusterRequest, dict
]
] = None,
*,
cluster: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.Cluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single Cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.update_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.update_instance
update_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.UpdateInstanceRequest, dict
]
] = None,
*,
instance: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.Instance
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single Instance.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.update_instance
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.update_user
update_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1alpha.types.service.UpdateUserRequest, dict]
] = None,
*,
user: typing.Optional[google.cloud.alloydb_v1alpha.types.resources.User] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1alpha.types.resources.User
Updates the parameters of a single User.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.update_user
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.upgrade_cluster
upgrade_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1alpha.types.service.UpgradeClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
version: typing.Optional[
google.cloud.alloydb_v1alpha.types.resources.DatabaseVersion
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Upgrades a single Cluster.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.upgrade_cluster
google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.user_path
user_path(project: str, location: str, cluster: str, user: str) -> str
Returns a fully-qualified user string.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.AlloyDBAdminClient.user_path
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListBackupsAsyncPager
ListBackupsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.alloydb_v1alpha.types.service.ListBackupsResponse
],
],
request: google.cloud.alloydb_v1alpha.types.service.ListBackupsRequest,
response: google.cloud.alloydb_v1alpha.types.service.ListBackupsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListBackupsAsyncPager
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListBackupsPager
ListBackupsPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1alpha.types.service.ListBackupsResponse
],
request: google.cloud.alloydb_v1alpha.types.service.ListBackupsRequest,
response: google.cloud.alloydb_v1alpha.types.service.ListBackupsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListBackupsPager
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListClustersAsyncPager
ListClustersAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.alloydb_v1alpha.types.service.ListClustersResponse
],
],
request: google.cloud.alloydb_v1alpha.types.service.ListClustersRequest,
response: google.cloud.alloydb_v1alpha.types.service.ListClustersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListClustersAsyncPager
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListClustersPager
ListClustersPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1alpha.types.service.ListClustersResponse
],
request: google.cloud.alloydb_v1alpha.types.service.ListClustersRequest,
response: google.cloud.alloydb_v1alpha.types.service.ListClustersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListClustersPager
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListDatabasesAsyncPager
ListDatabasesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.alloydb_v1alpha.types.service.ListDatabasesResponse
],
],
request: google.cloud.alloydb_v1alpha.types.service.ListDatabasesRequest,
response: google.cloud.alloydb_v1alpha.types.service.ListDatabasesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListDatabasesAsyncPager
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListDatabasesPager
ListDatabasesPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1alpha.types.service.ListDatabasesResponse
],
request: google.cloud.alloydb_v1alpha.types.service.ListDatabasesRequest,
response: google.cloud.alloydb_v1alpha.types.service.ListDatabasesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListDatabasesPager
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListInstancesAsyncPager
ListInstancesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.alloydb_v1alpha.types.service.ListInstancesResponse
],
],
request: google.cloud.alloydb_v1alpha.types.service.ListInstancesRequest,
response: google.cloud.alloydb_v1alpha.types.service.ListInstancesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListInstancesAsyncPager
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListInstancesPager
ListInstancesPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1alpha.types.service.ListInstancesResponse
],
request: google.cloud.alloydb_v1alpha.types.service.ListInstancesRequest,
response: google.cloud.alloydb_v1alpha.types.service.ListInstancesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListInstancesPager
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsAsyncPager
ListSupportedDatabaseFlagsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.alloydb_v1alpha.types.service.ListSupportedDatabaseFlagsResponse
],
],
request: google.cloud.alloydb_v1alpha.types.service.ListSupportedDatabaseFlagsRequest,
response: google.cloud.alloydb_v1alpha.types.service.ListSupportedDatabaseFlagsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsAsyncPager
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsPager
ListSupportedDatabaseFlagsPager(
method: typing.Callable[
[...],
google.cloud.alloydb_v1alpha.types.service.ListSupportedDatabaseFlagsResponse,
],
request: google.cloud.alloydb_v1alpha.types.service.ListSupportedDatabaseFlagsRequest,
response: google.cloud.alloydb_v1alpha.types.service.ListSupportedDatabaseFlagsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsPager
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListUsersAsyncPager
ListUsersAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[google.cloud.alloydb_v1alpha.types.service.ListUsersResponse],
],
request: google.cloud.alloydb_v1alpha.types.service.ListUsersRequest,
response: google.cloud.alloydb_v1alpha.types.service.ListUsersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListUsersAsyncPager
google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListUsersPager
ListUsersPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1alpha.types.service.ListUsersResponse
],
request: google.cloud.alloydb_v1alpha.types.service.ListUsersRequest,
response: google.cloud.alloydb_v1alpha.types.service.ListUsersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1alpha.services.alloy_db_admin.pagers.ListUsersPager
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient
AlloyDBAdminAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.alloydb_v1beta.services.alloy_db_admin.transports.base.AlloyDBAdminTransport, typing.Callable[[...], google.cloud.alloydb_v1beta.services.alloy_db_admin.transports.base.AlloyDBAdminTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo =
Instantiates the alloy db admin async client.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.backup_path
backup_path(project: str, location: str, backup: str) -> str
Returns a fully-qualified backup string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.backup_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.batch_create_instances
batch_create_instances(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.BatchCreateInstancesRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates new instances under the given project, location and cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.batch_create_instances
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.cancel_operation
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.cluster_path
cluster_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified cluster string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.cluster_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_folder_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_location_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_organization_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.common_project_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.connection_info_path
connection_info_path(
project: str, location: str, cluster: str, instance: str
) -> str
Returns a fully-qualified connection_info string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.connection_info_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_backup
create_backup(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.CreateBackupRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
backup: typing.Optional[google.cloud.alloydb_v1beta.types.resources.Backup] = None,
backup_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Backup in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_backup
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_cluster
create_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.CreateClusterRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.Cluster
] = None,
cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Cluster in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.CreateInstanceRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.Instance
] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new Instance in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_instance
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_secondary_cluster
create_secondary_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.CreateSecondaryClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.Cluster
] = None,
cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_secondary_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_secondary_instance
create_secondary_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.CreateSecondaryInstanceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.Instance
] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Creates a new SECONDARY Instance in a given project and location.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_user
create_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.CreateUserRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
user: typing.Optional[google.cloud.alloydb_v1beta.types.resources.User] = None,
user_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.User
Creates a new User in a given project, location, and cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.create_user
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.crypto_key_version_path
crypto_key_version_path(
project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str
Returns a fully-qualified crypto_key_version string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.crypto_key_version_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.database_path
database_path(project: str, location: str, cluster: str, database: str) -> str
Returns a fully-qualified database string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.database_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_backup
delete_backup(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.DeleteBackupRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Backup.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_backup
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_cluster
delete_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.DeleteClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.DeleteInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Deletes a single Instance.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_instance
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_operation
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_user
delete_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.DeleteUserRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a single User.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.delete_user
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.execute_sql
execute_sql(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.ExecuteSqlRequest, dict]
] = None,
*,
instance: typing.Optional[str] = None,
database: typing.Optional[str] = None,
user: typing.Optional[str] = None,
sql_statement: typing.Optional[str] = None,
password: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.service.ExecuteSqlResponse
Executes a SQL statement in a database inside an AlloyDB instance.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.execute_sql
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.failover_instance
failover_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.FailoverInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Forces a Failover for a highly available instance.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.failover_instance
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.generate_client_certificate
generate_client_certificate(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.GenerateClientCertificateRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.service.GenerateClientCertificateResponse
Generate a client certificate signed by a Cluster CA.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_backup
get_backup(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.GetBackupRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.Backup
Gets details of a single Backup.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_backup
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_cluster
get_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.GetClusterRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.Cluster
Gets details of a single Cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_connection_info
get_connection_info(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.GetConnectionInfoRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.ConnectionInfo
Get instance metadata used for a connection.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_connection_info
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.GetInstanceRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.Instance
Gets details of a single Instance.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_instance
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_location
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Return the API endpoint and client cert source for mutual TLS.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_operation
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_transport_class
get_transport_class(
label: typing.Optional[str] = None,
) -> typing.Type[
google.cloud.alloydb_v1beta.services.alloy_db_admin.transports.base.AlloyDBAdminTransport
]
Returns an appropriate transport class.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_transport_class
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_user
get_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.GetUserRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.User
Gets details of a single User.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.get_user
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.inject_fault
inject_fault(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.InjectFaultRequest, dict]
] = None,
*,
fault_type: typing.Optional[
google.cloud.alloydb_v1beta.types.service.InjectFaultRequest.FaultType
] = None,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Injects fault in an instance.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.inject_fault
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.instance_path
instance_path(project: str, location: str, cluster: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.instance_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_backups
list_backups(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.ListBackupsRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListBackupsAsyncPager
Lists Backups in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_backups
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_clusters
list_clusters(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.ListClustersRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListClustersAsyncPager
Lists Clusters in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_clusters
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_databases
list_databases(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.ListDatabasesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListDatabasesAsyncPager
Lists Databases in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_databases
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.ListInstancesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListInstancesAsyncPager
Lists Instances in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_instances
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_locations
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_operations
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_supported_database_flags
list_supported_database_flags(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.ListSupportedDatabaseFlagsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsAsyncPager
)
Lists SupportedDatabaseFlags for a given project and location.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_users
list_users(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.ListUsersRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListUsersAsyncPager
Lists Users in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.list_users
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.network_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_backup_path
parse_backup_path(path: str) -> typing.Dict[str, str]
Parses a backup path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_backup_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_cluster_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_folder_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_connection_info_path
parse_connection_info_path(path: str) -> typing.Dict[str, str]
Parses a connection_info path into its component segments.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_crypto_key_version_path
parse_crypto_key_version_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key_version path into its component segments.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_database_path
parse_database_path(path: str) -> typing.Dict[str, str]
Parses a database path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_database_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_instance_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_network_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_supported_database_flag_path
parse_supported_database_flag_path(path: str) -> typing.Dict[str, str]
Parses a supported_database_flag path into its component segments.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_user_path
parse_user_path(path: str) -> typing.Dict[str, str]
Parses a user path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.parse_user_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.promote_cluster
promote_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.PromoteClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Promotes a SECONDARY cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.promote_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.restart_instance
restart_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.RestartInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Restart an Instance in a cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.restart_instance
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.restore_cluster
restore_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.RestoreClusterRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
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.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.restore_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.supported_database_flag_path
supported_database_flag_path(project: str, location: str, flag: str) -> str
Returns a fully-qualified supported_database_flag string.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.switchover_cluster
switchover_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.SwitchoverClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Switches the roles of PRIMARY and SECONDARY clusters without any data loss.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.switchover_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_backup
update_backup(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.UpdateBackupRequest, dict
]
] = None,
*,
backup: typing.Optional[google.cloud.alloydb_v1beta.types.resources.Backup] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Backup.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_backup
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_cluster
update_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.UpdateClusterRequest, dict
]
] = None,
*,
cluster: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.Cluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_instance
update_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.UpdateInstanceRequest, dict
]
] = None,
*,
instance: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.Instance
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Updates the parameters of a single Instance.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_instance
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_user
update_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.UpdateUserRequest, dict]
] = None,
*,
user: typing.Optional[google.cloud.alloydb_v1beta.types.resources.User] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.User
Updates the parameters of a single User.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.update_user
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.upgrade_cluster
upgrade_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.UpgradeClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
version: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.DatabaseVersion
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation
Upgrades a single Cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.upgrade_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.user_path
user_path(project: str, location: str, cluster: str, user: str) -> str
Returns a fully-qualified user string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminAsyncClient.user_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient
AlloyDBAdminClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.alloydb_v1beta.services.alloy_db_admin.transports.base.AlloyDBAdminTransport, typing.Callable[[...], google.cloud.alloydb_v1beta.services.alloy_db_admin.transports.base.AlloyDBAdminTransport]]] = 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 =
Instantiates the alloy db admin client.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.exit
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.backup_path
backup_path(project: str, location: str, backup: str) -> str
Returns a fully-qualified backup string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.backup_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.batch_create_instances
batch_create_instances(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.BatchCreateInstancesRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates new instances under the given project, location and cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.batch_create_instances
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.cancel_operation
cancel_operation(
request: typing.Optional[
google.longrunning.operations_pb2.CancelOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Starts asynchronous cancellation on a long-running operation.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.cancel_operation
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.cluster_path
cluster_path(project: str, location: str, cluster: str) -> str
Returns a fully-qualified cluster string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.cluster_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.common_billing_account_path
common_billing_account_path(billing_account: str) -> str
Returns a fully-qualified billing_account string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.common_billing_account_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.common_folder_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.common_location_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.common_organization_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.common_project_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.connection_info_path
connection_info_path(
project: str, location: str, cluster: str, instance: str
) -> str
Returns a fully-qualified connection_info string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.connection_info_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.create_backup
create_backup(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.CreateBackupRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
backup: typing.Optional[google.cloud.alloydb_v1beta.types.resources.Backup] = None,
backup_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new Backup in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.create_backup
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.create_cluster
create_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.CreateClusterRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.Cluster
] = None,
cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new Cluster in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.create_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.create_instance
create_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.CreateInstanceRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.Instance
] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new Instance in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.create_instance
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.create_secondary_cluster
create_secondary_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.CreateSecondaryClusterRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
cluster: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.Cluster
] = None,
cluster_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.create_secondary_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.create_secondary_instance
create_secondary_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.CreateSecondaryInstanceRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
instance: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.Instance
] = None,
instance_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Creates a new SECONDARY Instance in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.create_secondary_instance
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.create_user
create_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.CreateUserRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
user: typing.Optional[google.cloud.alloydb_v1beta.types.resources.User] = None,
user_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.User
Creates a new User in a given project, location, and cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.create_user
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.crypto_key_version_path
crypto_key_version_path(
project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
) -> str
Returns a fully-qualified crypto_key_version string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.crypto_key_version_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.database_path
database_path(project: str, location: str, cluster: str, database: str) -> str
Returns a fully-qualified database string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.database_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.delete_backup
delete_backup(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.DeleteBackupRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Deletes a single Backup.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.delete_backup
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.delete_cluster
delete_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.DeleteClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Deletes a single Cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.delete_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.delete_instance
delete_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.DeleteInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Deletes a single Instance.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.delete_instance
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.delete_operation
delete_operation(
request: typing.Optional[
google.longrunning.operations_pb2.DeleteOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a long-running operation.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.delete_operation
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.delete_user
delete_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.DeleteUserRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> None
Deletes a single User.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.delete_user
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.execute_sql
execute_sql(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.ExecuteSqlRequest, dict]
] = None,
*,
instance: typing.Optional[str] = None,
database: typing.Optional[str] = None,
user: typing.Optional[str] = None,
sql_statement: typing.Optional[str] = None,
password: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.service.ExecuteSqlResponse
Executes a SQL statement in a database inside an AlloyDB instance.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.execute_sql
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.failover_instance
failover_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.FailoverInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Forces a Failover for a highly available instance.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.failover_instance
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_file
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_info
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.from_service_account_json
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.generate_client_certificate
generate_client_certificate(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.GenerateClientCertificateRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.service.GenerateClientCertificateResponse
Generate a client certificate signed by a Cluster CA.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.generate_client_certificate
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_backup
get_backup(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.GetBackupRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.Backup
Gets details of a single Backup.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_backup
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_cluster
get_cluster(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.GetClusterRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.Cluster
Gets details of a single Cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_connection_info
get_connection_info(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.GetConnectionInfoRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.ConnectionInfo
Get instance metadata used for a connection.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_connection_info
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_instance
get_instance(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.GetInstanceRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.Instance
Gets details of a single Instance.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_instance
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_location
get_location(
request: typing.Optional[
google.cloud.location.locations_pb2.GetLocationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.Location
Gets information about a location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_location
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_operation
get_operation(
request: typing.Optional[
google.longrunning.operations_pb2.GetOperationRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation
Gets the latest state of a long-running operation.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_operation
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_user
get_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.GetUserRequest, dict]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.User
Gets details of a single User.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.get_user
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.inject_fault
inject_fault(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.InjectFaultRequest, dict]
] = None,
*,
fault_type: typing.Optional[
google.cloud.alloydb_v1beta.types.service.InjectFaultRequest.FaultType
] = None,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Injects fault in an instance.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.inject_fault
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.instance_path
instance_path(project: str, location: str, cluster: str, instance: str) -> str
Returns a fully-qualified instance string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.instance_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_backups
list_backups(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.ListBackupsRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListBackupsPager
Lists Backups in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_backups
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_clusters
list_clusters(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.ListClustersRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListClustersPager
Lists Clusters in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_clusters
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_databases
list_databases(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.ListDatabasesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListDatabasesPager
Lists Databases in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_databases
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_instances
list_instances(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.ListInstancesRequest, dict
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListInstancesPager
Lists Instances in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_instances
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_locations
list_locations(
request: typing.Optional[
google.cloud.location.locations_pb2.ListLocationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.location.locations_pb2.ListLocationsResponse
Lists information about the supported locations for this service.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_locations
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_operations
list_operations(
request: typing.Optional[
google.longrunning.operations_pb2.ListOperationsRequest
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.ListOperationsResponse
Lists operations that match the specified filter in the request.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_operations
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_supported_database_flags
list_supported_database_flags(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.ListSupportedDatabaseFlagsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsPager
)
Lists SupportedDatabaseFlags for a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_supported_database_flags
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_users
list_users(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.ListUsersRequest, dict]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListUsersPager
Lists Users in a given project and location.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.list_users
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.network_path
network_path(project: str, network: str) -> str
Returns a fully-qualified network string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.network_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_backup_path
parse_backup_path(path: str) -> typing.Dict[str, str]
Parses a backup path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_backup_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_cluster_path
parse_cluster_path(path: str) -> typing.Dict[str, str]
Parses a cluster path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_cluster_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_common_folder_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_common_location_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_common_project_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_connection_info_path
parse_connection_info_path(path: str) -> typing.Dict[str, str]
Parses a connection_info path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_connection_info_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_crypto_key_version_path
parse_crypto_key_version_path(path: str) -> typing.Dict[str, str]
Parses a crypto_key_version path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_crypto_key_version_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_database_path
parse_database_path(path: str) -> typing.Dict[str, str]
Parses a database path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_database_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_instance_path
parse_instance_path(path: str) -> typing.Dict[str, str]
Parses a instance path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_instance_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_network_path
parse_network_path(path: str) -> typing.Dict[str, str]
Parses a network path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_network_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_supported_database_flag_path
parse_supported_database_flag_path(path: str) -> typing.Dict[str, str]
Parses a supported_database_flag path into its component segments.
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_user_path
parse_user_path(path: str) -> typing.Dict[str, str]
Parses a user path into its component segments.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.parse_user_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.promote_cluster
promote_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.PromoteClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Promotes a SECONDARY cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.promote_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.restart_instance
restart_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.RestartInstanceRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Restart an Instance in a cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.restart_instance
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.restore_cluster
restore_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.RestoreClusterRequest, dict
]
] = None,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
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.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.restore_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.supported_database_flag_path
supported_database_flag_path(project: str, location: str, flag: str) -> str
Returns a fully-qualified supported_database_flag string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.supported_database_flag_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.switchover_cluster
switchover_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.SwitchoverClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Switches the roles of PRIMARY and SECONDARY clusters without any data loss.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.switchover_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.update_backup
update_backup(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.UpdateBackupRequest, dict
]
] = None,
*,
backup: typing.Optional[google.cloud.alloydb_v1beta.types.resources.Backup] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single Backup.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.update_backup
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.update_cluster
update_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.UpdateClusterRequest, dict
]
] = None,
*,
cluster: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.Cluster
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single Cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.update_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.update_instance
update_instance(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.UpdateInstanceRequest, dict
]
] = None,
*,
instance: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.Instance
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Updates the parameters of a single Instance.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.update_instance
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.update_user
update_user(
request: typing.Optional[
typing.Union[google.cloud.alloydb_v1beta.types.service.UpdateUserRequest, dict]
] = None,
*,
user: typing.Optional[google.cloud.alloydb_v1beta.types.resources.User] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.cloud.alloydb_v1beta.types.resources.User
Updates the parameters of a single User.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.update_user
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.upgrade_cluster
upgrade_cluster(
request: typing.Optional[
typing.Union[
google.cloud.alloydb_v1beta.types.service.UpgradeClusterRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
version: typing.Optional[
google.cloud.alloydb_v1beta.types.resources.DatabaseVersion
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation.Operation
Upgrades a single Cluster.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.upgrade_cluster
google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.user_path
user_path(project: str, location: str, cluster: str, user: str) -> str
Returns a fully-qualified user string.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.AlloyDBAdminClient.user_path
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListBackupsAsyncPager
ListBackupsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[google.cloud.alloydb_v1beta.types.service.ListBackupsResponse],
],
request: google.cloud.alloydb_v1beta.types.service.ListBackupsRequest,
response: google.cloud.alloydb_v1beta.types.service.ListBackupsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListBackupsAsyncPager
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListBackupsPager
ListBackupsPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1beta.types.service.ListBackupsResponse
],
request: google.cloud.alloydb_v1beta.types.service.ListBackupsRequest,
response: google.cloud.alloydb_v1beta.types.service.ListBackupsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListBackupsPager
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListClustersAsyncPager
ListClustersAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.alloydb_v1beta.types.service.ListClustersResponse
],
],
request: google.cloud.alloydb_v1beta.types.service.ListClustersRequest,
response: google.cloud.alloydb_v1beta.types.service.ListClustersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListClustersAsyncPager
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListClustersPager
ListClustersPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1beta.types.service.ListClustersResponse
],
request: google.cloud.alloydb_v1beta.types.service.ListClustersRequest,
response: google.cloud.alloydb_v1beta.types.service.ListClustersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListClustersPager
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListDatabasesAsyncPager
ListDatabasesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.alloydb_v1beta.types.service.ListDatabasesResponse
],
],
request: google.cloud.alloydb_v1beta.types.service.ListDatabasesRequest,
response: google.cloud.alloydb_v1beta.types.service.ListDatabasesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListDatabasesAsyncPager
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListDatabasesPager
ListDatabasesPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1beta.types.service.ListDatabasesResponse
],
request: google.cloud.alloydb_v1beta.types.service.ListDatabasesRequest,
response: google.cloud.alloydb_v1beta.types.service.ListDatabasesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListDatabasesPager
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListInstancesAsyncPager
ListInstancesAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.alloydb_v1beta.types.service.ListInstancesResponse
],
],
request: google.cloud.alloydb_v1beta.types.service.ListInstancesRequest,
response: google.cloud.alloydb_v1beta.types.service.ListInstancesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListInstancesAsyncPager
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListInstancesPager
ListInstancesPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1beta.types.service.ListInstancesResponse
],
request: google.cloud.alloydb_v1beta.types.service.ListInstancesRequest,
response: google.cloud.alloydb_v1beta.types.service.ListInstancesResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListInstancesPager
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsAsyncPager
ListSupportedDatabaseFlagsAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[
google.cloud.alloydb_v1beta.types.service.ListSupportedDatabaseFlagsResponse
],
],
request: google.cloud.alloydb_v1beta.types.service.ListSupportedDatabaseFlagsRequest,
response: google.cloud.alloydb_v1beta.types.service.ListSupportedDatabaseFlagsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsAsyncPager
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsPager
ListSupportedDatabaseFlagsPager(
method: typing.Callable[
[...],
google.cloud.alloydb_v1beta.types.service.ListSupportedDatabaseFlagsResponse,
],
request: google.cloud.alloydb_v1beta.types.service.ListSupportedDatabaseFlagsRequest,
response: google.cloud.alloydb_v1beta.types.service.ListSupportedDatabaseFlagsResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsPager
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListUsersAsyncPager
ListUsersAsyncPager(
method: typing.Callable[
[...],
typing.Awaitable[google.cloud.alloydb_v1beta.types.service.ListUsersResponse],
],
request: google.cloud.alloydb_v1beta.types.service.ListUsersRequest,
response: google.cloud.alloydb_v1beta.types.service.ListUsersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary_async.AsyncRetry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiates the pager.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListUsersAsyncPager
google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListUsersPager
ListUsersPager(
method: typing.Callable[
[...], google.cloud.alloydb_v1beta.types.service.ListUsersResponse
],
request: google.cloud.alloydb_v1beta.types.service.ListUsersRequest,
response: google.cloud.alloydb_v1beta.types.service.ListUsersResponse,
*,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
)
Instantiate the pager.
See more: google.cloud.alloydb_v1beta.services.alloy_db_admin.pagers.ListUsersPager