Class SqlInstancesServiceGrpc.SqlInstancesServiceBlockingV2Stub (0.1.0)

public static final class SqlInstancesServiceGrpc.SqlInstancesServiceBlockingV2Stub extends AbstractBlockingStub<SqlInstancesServiceGrpc.SqlInstancesServiceBlockingV2Stub>

A stub to allow clients to do synchronous rpc calls to service SqlInstancesService.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > SqlInstancesServiceGrpc.SqlInstancesServiceBlockingV2Stub

Methods

acquireSsrsLease(SqlInstancesAcquireSsrsLeaseRequest request)

public SqlInstancesAcquireSsrsLeaseResponse acquireSsrsLease(SqlInstancesAcquireSsrsLeaseRequest request)

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

Parameter
Name Description
request SqlInstancesAcquireSsrsLeaseRequest
Returns
Type Description
SqlInstancesAcquireSsrsLeaseResponse
Exceptions
Type Description
io.grpc.StatusException

addEntraIdCertificate(SqlInstancesAddEntraIdCertificateRequest request)

public Operation addEntraIdCertificate(SqlInstancesAddEntraIdCertificateRequest request)

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.

Parameter
Name Description
request SqlInstancesAddEntraIdCertificateRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

addServerCa(SqlInstancesAddServerCaRequest request)

public Operation addServerCa(SqlInstancesAddServerCaRequest request)

Adds 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.

Parameter
Name Description
request SqlInstancesAddServerCaRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

addServerCertificate(SqlInstancesAddServerCertificateRequest request)

public Operation addServerCertificate(SqlInstancesAddServerCertificateRequest request)

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.

Parameter
Name Description
request SqlInstancesAddServerCertificateRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

build(Channel channel, CallOptions callOptions)

protected SqlInstancesServiceGrpc.SqlInstancesServiceBlockingV2Stub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
SqlInstancesServiceGrpc.SqlInstancesServiceBlockingV2Stub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

clone(SqlInstancesCloneRequest request)

public Operation clone(SqlInstancesCloneRequest request)

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

Parameter
Name Description
request SqlInstancesCloneRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

createEphemeral(SqlInstancesCreateEphemeralCertRequest request)

public SslCert createEphemeral(SqlInstancesCreateEphemeralCertRequest request)

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.

Parameter
Name Description
request SqlInstancesCreateEphemeralCertRequest
Returns
Type Description
SslCert
Exceptions
Type Description
io.grpc.StatusException

delete(SqlInstancesDeleteRequest request)

public Operation delete(SqlInstancesDeleteRequest request)

Deletes a Cloud SQL instance.

Parameter
Name Description
request SqlInstancesDeleteRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

demote(SqlInstancesDemoteRequest request)

public Operation demote(SqlInstancesDemoteRequest request)

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

Parameter
Name Description
request SqlInstancesDemoteRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

demoteMaster(SqlInstancesDemoteMasterRequest request)

public Operation demoteMaster(SqlInstancesDemoteMasterRequest request)

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

Parameter
Name Description
request SqlInstancesDemoteMasterRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

executeSql(SqlInstancesExecuteSqlRequest request)

public SqlInstancesExecuteSqlResponse executeSql(SqlInstancesExecuteSqlRequest request)

Execute SQL statements.

Parameter
Name Description
request SqlInstancesExecuteSqlRequest
Returns
Type Description
SqlInstancesExecuteSqlResponse
Exceptions
Type Description
io.grpc.StatusException

export(SqlInstancesExportRequest request)

public Operation export(SqlInstancesExportRequest request)

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

Parameter
Name Description
request SqlInstancesExportRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

failover(SqlInstancesFailoverRequest request)

public Operation failover(SqlInstancesFailoverRequest request)

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.

Parameter
Name Description
request SqlInstancesFailoverRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

get(SqlInstancesGetRequest request)

public DatabaseInstance get(SqlInstancesGetRequest request)

Retrieves a resource containing information about a Cloud SQL instance.

Parameter
Name Description
request SqlInstancesGetRequest
Returns
Type Description
DatabaseInstance
Exceptions
Type Description
io.grpc.StatusException

getDiskShrinkConfig(SqlInstancesGetDiskShrinkConfigRequest request)

public SqlInstancesGetDiskShrinkConfigResponse getDiskShrinkConfig(SqlInstancesGetDiskShrinkConfigRequest request)

