Interface SqlInstancesServiceGrpc.AsyncService (0.1.0)

public static interface SqlInstancesServiceGrpc.AsyncService

Methods

acquireSsrsLease(SqlInstancesAcquireSsrsLeaseRequest request, StreamObserver<SqlInstancesAcquireSsrsLeaseResponse> responseObserver)

public default void acquireSsrsLease(SqlInstancesAcquireSsrsLeaseRequest request, StreamObserver<SqlInstancesAcquireSsrsLeaseResponse> responseObserver)

Acquire a lease for the setup of SQL Server Reporting Services (SSRS).

Parameters
Name	Description
request	SqlInstancesAcquireSsrsLeaseRequest
responseObserver	io.grpc.stub.StreamObserver<SqlInstancesAcquireSsrsLeaseResponse>

addEntraIdCertificate(SqlInstancesAddEntraIdCertificateRequest request, StreamObserver<Operation> responseObserver)

public default void addEntraIdCertificate(SqlInstancesAddEntraIdCertificateRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	SqlInstancesAddEntraIdCertificateRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

addServerCa(SqlInstancesAddServerCaRequest request, StreamObserver<Operation> responseObserver)

public default void addServerCa(SqlInstancesAddServerCaRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	SqlInstancesAddServerCaRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

addServerCertificate(SqlInstancesAddServerCertificateRequest request, StreamObserver<Operation> responseObserver)

public default void addServerCertificate(SqlInstancesAddServerCertificateRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	SqlInstancesAddServerCertificateRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

clone(SqlInstancesCloneRequest request, StreamObserver<Operation> responseObserver)

public default void clone(SqlInstancesCloneRequest request, StreamObserver<Operation> responseObserver)

Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.

Parameters
Name	Description
request	SqlInstancesCloneRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

createEphemeral(SqlInstancesCreateEphemeralCertRequest request, StreamObserver<SslCert> responseObserver)

public default void createEphemeral(SqlInstancesCreateEphemeralCertRequest request, StreamObserver<SslCert> responseObserver)

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.

Parameters
Name	Description
request	SqlInstancesCreateEphemeralCertRequest
responseObserver	io.grpc.stub.StreamObserver<SslCert>

delete(SqlInstancesDeleteRequest request, StreamObserver<Operation> responseObserver)

public default void delete(SqlInstancesDeleteRequest request, StreamObserver<Operation> responseObserver)

Deletes a Cloud SQL instance.

Parameters
Name	Description
request	SqlInstancesDeleteRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

demote(SqlInstancesDemoteRequest request, StreamObserver<Operation> responseObserver)

public default void demote(SqlInstancesDemoteRequest request, StreamObserver<Operation> responseObserver)

Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.

Parameters
Name	Description
request	SqlInstancesDemoteRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

demoteMaster(SqlInstancesDemoteMasterRequest request, StreamObserver<Operation> responseObserver)

public default void demoteMaster(SqlInstancesDemoteMasterRequest request, StreamObserver<Operation> responseObserver)

Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.

Parameters
Name	Description
request	SqlInstancesDemoteMasterRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

executeSql(SqlInstancesExecuteSqlRequest request, StreamObserver<SqlInstancesExecuteSqlResponse> responseObserver)

public default void executeSql(SqlInstancesExecuteSqlRequest request, StreamObserver<SqlInstancesExecuteSqlResponse> responseObserver)

Execute SQL statements.

Parameters
Name	Description
request	SqlInstancesExecuteSqlRequest
responseObserver	io.grpc.stub.StreamObserver<SqlInstancesExecuteSqlResponse>

export(SqlInstancesExportRequest request, StreamObserver<Operation> responseObserver)

public default void export(SqlInstancesExportRequest request, StreamObserver<Operation> responseObserver)

Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.

Parameters
Name	Description
request	SqlInstancesExportRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

failover(SqlInstancesFailoverRequest request, StreamObserver<Operation> responseObserver)

public default void failover(SqlInstancesFailoverRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	SqlInstancesFailoverRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

get(SqlInstancesGetRequest request, StreamObserver<DatabaseInstance> responseObserver)

public default void get(SqlInstancesGetRequest request, StreamObserver<DatabaseInstance> responseObserver)

Retrieves a resource containing information about a Cloud SQL instance.

Parameters
Name	Description
request	SqlInstancesGetRequest
responseObserver	io.grpc.stub.StreamObserver<DatabaseInstance>

getDiskShrinkConfig(SqlInstancesGetDiskShrinkConfigRequest request, StreamObserver<SqlInstancesGetDiskShrinkConfigResponse> responseObserver)

public default void getDiskShrinkConfig(SqlInstancesGetDiskShrinkConfigRequest request, StreamObserver<SqlInstancesGetDiskShrinkConfigResponse> responseObserver)

Get Disk Shrink Config for a given instance.

Parameters
Name	Description
request	SqlInstancesGetDiskShrinkConfigRequest
responseObserver	io.grpc.stub.StreamObserver<SqlInstancesGetDiskShrinkConfigResponse>

getLatestRecoveryTime(SqlInstancesGetLatestRecoveryTimeRequest request, StreamObserver<SqlInstancesGetLatestRecoveryTimeResponse> responseObserver)

public default void getLatestRecoveryTime(SqlInstancesGetLatestRecoveryTimeRequest request, StreamObserver<SqlInstancesGetLatestRecoveryTimeResponse> responseObserver)

Get Latest Recovery Time for a given instance.

Parameters
Name	Description
request	SqlInstancesGetLatestRecoveryTimeRequest
responseObserver	io.grpc.stub.StreamObserver<SqlInstancesGetLatestRecoveryTimeResponse>

import_(SqlInstancesImportRequest request, StreamObserver<Operation> responseObserver)

public default void import_(SqlInstancesImportRequest request, StreamObserver<Operation> responseObserver)

Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.

Parameters
Name	Description
request	SqlInstancesImportRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

insert(SqlInstancesInsertRequest request, StreamObserver<Operation> responseObserver)

public default void insert(SqlInstancesInsertRequest request, StreamObserver<Operation> responseObserver)

Creates a new Cloud SQL instance.

Parameters
Name	Description
request	SqlInstancesInsertRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

list(SqlInstancesListRequest request, StreamObserver<InstancesListResponse> responseObserver)

public default void list(SqlInstancesListRequest request, StreamObserver<InstancesListResponse> responseObserver)

Lists instances under a given project.

Parameters
Name	Description
request	SqlInstancesListRequest
responseObserver	io.grpc.stub.StreamObserver<InstancesListResponse>

listEntraIdCertificates(SqlInstancesListEntraIdCertificatesRequest request, StreamObserver<InstancesListEntraIdCertificatesResponse> responseObserver)

public default void listEntraIdCertificates(SqlInstancesListEntraIdCertificatesRequest request, StreamObserver<InstancesListEntraIdCertificatesResponse> responseObserver)

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.

Parameters
Name	Description
request	SqlInstancesListEntraIdCertificatesRequest
responseObserver	io.grpc.stub.StreamObserver<InstancesListEntraIdCertificatesResponse>

listServerCas(SqlInstancesListServerCasRequest request, StreamObserver<InstancesListServerCasResponse> responseObserver)

public default void listServerCas(SqlInstancesListServerCasRequest request, StreamObserver<InstancesListServerCasResponse> responseObserver)

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.

Parameters
Name	Description
request	SqlInstancesListServerCasRequest
responseObserver	io.grpc.stub.StreamObserver<InstancesListServerCasResponse>

listServerCertificates(SqlInstancesListServerCertificatesRequest request, StreamObserver<InstancesListServerCertificatesResponse> responseObserver)

public default void listServerCertificates(SqlInstancesListServerCertificatesRequest request, StreamObserver<InstancesListServerCertificatesResponse> responseObserver)

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.

Parameters
Name	Description
request	SqlInstancesListServerCertificatesRequest
responseObserver	io.grpc.stub.StreamObserver<InstancesListServerCertificatesResponse>

patch(SqlInstancesPatchRequest request, StreamObserver<Operation> responseObserver)

public default void patch(SqlInstancesPatchRequest request, StreamObserver<Operation> responseObserver)

Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.

Parameters
Name	Description
request	SqlInstancesPatchRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

performDiskShrink(SqlInstancesPerformDiskShrinkRequest request, StreamObserver<Operation> responseObserver)

public default void performDiskShrink(SqlInstancesPerformDiskShrinkRequest request, StreamObserver<Operation> responseObserver)

Perform Disk Shrink on primary instance.

Parameters
Name	Description
request	SqlInstancesPerformDiskShrinkRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

pointInTimeRestore(SqlInstancesPointInTimeRestoreRequest request, StreamObserver<Operation> responseObserver)

public default void pointInTimeRestore(SqlInstancesPointInTimeRestoreRequest request, StreamObserver<Operation> responseObserver)

Point in time restore for an instance managed by Google Cloud Backup and Disaster Recovery.

Parameters
Name	Description
request	SqlInstancesPointInTimeRestoreRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

preCheckMajorVersionUpgrade(SqlInstancesPreCheckMajorVersionUpgradeRequest request, StreamObserver<Operation> responseObserver)

public default void preCheckMajorVersionUpgrade(SqlInstancesPreCheckMajorVersionUpgradeRequest request, StreamObserver<Operation> responseObserver)

Execute MVU Pre-checks

Parameters
Name	Description
request	SqlInstancesPreCheckMajorVersionUpgradeRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

promoteReplica(SqlInstancesPromoteReplicaRequest request, StreamObserver<Operation> responseObserver)

public default void promoteReplica(SqlInstancesPromoteReplicaRequest request, StreamObserver<Operation> responseObserver)

Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.

Parameters
Name	Description
request	SqlInstancesPromoteReplicaRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

reencrypt(SqlInstancesReencryptRequest request, StreamObserver<Operation> responseObserver)

public default void reencrypt(SqlInstancesReencryptRequest request, StreamObserver<Operation> responseObserver)

Reencrypt CMEK instance with latest key version.

Parameters
Name	Description
request	SqlInstancesReencryptRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

releaseSsrsLease(SqlInstancesReleaseSsrsLeaseRequest request, StreamObserver<SqlInstancesReleaseSsrsLeaseResponse> responseObserver)

public default void releaseSsrsLease(SqlInstancesReleaseSsrsLeaseRequest request, StreamObserver<SqlInstancesReleaseSsrsLeaseResponse> responseObserver)

Release a lease for the setup of SQL Server Reporting Services (SSRS).

Parameters
Name	Description
request	SqlInstancesReleaseSsrsLeaseRequest
responseObserver	io.grpc.stub.StreamObserver<SqlInstancesReleaseSsrsLeaseResponse>

rescheduleMaintenance(SqlInstancesRescheduleMaintenanceRequest request, StreamObserver<Operation> responseObserver)

public default void rescheduleMaintenance(SqlInstancesRescheduleMaintenanceRequest request, StreamObserver<Operation> responseObserver)

Reschedules the maintenance on the given instance.

Parameters
Name	Description
request	SqlInstancesRescheduleMaintenanceRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

resetReplicaSize(SqlInstancesResetReplicaSizeRequest request, StreamObserver<Operation> responseObserver)

public default void resetReplicaSize(SqlInstancesResetReplicaSizeRequest request, StreamObserver<Operation> responseObserver)

Reset Replica Size to primary instance disk size.

Parameters
Name	Description
request	SqlInstancesResetReplicaSizeRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

resetSslConfig(SqlInstancesResetSslConfigRequest request, StreamObserver<Operation> responseObserver)

public default void resetSslConfig(SqlInstancesResetSslConfigRequest request, StreamObserver<Operation> responseObserver)

Deletes all client certificates and generates a new server SSL certificate for the instance.

Parameters
Name	Description
request	SqlInstancesResetSslConfigRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

restart(SqlInstancesRestartRequest request, StreamObserver<Operation> responseObserver)

public default void restart(SqlInstancesRestartRequest request, StreamObserver<Operation> responseObserver)

Restarts a Cloud SQL instance.

Parameters
Name	Description
request	SqlInstancesRestartRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

restoreBackup(SqlInstancesRestoreBackupRequest request, StreamObserver<Operation> responseObserver)

public default void restoreBackup(SqlInstancesRestoreBackupRequest request, StreamObserver<Operation> responseObserver)

Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

Parameters
Name	Description
request	SqlInstancesRestoreBackupRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

rotateEntraIdCertificate(SqlInstancesRotateEntraIdCertificateRequest request, StreamObserver<Operation> responseObserver)

public default void rotateEntraIdCertificate(SqlInstancesRotateEntraIdCertificateRequest request, StreamObserver<Operation> responseObserver)

Rotates the Entra Id certificate version to one previously added with the addEntraIdCertificate method.

Parameters
Name	Description
request	SqlInstancesRotateEntraIdCertificateRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

rotateServerCa(SqlInstancesRotateServerCaRequest request, StreamObserver<Operation> responseObserver)

public default void rotateServerCa(SqlInstancesRotateServerCaRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	SqlInstancesRotateServerCaRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

rotateServerCertificate(SqlInstancesRotateServerCertificateRequest request, StreamObserver<Operation> responseObserver)

public default void rotateServerCertificate(SqlInstancesRotateServerCertificateRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
request	SqlInstancesRotateServerCertificateRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

startExternalSync(SqlInstancesStartExternalSyncRequest request, StreamObserver<Operation> responseObserver)

public default void startExternalSync(SqlInstancesStartExternalSyncRequest request, StreamObserver<Operation> responseObserver)

Start External primary instance migration.

Parameters
Name	Description
request	SqlInstancesStartExternalSyncRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

startReplica(SqlInstancesStartReplicaRequest request, StreamObserver<Operation> responseObserver)

public default void startReplica(SqlInstancesStartReplicaRequest request, StreamObserver<Operation> responseObserver)

Starts the replication in the read replica instance.

Parameters
Name	Description
request	SqlInstancesStartReplicaRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

stopReplica(SqlInstancesStopReplicaRequest request, StreamObserver<Operation> responseObserver)

public default void stopReplica(SqlInstancesStopReplicaRequest request, StreamObserver<Operation> responseObserver)

Stops the replication in the read replica instance.

Parameters
Name	Description
request	SqlInstancesStopReplicaRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

switchover(SqlInstancesSwitchoverRequest request, StreamObserver<Operation> responseObserver)

public default void switchover(SqlInstancesSwitchoverRequest request, StreamObserver<Operation> responseObserver)

Switches over from the primary instance to the DR replica instance.

Parameters
Name	Description
request	SqlInstancesSwitchoverRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

truncateLog(SqlInstancesTruncateLogRequest request, StreamObserver<Operation> responseObserver)

public default void truncateLog(SqlInstancesTruncateLogRequest request, StreamObserver<Operation> responseObserver)

Truncate MySQL general and slow query log tables MySQL only.

Parameters
Name	Description
request	SqlInstancesTruncateLogRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

update(SqlInstancesUpdateRequest request, StreamObserver<Operation> responseObserver)

public default void update(SqlInstancesUpdateRequest request, StreamObserver<Operation> responseObserver)

Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.

Parameters
Name	Description
request	SqlInstancesUpdateRequest
responseObserver	io.grpc.stub.StreamObserver<Operation>

verifyExternalSyncSettings(SqlInstancesVerifyExternalSyncSettingsRequest request, StreamObserver<SqlInstancesVerifyExternalSyncSettingsResponse> responseObserver)

public default void verifyExternalSyncSettings(SqlInstancesVerifyExternalSyncSettingsRequest request, StreamObserver<SqlInstancesVerifyExternalSyncSettingsResponse> responseObserver)

Verify External primary instance external sync settings.

Parameters
Name	Description
request	SqlInstancesVerifyExternalSyncSettingsRequest
responseObserver	io.grpc.stub.StreamObserver<SqlInstancesVerifyExternalSyncSettingsResponse>