0.1.4 (latest) 0.1.3 SqlInstancesServiceAsyncClient( *, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[ typing.Union[ str, google.cloud.sqladmin_v1beta4.services.sql_instances_service.transports.base.SqlInstancesServiceTransport, typing.Callable[ [...], google.cloud.sqladmin_v1beta4.services.sql_instances_service.transports.base.SqlInstancesServiceTransport, ], ] ] = "grpc_asyncio", client_options: typing.Optional[ google.api_core.client_options.ClientOptions ] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo ) Service to manage Cloud SQL instances. ## Properties ### api_endpoint Return the API endpoint used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `str` | The API endpoint used by the client instance. | ### transport Returns the transport used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `SqlInstancesServiceTransport` | The transport used by the client instance. | ### universe_domain Return the universe domain used by the client instance. | **Returns** || |---|---| | **Type** | **Description** | | `str` | The universe domain used by the client instance. | ## Methods ### SqlInstancesServiceAsyncClient SqlInstancesServiceAsyncClient( *, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[ typing.Union[ str, google.cloud.sqladmin_v1beta4.services.sql_instances_service.transports.base.SqlInstancesServiceTransport, typing.Callable[ [...], google.cloud.sqladmin_v1beta4.services.sql_instances_service.transports.base.SqlInstancesServiceTransport, ], ] ] = "grpc_asyncio", client_options: typing.Optional[ google.api_core.client_options.ClientOptions ] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = google.api_core.gapic_v1.client_info.ClientInfo ) Instantiates the sql instances service async 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` | `Optional[Union[str,SqlInstancesServiceTransport,Callable[..., SqlInstancesServiceTransport]]]` The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the SqlInstancesServiceTransport constructor. If set to None, a transport is chosen automatically. | | `client_options` | `Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Custom options for the client. 1. The `api_endpoint` property can be used to override the default endpoint provided by the client when `transport` is not explicitly provided. Only if this property is not set and `transport` was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The `universe_domain` property can be used to override the default "googleapis.com" universe. Note that `api_endpoint` property still takes precedence; and `universe_domain` is currently not supported for mTLS. | | `client_info` | `google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library. | | **Exceptions** || |---|---| | **Type** | **Description** | | `google.auth.exceptions.MutualTlsChannelError` | If mutual TLS transport creation failed for any reason. | ### acquire_ssrs_lease acquire_ssrs_lease( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesAcquireSsrsLeaseRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesAcquireSsrsLeaseResponse Acquire a lease for the setup of SQL Server Reporting Services (SSRS). # 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 sqladmin_v1beta4 async def sample_acquire_ssrs_lease(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesAcquireSsrsLeaseRequest.html( instance="instance_value", project="project_value", ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_acquire_ssrs_lease(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesAcquireSsrsLeaseRequest, dict]]` The request object. Request to acquire a lease for SSRS. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesAcquireSsrsLeaseResponse` | Acquire SSRS lease response. | ### add_entra_id_certificate add_entra_id_certificate( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesAddEntraIdCertificateRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Adds a new Entra ID certificate for the specified instance. If an Entra ID certificate was previously added but never used in a certificate rotation, this operation replaces that version. # 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 sqladmin_v1beta4 async def sample_add_entra_id_certificate(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesAddEntraIdCertificateRequest.html( instance="instance_value", project="project_value", ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_add_entra_id_certificate(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesAddEntraIdCertificateRequest, dict]]` The request object. Request for AddEntraIdCertificate RPC. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### add_server_ca add_server_ca( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesAddServerCaRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, use AddServerCertificate to add a new server certificate. # 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 sqladmin_v1beta4 async def sample_add_server_ca(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesAddServerCaRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_add_server_ca(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesAddServerCaRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### add_server_certificate add_server_certificate( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesAddServerCertificateRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, use AddServerCa instead. # 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 sqladmin_v1beta4 async def sample_add_server_certificate(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesAddServerCertificateRequest.html( instance="instance_value", project="project_value", ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_add_server_certificate(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesAddServerCertificateRequest, dict]]` The request object. Request for AddServerCertificate RPC. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### backup_dr_backup_path backup_dr_backup_path( project: str, location: str, backupvault: str, datasource: str, backup: str ) -> str Returns a fully-qualified backup_dr_backup string. ### backup_path backup_path(project: str, backup: str) -> str Returns a fully-qualified backup string. ### clone clone( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesCloneRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart. # 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 sqladmin_v1beta4 async def sample_clone(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesCloneRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_clone(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesCloneRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### common_billing_account_path common_billing_account_path(billing_account: str) -> str Returns a fully-qualified billing_account string. ### common_folder_path common_folder_path(folder: str) -> str Returns a fully-qualified folder string. ### common_location_path common_location_path(project: str, location: str) -> str Returns a fully-qualified location string. ### common_organization_path common_organization_path(organization: str) -> str Returns a fully-qualified organization string. ### common_project_path common_project_path(project: str) -> str Returns a fully-qualified project string. ### create_ephemeral create_ephemeral( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesCreateEphemeralCertRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.SslCert Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database. # 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 sqladmin_v1beta4 async def sample_create_ephemeral(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesCreateEphemeralCertRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_create_ephemeral(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesCreateEphemeralCertRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SslCert` | SslCerts Resource | ### crypto_key_path crypto_key_path(project: str, location: str, key_ring: str, crypto_key: str) -> str Returns a fully-qualified crypto_key string. ### 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. ### delete delete( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesDeleteRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Deletes a Cloud SQL 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 sqladmin_v1beta4 async def sample_delete(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesDeleteRequest.html( final_backup_ttl_days=2210, ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_delete(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesDeleteRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### demote demote( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesDemoteRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server. # 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 sqladmin_v1beta4 async def sample_demote(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesDemoteRequest.html( instance="instance_value", project="project_value", ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_demote(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesDemoteRequest, dict]]` The request object. Instance demote request. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### demote_master demote_master( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesDemoteMasterRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server. # 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 sqladmin_v1beta4 async def sample_demote_master(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesDemoteMasterRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_demote_master(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesDemoteMasterRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### execute_sql execute_sql( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesExecuteSqlRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesExecuteSqlResponse Execute SQL statements. # 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 sqladmin_v1beta4 async def sample_execute_sql(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesExecuteSqlRequest.html( instance="instance_value", project="project_value", ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_execute_sql(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesExecuteSqlRequest, dict]]` The request object. Execute SQL statements request. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | ### export export( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesExportRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file. # 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 sqladmin_v1beta4 async def sample_export(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesExportRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_export(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesExportRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### failover failover( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesFailoverRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the `Overview of high availability `__ page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica 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 sqladmin_v1beta4 async def sample_failover(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesFailoverRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_failover(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesFailoverRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### 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** | | `SqlInstancesServiceAsyncClient` | 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** | | `SqlInstancesServiceAsyncClient` | 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** | | `SqlInstancesServiceAsyncClient` | The constructed client. | ### get get( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesGetRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.DatabaseInstance Retrieves a resource containing information about a Cloud SQL 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 sqladmin_v1beta4 async def sample_get(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesGetRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_get(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesGetRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.DatabaseInstance` | A Cloud SQL instance resource. | ### get_disk_shrink_config get_disk_shrink_config( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesGetDiskShrinkConfigRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.SqlInstancesGetDiskShrinkConfigResponse ) Get Disk Shrink Config for a given 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 sqladmin_v1beta4 async def sample_get_disk_shrink_config(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesGetDiskShrinkConfigRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_get_disk_shrink_config(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesGetDiskShrinkConfigRequest, dict]]` The request object. Instance get disk shrink config request. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesGetDiskShrinkConfigResponse` | Instance get disk shrink config response. | ### get_latest_recovery_time get_latest_recovery_time( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesGetLatestRecoveryTimeRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesGetLatestRecoveryTimeResponse ) Get Latest Recovery Time for a given 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 sqladmin_v1beta4 async def sample_get_latest_recovery_time(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesGetLatestRecoveryTimeRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_get_latest_recovery_time(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesGetLatestRecoveryTimeRequest, dict]]` The request object. Instance get latest recovery time request. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesGetLatestRecoveryTimeResponse` | Instance get latest recovery time response. | ### 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. 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 . | **Parameter** || |---|---| | **Name** | **Description** | | `client_options` | `google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method. | | **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_transport_class get_transport_class( label: typing.Optional[str] = None, ) -> typing.Type[ google.cloud.sqladmin_v1beta4.services.sql_instances_service.transports.base.SqlInstancesServiceTransport ] Returns an appropriate transport class. | **Parameter** || |---|---| | **Name** | **Description** | | `label` | `typing.Optional[str]` The name of the desired transport. If none is provided, then the first transport in the registry is used. | ### import_ import_( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesImportRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage. # 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 sqladmin_v1beta4 async def sample_import(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesImportRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_import_(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesImportRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### insert insert( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesInsertRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Creates a new Cloud SQL 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 sqladmin_v1beta4 async def sample_insert(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesInsertRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_insert(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesInsertRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### list list( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesListRequest, 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.cloud.sqladmin_v1beta4.services.sql_instances_service.pagers.ListAsyncPager Lists instances under a given project. # 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 sqladmin_v1beta4 async def sample_list(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesListRequest.html( ) # Make the request page_result = client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_list(request=request) # Handle the response async for response in page_result: print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesListRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.pagers.ListAsyncPager` | Database instances list response. Iterating over this object will yield results and resolve additional pages automatically. | ### list_entra_id_certificates list_entra_id_certificates( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesListEntraIdCertificatesRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.InstancesListEntraIdCertificatesResponse ) Lists all versions of EntraID certificates for the specified instance. There can be up to three sets of certificates listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. # 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 sqladmin_v1beta4 async def sample_list_entra_id_certificates(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesListEntraIdCertificatesRequest.html( instance="instance_value", project="project_value", ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_list_entra_id_certificates(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesListEntraIdCertificatesRequest, dict]]` The request object. Request message for SqlInstancesService.ListEntraIdCertificates. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.InstancesListEntraIdCertificatesResponse` | Instances ListEntraIdCertificates response. | ### list_server_cas list_server_cas( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesListServerCasRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.InstancesListServerCasResponse ) Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out. # 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 sqladmin_v1beta4 async def sample_list_server_cas(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesListServerCasRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_list_server_cas(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesListServerCasRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.InstancesListServerCasResponse` | Instances ListServerCas response. | ### list_server_certificates list_server_certificates( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesListServerCertificatesRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.InstancesListServerCertificatesResponse ) Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead. # 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 sqladmin_v1beta4 async def sample_list_server_certificates(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesListServerCertificatesRequest.html( instance="instance_value", project="project_value", ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_list_server_certificates(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesListServerCertificatesRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.InstancesListServerCertificatesResponse` | Instances ListServerCertificatess response. | ### network_attachment_path network_attachment_path(project: str, region: str, network_attachment: str) -> str Returns a fully-qualified network_attachment string. ### network_path network_path(project: str, network: str) -> str Returns a fully-qualified network string. ### parse_backup_dr_backup_path parse_backup_dr_backup_path(path: str) -> typing.Dict[str, str] Parses a backup_dr_backup path into its component segments. ### parse_backup_path parse_backup_path(path: str) -> typing.Dict[str, str] Parses a backup path into its component segments. ### 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. ### parse_common_folder_path parse_common_folder_path(path: str) -> typing.Dict[str, str] Parse a folder path into its component segments. ### parse_common_location_path parse_common_location_path(path: str) -> typing.Dict[str, str] Parse a location path into its component segments. ### parse_common_organization_path parse_common_organization_path(path: str) -> typing.Dict[str, str] Parse a organization path into its component segments. ### parse_common_project_path parse_common_project_path(path: str) -> typing.Dict[str, str] Parse a project path into its component segments. ### parse_crypto_key_path parse_crypto_key_path(path: str) -> typing.Dict[str, str] Parses a crypto_key path into its component segments. ### 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. ### parse_network_attachment_path parse_network_attachment_path(path: str) -> typing.Dict[str, str] Parses a network_attachment path into its component segments. ### parse_network_path parse_network_path(path: str) -> typing.Dict[str, str] Parses a network path into its component segments. ### parse_secret_version_path parse_secret_version_path(path: str) -> typing.Dict[str, str] Parses a secret_version path into its component segments. ### parse_service_connection_policy_path parse_service_connection_policy_path(path: str) -> typing.Dict[str, str] Parses a service_connection_policy path into its component segments. ### patch patch( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesPatchRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics. # 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 sqladmin_v1beta4 async def sample_patch(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesPatchRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_patch(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesPatchRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### perform_disk_shrink perform_disk_shrink( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesPerformDiskShrinkRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Perform Disk Shrink on primary 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 sqladmin_v1beta4 async def sample_perform_disk_shrink(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesPerformDiskShrinkRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_perform_disk_shrink(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesPerformDiskShrinkRequest, dict]]` The request object. Instance perform disk shrink request. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### point_in_time_restore point_in_time_restore( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesPointInTimeRestoreRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Point in time restore for an instance managed by Google Cloud Backup and Disaster Recovery. # 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 sqladmin_v1beta4 async def sample_point_in_time_restore(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesPointInTimeRestoreRequest.html( parent="parent_value", ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_point_in_time_restore(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesPointInTimeRestoreRequest, dict]]` The request object. Request to perform a point in time restore on a Google Cloud Backup and Disaster Recovery managed instance. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### pre_check_major_version_upgrade pre_check_major_version_upgrade( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesPreCheckMajorVersionUpgradeRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Execute MVU Pre-checks # 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 sqladmin_v1beta4 async def sample_pre_check_major_version_upgrade(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) body = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.InstancesPreCheckMajorVersionUpgradeRequest.html() body.pre_check_major_version_upgrade_context.target_database_version = "SQLSERVER_2025_EXPRESS" request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesPreCheckMajorVersionUpgradeRequest.html( instance="instance_value", project="project_value", body=body, ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_pre_check_major_version_upgrade(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesPreCheckMajorVersionUpgradeRequest, dict]]` The request object. Request for Pre-checks for MVU | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### promote_replica promote_replica( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesPromoteReplicaRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart. # 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 sqladmin_v1beta4 async def sample_promote_replica(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesPromoteReplicaRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_promote_replica(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesPromoteReplicaRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### reencrypt reencrypt( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesReencryptRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Reencrypt CMEK instance with latest key version. # 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 sqladmin_v1beta4 async def sample_reencrypt(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesReencryptRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_reencrypt(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesReencryptRequest, dict]]` The request object. Instance reencrypt request. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### release_ssrs_lease release_ssrs_lease( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesReleaseSsrsLeaseRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesReleaseSsrsLeaseResponse Release a lease for the setup of SQL Server Reporting Services (SSRS). # 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 sqladmin_v1beta4 async def sample_release_ssrs_lease(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesReleaseSsrsLeaseRequest.html( instance="instance_value", project="project_value", ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_release_ssrs_lease(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesReleaseSsrsLeaseRequest, dict]]` The request object. Request to release a lease for SSRS. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesReleaseSsrsLeaseResponse` | The response for the release of the SSRS lease. | ### reschedule_maintenance reschedule_maintenance( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesRescheduleMaintenanceRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Reschedules the maintenance on the given 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 sqladmin_v1beta4 async def sample_reschedule_maintenance(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesRescheduleMaintenanceRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_reschedule_maintenance(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesRescheduleMaintenanceRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### reset_replica_size reset_replica_size( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesResetReplicaSizeRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Reset Replica Size to primary instance disk size. # 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 sqladmin_v1beta4 async def sample_reset_replica_size(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesResetReplicaSizeRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_reset_replica_size(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesResetReplicaSizeRequest, dict]]` The request object. Instance reset replica size request. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### reset_ssl_config reset_ssl_config( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesResetSslConfigRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Deletes all client certificates and generates a new server SSL certificate for the 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 sqladmin_v1beta4 async def sample_reset_ssl_config(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesResetSslConfigRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_reset_ssl_config(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesResetSslConfigRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### restart restart( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesRestartRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Restarts a Cloud SQL 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 sqladmin_v1beta4 async def sample_restart(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesRestartRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_restart(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesRestartRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### restore_backup restore_backup( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesRestoreBackupRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart. # 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 sqladmin_v1beta4 async def sample_restore_backup(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesRestoreBackupRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_restore_backup(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesRestoreBackupRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### rotate_entra_id_certificate rotate_entra_id_certificate( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesRotateEntraIdCertificateRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Rotates the Entra Id certificate version to one previously added with the addEntraIdCertificate method. # 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 sqladmin_v1beta4 async def sample_rotate_entra_id_certificate(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesRotateEntraIdCertificateRequest.html( instance="instance_value", project="project_value", ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_rotate_entra_id_certificate(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesRotateEntraIdCertificateRequest, dict]]` The request object. Request message for SqlInstancesService.RotateEntraIdCertificate. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### rotate_server_ca rotate_server_ca( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesRotateServerCaRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, use RotateServerCertificate to rotate the server certificate. # 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 sqladmin_v1beta4 async def sample_rotate_server_ca(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesRotateServerCaRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_rotate_server_ca(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesRotateServerCaRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### rotate_server_certificate rotate_server_certificate( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesRotateServerCertificateRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, use RotateServerCa instead. # 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 sqladmin_v1beta4 async def sample_rotate_server_certificate(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesRotateServerCertificateRequest.html( instance="instance_value", project="project_value", ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_rotate_server_certificate(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesRotateServerCertificateRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### secret_version_path secret_version_path(project: str, secret: str, secret_version: str) -> str Returns a fully-qualified secret_version string. ### service_connection_policy_path service_connection_policy_path( project: str, region: str, service_connection_policy: str ) -> str Returns a fully-qualified service_connection_policy string. ### start_external_sync start_external_sync( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesStartExternalSyncRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Start External primary instance migration. # 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 sqladmin_v1beta4 async def sample_start_external_sync(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesStartExternalSyncRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_start_external_sync(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesStartExternalSyncRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### start_replica start_replica( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesStartReplicaRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Starts the replication in the read replica 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 sqladmin_v1beta4 async def sample_start_replica(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesStartReplicaRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_start_replica(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesStartReplicaRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### stop_replica stop_replica( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesStopReplicaRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Stops the replication in the read replica 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 sqladmin_v1beta4 async def sample_stop_replica(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesStopReplicaRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_stop_replica(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesStopReplicaRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### switchover switchover( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesSwitchoverRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Switches over from the primary instance to the DR replica 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 sqladmin_v1beta4 async def sample_switchover(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesSwitchoverRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_switchover(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesSwitchoverRequest, dict]]` The request object. Instance switchover request. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### truncate_log truncate_log( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesTruncateLogRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Truncate MySQL general and slow query log tables MySQL 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 sqladmin_v1beta4 async def sample_truncate_log(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesTruncateLogRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_truncate_log(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesTruncateLogRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### update update( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesUpdateRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.Operation Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart. # 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 sqladmin_v1beta4 async def sample_update(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesUpdateRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_update(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesUpdateRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.Operation` | An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource. | ### verify_external_sync_settings verify_external_sync_settings( request: typing.Optional[ typing.Union[ google.cloud.sqladmin_v1beta4.types.cloud_sql.SqlInstancesVerifyExternalSyncSettingsRequest, 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.cloud.sqladmin_v1beta4.types.cloud_sql_resources.SqlInstancesVerifyExternalSyncSettingsResponse ) Verify External primary instance external sync settings. # 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 sqladmin_v1beta4 async def sample_verify_external_sync_settings(): # Create a client client = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html() # Initialize request argument(s) request = sqladmin_v1beta4.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesVerifyExternalSyncSettingsRequest.html( ) # Make the request response = await client.https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.services.sql_instances_service.SqlInstancesServiceAsyncClient.html#google_cloud_sqladmin_v1beta4_services_sql_instances_service_SqlInstancesServiceAsyncClient_verify_external_sync_settings(request=request) # Handle the response print(response) | **Parameters** || |---|---| | **Name** | **Description** | | `request` | `Optional[Union[https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesVerifyExternalSyncSettingsRequest, dict]]` The request object. | | `retry` | `google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried. | | `timeout` | `float` The timeout for this request. | | `metadata` | `Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`. | | **Returns** || |---|---| | **Type** | **Description** | | `https://docs.cloud.google.com/python/docs/reference/google-cloud-sql/latest/google.cloud.sqladmin_v1beta4.types.SqlInstancesVerifyExternalSyncSettingsResponse` | Instance verify external sync settings response. |