Get Disk Shrink Config for a given instance.

Parameter
Name Description
request SqlInstancesGetDiskShrinkConfigRequest
Returns
Type Description
SqlInstancesGetDiskShrinkConfigResponse
Exceptions
Type Description
io.grpc.StatusException

getLatestRecoveryTime(SqlInstancesGetLatestRecoveryTimeRequest request)

public SqlInstancesGetLatestRecoveryTimeResponse getLatestRecoveryTime(SqlInstancesGetLatestRecoveryTimeRequest request)

Get Latest Recovery Time for a given instance.

Parameter
Name Description
request SqlInstancesGetLatestRecoveryTimeRequest
Returns
Type Description
SqlInstancesGetLatestRecoveryTimeResponse
Exceptions
Type Description
io.grpc.StatusException

import_(SqlInstancesImportRequest request)

public Operation import_(SqlInstancesImportRequest request)

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

Parameter
Name Description
request SqlInstancesImportRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

insert(SqlInstancesInsertRequest request)

public Operation insert(SqlInstancesInsertRequest request)

Creates a new Cloud SQL instance.

Parameter
Name Description
request SqlInstancesInsertRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

list(SqlInstancesListRequest request)

public InstancesListResponse list(SqlInstancesListRequest request)

Lists instances under a given project.

Parameter
Name Description
request SqlInstancesListRequest
Returns
Type Description
InstancesListResponse
Exceptions
Type Description
io.grpc.StatusException

listEntraIdCertificates(SqlInstancesListEntraIdCertificatesRequest request)

public InstancesListEntraIdCertificatesResponse listEntraIdCertificates(SqlInstancesListEntraIdCertificatesRequest request)

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.

Parameter
Name Description
request SqlInstancesListEntraIdCertificatesRequest
Returns
Type Description
InstancesListEntraIdCertificatesResponse
Exceptions
Type Description
io.grpc.StatusException

listServerCas(SqlInstancesListServerCasRequest request)

public InstancesListServerCasResponse listServerCas(SqlInstancesListServerCasRequest request)

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.

Parameter
Name Description
request SqlInstancesListServerCasRequest
Returns
Type Description
InstancesListServerCasResponse
Exceptions
Type Description
io.grpc.StatusException

listServerCertificates(SqlInstancesListServerCertificatesRequest request)

public InstancesListServerCertificatesResponse listServerCertificates(SqlInstancesListServerCertificatesRequest request)

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.

Parameter
Name Description
request SqlInstancesListServerCertificatesRequest
Returns
Type Description
InstancesListServerCertificatesResponse
Exceptions
Type Description
io.grpc.StatusException

patch(SqlInstancesPatchRequest request)

public Operation patch(SqlInstancesPatchRequest request)

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

Parameter
Name Description
request SqlInstancesPatchRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

performDiskShrink(SqlInstancesPerformDiskShrinkRequest request)

public Operation performDiskShrink(SqlInstancesPerformDiskShrinkRequest request)

Perform Disk Shrink on primary instance.

Parameter
Name Description
request SqlInstancesPerformDiskShrinkRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

pointInTimeRestore(SqlInstancesPointInTimeRestoreRequest request)

public Operation pointInTimeRestore(SqlInstancesPointInTimeRestoreRequest request)

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

Parameter
Name Description
request SqlInstancesPointInTimeRestoreRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

preCheckMajorVersionUpgrade(SqlInstancesPreCheckMajorVersionUpgradeRequest request)

public Operation preCheckMajorVersionUpgrade(SqlInstancesPreCheckMajorVersionUpgradeRequest request)

Execute MVU Pre-checks

Parameter
Name Description
request SqlInstancesPreCheckMajorVersionUpgradeRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

promoteReplica(SqlInstancesPromoteReplicaRequest request)

public Operation promoteReplica(SqlInstancesPromoteReplicaRequest request)

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

Parameter
Name Description
request SqlInstancesPromoteReplicaRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

reencrypt(SqlInstancesReencryptRequest request)

public Operation reencrypt(SqlInstancesReencryptRequest request)

Reencrypt CMEK instance with latest key version.

Parameter
Name Description
request SqlInstancesReencryptRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

releaseSsrsLease(SqlInstancesReleaseSsrsLeaseRequest request)

