AlloyDBAdminAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.alloydb_v1.services.alloy_db_admin.transports.base.AlloyDBAdminTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Service describing handlers for resources
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
AlloyDBAdminTransport | The transport used by the client instance. |
Methods
AlloyDBAdminAsyncClient
AlloyDBAdminAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.alloydb_v1.services.alloy_db_admin.transports.base.AlloyDBAdminTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the alloy db admin client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
backup_path
backup_path(project: str, location: str, backup: str)
Returns a fully-qualified backup string.
batch_create_instances
batch_create_instances(request: Optional[Union[google.cloud.alloydb_v1.types.service.BatchCreateInstancesRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Creates new instances under the given project, location and cluster. There can be only one primary instance in a cluster. If the primary instance exists in the cluster as well as this request, then API will throw an error. The primary instance should exist before any read pool instance is created. If the primary instance is a part of the request payload, then the API will take care of creating instances in the correct order. This method is here to support Google-internal use cases, and is not meant for external customers to consume. Please do not start relying on it; its behavior is subject to change without notice.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_batch_create_instances():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
requests = alloydb_v1.CreateInstanceRequests()
requests.create_instance_requests.parent = "parent_value"
requests.create_instance_requests.instance_id = "instance_id_value"
requests.create_instance_requests.instance.instance_type = "SECONDARY"
request = alloydb_v1.BatchCreateInstancesRequest(
parent="parent_value",
requests=requests,
)
# Make the request
operation = client.batch_create_instances(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.BatchCreateInstancesRequest, dict]]
The request object. Message for creating a batch of instances under the specified cluster. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be BatchCreateInstancesResponse Message for creating batches of instances in a cluster. |
cancel_operation
cancel_operation(request: Optional[google.longrunning.operations_pb2.CancelOperationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Starts asynchronous cancellation on a long-running operation.
The server makes a best effort to cancel the operation, but success
is not guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
cluster_path
cluster_path(project: str, location: str, cluster: str)
Returns a fully-qualified cluster string.
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
create_backup
create_backup(request: Optional[Union[google.cloud.alloydb_v1.types.service.CreateBackupRequest, dict]] = None, *, parent: Optional[str] = None, backup: Optional[google.cloud.alloydb_v1.types.resources.Backup] = None, backup_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Creates a new Backup in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_create_backup():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
backup = alloydb_v1.Backup()
backup.cluster_name = "cluster_name_value"
request = alloydb_v1.CreateBackupRequest(
parent="parent_value",
backup_id="backup_id_value",
backup=backup,
)
# Make the request
operation = client.create_backup(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.CreateBackupRequest, dict]]
The request object. Message for creating a Backup |
parent |
Required. Value for parent. This corresponds to the |
backup |
Backup
Required. The resource being created This corresponds to the |
backup_id |
Required. ID of the requesting object. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Backup Message describing Backup object |
create_cluster
create_cluster(request: Optional[Union[google.cloud.alloydb_v1.types.service.CreateClusterRequest, dict]] = None, *, parent: Optional[str] = None, cluster: Optional[google.cloud.alloydb_v1.types.resources.Cluster] = None, cluster_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Creates a new Cluster in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_create_cluster():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
cluster = alloydb_v1.Cluster()
cluster.backup_source.backup_name = "backup_name_value"
cluster.network = "network_value"
request = alloydb_v1.CreateClusterRequest(
parent="parent_value",
cluster_id="cluster_id_value",
cluster=cluster,
)
# Make the request
operation = client.create_cluster(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.CreateClusterRequest, dict]]
The request object. Message for creating a Cluster |
parent |
Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field. This corresponds to the |
cluster |
Cluster
Required. The resource being created This corresponds to the |
cluster_id |
Required. ID of the requesting object. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Cluster A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed. |
create_instance
create_instance(request: Optional[Union[google.cloud.alloydb_v1.types.service.CreateInstanceRequest, dict]] = None, *, parent: Optional[str] = None, instance: Optional[google.cloud.alloydb_v1.types.resources.Instance] = None, instance_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Creates a new Instance in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_create_instance():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
instance = alloydb_v1.Instance()
instance.instance_type = "SECONDARY"
request = alloydb_v1.CreateInstanceRequest(
parent="parent_value",
instance_id="instance_id_value",
instance=instance,
)
# Make the request
operation = client.create_instance(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.CreateInstanceRequest, dict]]
The request object. Message for creating a Instance |
parent |
Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. This corresponds to the |
instance |
Instance
Required. The resource being created This corresponds to the |
instance_id |
Required. ID of the requesting object. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB. |
create_secondary_cluster
create_secondary_cluster(request: Optional[Union[google.cloud.alloydb_v1.types.service.CreateSecondaryClusterRequest, dict]] = None, *, parent: Optional[str] = None, cluster: Optional[google.cloud.alloydb_v1.types.resources.Cluster] = None, cluster_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Creates a cluster of type SECONDARY in the given location using the primary cluster as the source.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_create_secondary_cluster():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
cluster = alloydb_v1.Cluster()
cluster.backup_source.backup_name = "backup_name_value"
cluster.network = "network_value"
request = alloydb_v1.CreateSecondaryClusterRequest(
parent="parent_value",
cluster_id="cluster_id_value",
cluster=cluster,
)
# Make the request
operation = client.create_secondary_cluster(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.CreateSecondaryClusterRequest, dict]]
The request object. |
parent |
Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field. This corresponds to the |
cluster |
Cluster
Required. Configuration of the requesting object (the secondary cluster). This corresponds to the |
cluster_id |
Required. ID of the requesting object (the secondary cluster). This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Cluster A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed. |
create_secondary_instance
create_secondary_instance(request: Optional[Union[google.cloud.alloydb_v1.types.service.CreateSecondaryInstanceRequest, dict]] = None, *, parent: Optional[str] = None, instance: Optional[google.cloud.alloydb_v1.types.resources.Instance] = None, instance_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Creates a new SECONDARY Instance in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_create_secondary_instance():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
instance = alloydb_v1.Instance()
instance.instance_type = "SECONDARY"
request = alloydb_v1.CreateSecondaryInstanceRequest(
parent="parent_value",
instance_id="instance_id_value",
instance=instance,
)
# Make the request
operation = client.create_secondary_instance(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.CreateSecondaryInstanceRequest, dict]]
The request object. Message for creating a Secondary Instance |
parent |
Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. This corresponds to the |
instance |
Instance
Required. The resource being created This corresponds to the |
instance_id |
Required. ID of the requesting object. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB. |
create_user
create_user(request: Optional[Union[google.cloud.alloydb_v1.types.service.CreateUserRequest, dict]] = None, *, parent: Optional[str] = None, user: Optional[google.cloud.alloydb_v1.types.resources.User] = None, user_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Creates a new User in a given project, location, and cluster.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_create_user():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.CreateUserRequest(
parent="parent_value",
user_id="user_id_value",
)
# Make the request
response = await client.create_user(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.CreateUserRequest, dict]]
The request object. Message for creating a User |
parent |
Required. Value for parent. This corresponds to the |
user |
User
Required. The resource being created This corresponds to the |
user_id |
Required. ID of the requesting object. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.alloydb_v1.types.User | Message describing User object. |
crypto_key_version_path
crypto_key_version_path(
project: str, location: str, key_ring: str, crypto_key: str, crypto_key_version: str
)
Returns a fully-qualified crypto_key_version string.
delete_backup
delete_backup(request: Optional[Union[google.cloud.alloydb_v1.types.service.DeleteBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Deletes a single Backup.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_delete_backup():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.DeleteBackupRequest(
name="name_value",
)
# Make the request
operation = client.delete_backup(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.DeleteBackupRequest, dict]]
The request object. Message for deleting a Backup |
name |
Required. Name of the resource. For the required format, see the comment on the Backup.name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_cluster
delete_cluster(request: Optional[Union[google.cloud.alloydb_v1.types.service.DeleteClusterRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Deletes a single Cluster.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_delete_cluster():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.DeleteClusterRequest(
name="name_value",
)
# Make the request
operation = client.delete_cluster(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.DeleteClusterRequest, dict]]
The request object. Message for deleting a Cluster |
name |
Required. The name of the resource. For the required format, see the comment on the Cluster.name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_instance
delete_instance(request: Optional[Union[google.cloud.alloydb_v1.types.service.DeleteInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Deletes a single Instance.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_delete_instance():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.DeleteInstanceRequest(
name="name_value",
)
# Make the request
operation = client.delete_instance(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.DeleteInstanceRequest, dict]]
The request object. Message for deleting a Instance |
name |
Required. The name of the resource. For the required format, see the comment on the Instance.name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
delete_operation
delete_operation(request: Optional[google.longrunning.operations_pb2.DeleteOperationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Deletes a long-running operation.
This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation.
If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED
.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
delete_user
delete_user(request: Optional[Union[google.cloud.alloydb_v1.types.service.DeleteUserRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Deletes a single User.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_delete_user():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.DeleteUserRequest(
name="name_value",
)
# Make the request
await client.delete_user(request=request)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.DeleteUserRequest, dict]]
The request object. Message for deleting a User |
name |
Required. The name of the resource. For the required format, see the comment on the User.name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
failover_instance
failover_instance(request: Optional[Union[google.cloud.alloydb_v1.types.service.FailoverInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Forces a Failover for a highly available instance. Failover promotes the HA standby instance as the new primary. Imperative only.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_failover_instance():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.FailoverInstanceRequest(
name="name_value",
)
# Make the request
operation = client.failover_instance(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.FailoverInstanceRequest, dict]]
The request object. Message for triggering failover on an Instance |
name |
Required. The name of the resource. For the required format, see the comment on the Instance.name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
AlloyDBAdminAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
AlloyDBAdminAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
AlloyDBAdminAsyncClient | The constructed client. |
get_backup
get_backup(request: Optional[Union[google.cloud.alloydb_v1.types.service.GetBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Gets details of a single Backup.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_get_backup():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.GetBackupRequest(
name="name_value",
)
# Make the request
response = await client.get_backup(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.GetBackupRequest, dict]]
The request object. Message for getting a Backup |
name |
Required. Name of the resource This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.alloydb_v1.types.Backup | Message describing Backup object |
get_cluster
get_cluster(request: Optional[Union[google.cloud.alloydb_v1.types.service.GetClusterRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Gets details of a single Cluster.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_get_cluster():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.GetClusterRequest(
name="name_value",
)
# Make the request
response = await client.get_cluster(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.GetClusterRequest, dict]]
The request object. Message for getting a Cluster |
name |
Required. The name of the resource. For the required format, see the comment on the Cluster.name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.alloydb_v1.types.Cluster | A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed. |
get_instance
get_instance(request: Optional[Union[google.cloud.alloydb_v1.types.service.GetInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Gets details of a single Instance.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_get_instance():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.GetInstanceRequest(
name="name_value",
)
# Make the request
response = await client.get_instance(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.GetInstanceRequest, dict]]
The request object. Message for getting a Instance |
name |
Required. The name of the resource. For the required format, see the comment on the Instance.name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.alloydb_v1.types.Instance | An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB. |
get_location
get_location(request: Optional[google.cloud.location.locations_pb2.GetLocationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Gets information about a location.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Location object. |
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source(
client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variable is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114.
Parameter | |
---|---|
Name | Description |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. Only the |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If any errors happen. |
Returns | |
---|---|
Type | Description |
Tuple[str, Callable[[], Tuple[bytes, bytes]]] | returns the API endpoint and the client cert source to use. |
get_operation
get_operation(request: Optional[google.longrunning.operations_pb2.GetOperationRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Gets the latest state of a long-running operation.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| An Operation object. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
get_user
get_user(request: Optional[Union[google.cloud.alloydb_v1.types.service.GetUserRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Gets details of a single User.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_get_user():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.GetUserRequest(
name="name_value",
)
# Make the request
response = await client.get_user(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.GetUserRequest, dict]]
The request object. Message for getting a User |
name |
Required. The name of the resource. For the required format, see the comment on the User.name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.alloydb_v1.types.User | Message describing User object. |
inject_fault
inject_fault(request: Optional[Union[google.cloud.alloydb_v1.types.service.InjectFaultRequest, dict]] = None, *, fault_type: Optional[google.cloud.alloydb_v1.types.service.InjectFaultRequest.FaultType] = None, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Injects fault in an instance. Imperative only.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_inject_fault():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.InjectFaultRequest(
fault_type="STOP_VM",
name="name_value",
)
# Make the request
operation = client.inject_fault(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.InjectFaultRequest, dict]]
The request object. Message for triggering fault injection on an instance |
fault_type |
FaultType
Required. The type of fault to be injected in an instance. This corresponds to the |
name |
Required. The name of the resource. For the required format, see the comment on the Instance.name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB. |
instance_path
instance_path(project: str, location: str, cluster: str, instance: str)
Returns a fully-qualified instance string.
list_backups
list_backups(request: Optional[Union[google.cloud.alloydb_v1.types.service.ListBackupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Lists Backups in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_list_backups():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.ListBackupsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_backups(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.ListBackupsRequest, dict]]
The request object. Message for requesting list of Backups |
parent |
Required. Parent value for ListBackupsRequest This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListBackupsAsyncPager | Message for response to listing Backups Iterating over this object will yield results and resolve additional pages automatically. |
list_clusters
list_clusters(request: Optional[Union[google.cloud.alloydb_v1.types.service.ListClustersRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Lists Clusters in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_list_clusters():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.ListClustersRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_clusters(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.ListClustersRequest, dict]]
The request object. Message for requesting list of Clusters |
parent |
Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field. Additionally, you can perform an aggregated list operation by specifying a value with the following format: - projects/{project}/locations/- This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListClustersAsyncPager | Message for response to listing Clusters Iterating over this object will yield results and resolve additional pages automatically. |
list_instances
list_instances(request: Optional[Union[google.cloud.alloydb_v1.types.service.ListInstancesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Lists Instances in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_list_instances():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.ListInstancesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_instances(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.ListInstancesRequest, dict]]
The request object. Message for requesting list of Instances |
parent |
Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats: - projects/{project}/locations/-/clusters/- - projects/{project}/locations/{region}/clusters/- This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListInstancesAsyncPager | Message for response to listing Instances Iterating over this object will yield results and resolve additional pages automatically. |
list_locations
list_locations(request: Optional[google.cloud.location.locations_pb2.ListLocationsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Lists information about the supported locations for this service.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Response message for ListLocations method. |
list_operations
list_operations(request: Optional[google.longrunning.operations_pb2.ListOperationsRequest] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Lists operations that match the specified filter in the request.
Parameters | |
---|---|
Name | Description |
request |
The request object. Request message for |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
| Response message for ListOperations method. |
list_supported_database_flags
list_supported_database_flags(request: Optional[Union[google.cloud.alloydb_v1.types.service.ListSupportedDatabaseFlagsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Lists SupportedDatabaseFlags for a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_list_supported_database_flags():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.ListSupportedDatabaseFlagsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_supported_database_flags(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.ListSupportedDatabaseFlagsRequest, dict]]
The request object. Message for listing the information about the supported Database flags. |
parent |
Required. The name of the parent resource. The required format is: - projects/{project}/locations/{location} Regardless of the parent specified here, as long it is contains a valid project and location, the service will return a static list of supported flags resources. Note that we do not yet support region-specific flags. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListSupportedDatabaseFlagsAsyncPager | Message for response to listing SupportedDatabaseFlags. Iterating over this object will yield results and resolve additional pages automatically. |
list_users
list_users(request: Optional[Union[google.cloud.alloydb_v1.types.service.ListUsersRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Lists Users in a given project and location.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_list_users():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.ListUsersRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_users(request=request)
# Handle the response
async for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.ListUsersRequest, dict]]
The request object. Message for requesting list of Users |
parent |
Required. Parent value for ListUsersRequest This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.alloydb_v1.services.alloy_db_admin.pagers.ListUsersAsyncPager | Message for response to listing Users Iterating over this object will yield results and resolve additional pages automatically. |
network_path
network_path(project: str, network: str)
Returns a fully-qualified network string.
parse_backup_path
parse_backup_path(path: str)
Parses a backup path into its component segments.
parse_cluster_path
parse_cluster_path(path: str)
Parses a cluster path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.
parse_crypto_key_version_path
parse_crypto_key_version_path(path: str)
Parses a crypto_key_version path into its component segments.
parse_instance_path
parse_instance_path(path: str)
Parses a instance path into its component segments.
parse_network_path
parse_network_path(path: str)
Parses a network path into its component segments.
parse_supported_database_flag_path
parse_supported_database_flag_path(path: str)
Parses a supported_database_flag path into its component segments.
parse_user_path
parse_user_path(path: str)
Parses a user path into its component segments.
promote_cluster
promote_cluster(request: Optional[Union[google.cloud.alloydb_v1.types.service.PromoteClusterRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Promotes a SECONDARY cluster. This turns down replication from the PRIMARY cluster and promotes a secondary cluster into its own standalone cluster. Imperative only.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_promote_cluster():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.PromoteClusterRequest(
name="name_value",
)
# Make the request
operation = client.promote_cluster(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.PromoteClusterRequest, dict]]
The request object. Message for promoting a Cluster |
name |
Required. The name of the resource. For the required format, see the comment on the Cluster.name field This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Cluster A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed. |
restart_instance
restart_instance(request: Optional[Union[google.cloud.alloydb_v1.types.service.RestartInstanceRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Restart an Instance in a cluster. Imperative only.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_restart_instance():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.RestartInstanceRequest(
name="name_value",
)
# Make the request
operation = client.restart_instance(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.RestartInstanceRequest, dict]]
The request object. |
name |
Required. The name of the resource. For the required format, see the comment on the Instance.name field. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB. |
restore_cluster
restore_cluster(request: Optional[Union[google.cloud.alloydb_v1.types.service.RestoreClusterRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Creates a new Cluster in a given project and location, with a volume restored from the provided source, either a backup ID or a point-in-time and a source cluster.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_restore_cluster():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
backup_source = alloydb_v1.BackupSource()
backup_source.backup_name = "backup_name_value"
cluster = alloydb_v1.Cluster()
cluster.backup_source.backup_name = "backup_name_value"
cluster.network = "network_value"
request = alloydb_v1.RestoreClusterRequest(
backup_source=backup_source,
parent="parent_value",
cluster_id="cluster_id_value",
cluster=cluster,
)
# Make the request
operation = client.restore_cluster(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.RestoreClusterRequest, dict]]
The request object. Message for restoring a Cluster from a backup or another cluster at a given point in time. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Cluster A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed. |
supported_database_flag_path
supported_database_flag_path(project: str, location: str, flag: str)
Returns a fully-qualified supported_database_flag string.
update_backup
update_backup(request: Optional[Union[google.cloud.alloydb_v1.types.service.UpdateBackupRequest, dict]] = None, *, backup: Optional[google.cloud.alloydb_v1.types.resources.Backup] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Updates the parameters of a single Backup.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_update_backup():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
backup = alloydb_v1.Backup()
backup.cluster_name = "cluster_name_value"
request = alloydb_v1.UpdateBackupRequest(
backup=backup,
)
# Make the request
operation = client.update_backup(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.UpdateBackupRequest, dict]]
The request object. Message for updating a Backup |
backup |
Backup
Required. The resource being updated This corresponds to the |
update_mask |
Optional. Field mask is used to specify the fields to be overwritten in the Backup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Backup Message describing Backup object |
update_cluster
update_cluster(request: Optional[Union[google.cloud.alloydb_v1.types.service.UpdateClusterRequest, dict]] = None, *, cluster: Optional[google.cloud.alloydb_v1.types.resources.Cluster] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Updates the parameters of a single Cluster.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_update_cluster():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
cluster = alloydb_v1.Cluster()
cluster.backup_source.backup_name = "backup_name_value"
cluster.network = "network_value"
request = alloydb_v1.UpdateClusterRequest(
cluster=cluster,
)
# Make the request
operation = client.update_cluster(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.UpdateClusterRequest, dict]]
The request object. Message for updating a Cluster |
cluster |
Cluster
Required. The resource being updated This corresponds to the |
update_mask |
Optional. Field mask is used to specify the fields to be overwritten in the Cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Cluster A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed. |
update_instance
update_instance(request: Optional[Union[google.cloud.alloydb_v1.types.service.UpdateInstanceRequest, dict]] = None, *, instance: Optional[google.cloud.alloydb_v1.types.resources.Instance] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Updates the parameters of a single Instance.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_update_instance():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
instance = alloydb_v1.Instance()
instance.instance_type = "SECONDARY"
request = alloydb_v1.UpdateInstanceRequest(
instance=instance,
)
# Make the request
operation = client.update_instance(request=request)
print("Waiting for operation to complete...")
response = (await operation).result()
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.UpdateInstanceRequest, dict]]
The request object. Message for updating a Instance |
instance |
Instance
Required. The resource being updated This corresponds to the |
update_mask |
Optional. Field mask is used to specify the fields to be overwritten in the Instance resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.api_core.operation_async.AsyncOperation | An object representing a long-running operation. The result type for the operation will be Instance An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB. |
update_user
update_user(request: Optional[Union[google.cloud.alloydb_v1.types.service.UpdateUserRequest, dict]] = None, *, user: Optional[google.cloud.alloydb_v1.types.resources.User] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())
Updates the parameters of a single User.
# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
# client as shown in:
# https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import alloydb_v1
async def sample_update_user():
# Create a client
client = alloydb_v1.AlloyDBAdminAsyncClient()
# Initialize request argument(s)
request = alloydb_v1.UpdateUserRequest(
)
# Make the request
response = await client.update_user(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Optional[Union[google.cloud.alloydb_v1.types.UpdateUserRequest, dict]]
The request object. Message for updating a User |
user |
User
Required. The resource being updated This corresponds to the |
update_mask |
Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.alloydb_v1.types.User | Message describing User object. |
user_path
user_path(project: str, location: str, cluster: str, user: str)
Returns a fully-qualified user string.