public SqlInstancesReleaseSsrsLeaseResponse releaseSsrsLease(SqlInstancesReleaseSsrsLeaseRequest request)

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

Parameter
Name Description
request SqlInstancesReleaseSsrsLeaseRequest
Returns
Type Description
SqlInstancesReleaseSsrsLeaseResponse
Exceptions
Type Description
io.grpc.StatusException

rescheduleMaintenance(SqlInstancesRescheduleMaintenanceRequest request)

public Operation rescheduleMaintenance(SqlInstancesRescheduleMaintenanceRequest request)

Reschedules the maintenance on the given instance.

Parameter
Name Description
request SqlInstancesRescheduleMaintenanceRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

resetReplicaSize(SqlInstancesResetReplicaSizeRequest request)

public Operation resetReplicaSize(SqlInstancesResetReplicaSizeRequest request)

Reset Replica Size to primary instance disk size.

Parameter
Name Description
request SqlInstancesResetReplicaSizeRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

resetSslConfig(SqlInstancesResetSslConfigRequest request)

public Operation resetSslConfig(SqlInstancesResetSslConfigRequest request)

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

Parameter
Name Description
request SqlInstancesResetSslConfigRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

restart(SqlInstancesRestartRequest request)

public Operation restart(SqlInstancesRestartRequest request)

Restarts a Cloud SQL instance.

Parameter
Name Description
request SqlInstancesRestartRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

restoreBackup(SqlInstancesRestoreBackupRequest request)

public Operation restoreBackup(SqlInstancesRestoreBackupRequest request)

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

Parameter
Name Description
request SqlInstancesRestoreBackupRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

rotateEntraIdCertificate(SqlInstancesRotateEntraIdCertificateRequest request)

public Operation rotateEntraIdCertificate(SqlInstancesRotateEntraIdCertificateRequest request)

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

Parameter
Name Description
request SqlInstancesRotateEntraIdCertificateRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

rotateServerCa(SqlInstancesRotateServerCaRequest request)

public Operation rotateServerCa(SqlInstancesRotateServerCaRequest request)

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.

Parameter
Name Description
request SqlInstancesRotateServerCaRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

rotateServerCertificate(SqlInstancesRotateServerCertificateRequest request)

public Operation rotateServerCertificate(SqlInstancesRotateServerCertificateRequest request)

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.

Parameter
Name Description
request SqlInstancesRotateServerCertificateRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

startExternalSync(SqlInstancesStartExternalSyncRequest request)

public Operation startExternalSync(SqlInstancesStartExternalSyncRequest request)

Start External primary instance migration.

Parameter
Name Description
request SqlInstancesStartExternalSyncRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

startReplica(SqlInstancesStartReplicaRequest request)

public Operation startReplica(SqlInstancesStartReplicaRequest request)

Starts the replication in the read replica instance.

Parameter
Name Description
request SqlInstancesStartReplicaRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

stopReplica(SqlInstancesStopReplicaRequest request)

public Operation stopReplica(SqlInstancesStopReplicaRequest request)

Stops the replication in the read replica instance.

Parameter
Name Description
request SqlInstancesStopReplicaRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

switchover(SqlInstancesSwitchoverRequest request)

public Operation switchover(SqlInstancesSwitchoverRequest request)

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

Parameter
Name Description
request SqlInstancesSwitchoverRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

truncateLog(SqlInstancesTruncateLogRequest request)

public Operation truncateLog(SqlInstancesTruncateLogRequest request)

Truncate MySQL general and slow query log tables MySQL only.

Parameter
Name Description
request SqlInstancesTruncateLogRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

update(SqlInstancesUpdateRequest request)

public Operation update(SqlInstancesUpdateRequest request)

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

Parameter
Name Description
request SqlInstancesUpdateRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

verifyExternalSyncSettings(SqlInstancesVerifyExternalSyncSettingsRequest request)

public SqlInstancesVerifyExternalSyncSettingsResponse verifyExternalSyncSettings(SqlInstancesVerifyExternalSyncSettingsRequest request)

Verify External primary instance external sync settings.

Parameter
Name Description
request SqlInstancesVerifyExternalSyncSettingsRequest
Returns
Type Description
SqlInstancesVerifyExternalSyncSettingsResponse
Exceptions
Type Description
io.grpc.StatusException