Class SqlInstancesServiceGrpc.SqlInstancesServiceFutureStub (0.1.0)

public static final class SqlInstancesServiceGrpc.SqlInstancesServiceFutureStub extends AbstractFutureStub<SqlInstancesServiceGrpc.SqlInstancesServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service SqlInstancesService.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > SqlInstancesServiceGrpc.SqlInstancesServiceFutureStub

Inherited Members

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractFutureStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(java.time.Duration)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withOnReadyThreshold(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

acquireSsrsLease(SqlInstancesAcquireSsrsLeaseRequest request)

public ListenableFuture<SqlInstancesAcquireSsrsLeaseResponse> acquireSsrsLease(SqlInstancesAcquireSsrsLeaseRequest request)

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

Parameter
Name	Description
request	SqlInstancesAcquireSsrsLeaseRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<SqlInstancesAcquireSsrsLeaseResponse>

addEntraIdCertificate(SqlInstancesAddEntraIdCertificateRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

addServerCa(SqlInstancesAddServerCaRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

addServerCertificate(SqlInstancesAddServerCertificateRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

build(Channel channel, CallOptions callOptions)

protected SqlInstancesServiceGrpc.SqlInstancesServiceFutureStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
channel	io.grpc.Channel
callOptions	io.grpc.CallOptions

Returns
Type	Description
SqlInstancesServiceGrpc.SqlInstancesServiceFutureStub

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

clone(SqlInstancesCloneRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

createEphemeral(SqlInstancesCreateEphemeralCertRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<SslCert>

delete(SqlInstancesDeleteRequest request)

public ListenableFuture<Operation> delete(SqlInstancesDeleteRequest request)

Deletes a Cloud SQL instance.

Parameter
Name	Description
request	SqlInstancesDeleteRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

demote(SqlInstancesDemoteRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

demoteMaster(SqlInstancesDemoteMasterRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

executeSql(SqlInstancesExecuteSqlRequest request)

public ListenableFuture<SqlInstancesExecuteSqlResponse> executeSql(SqlInstancesExecuteSqlRequest request)

Execute SQL statements.

Parameter
Name	Description
request	SqlInstancesExecuteSqlRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<SqlInstancesExecuteSqlResponse>

export(SqlInstancesExportRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

failover(SqlInstancesFailoverRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

get(SqlInstancesGetRequest request)

public ListenableFuture<DatabaseInstance> get(SqlInstancesGetRequest request)

Retrieves a resource containing information about a Cloud SQL instance.

Parameter
Name	Description
request	SqlInstancesGetRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<DatabaseInstance>

getDiskShrinkConfig(SqlInstancesGetDiskShrinkConfigRequest request)

public ListenableFuture<SqlInstancesGetDiskShrinkConfigResponse> getDiskShrinkConfig(SqlInstancesGetDiskShrinkConfigRequest request)

Get Disk Shrink Config for a given instance.

Parameter
Name	Description
request	SqlInstancesGetDiskShrinkConfigRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<SqlInstancesGetDiskShrinkConfigResponse>

getLatestRecoveryTime(SqlInstancesGetLatestRecoveryTimeRequest request)

public ListenableFuture<SqlInstancesGetLatestRecoveryTimeResponse> getLatestRecoveryTime(SqlInstancesGetLatestRecoveryTimeRequest request)

Get Latest Recovery Time for a given instance.

Parameter
Name	Description
request	SqlInstancesGetLatestRecoveryTimeRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<SqlInstancesGetLatestRecoveryTimeResponse>

import_(SqlInstancesImportRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

insert(SqlInstancesInsertRequest request)

public ListenableFuture<Operation> insert(SqlInstancesInsertRequest request)

Creates a new Cloud SQL instance.

Parameter
Name	Description
request	SqlInstancesInsertRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

list(SqlInstancesListRequest request)

public ListenableFuture<InstancesListResponse> list(SqlInstancesListRequest request)

Lists instances under a given project.

Parameter
Name	Description
request	SqlInstancesListRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<InstancesListResponse>

listEntraIdCertificates(SqlInstancesListEntraIdCertificatesRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<InstancesListEntraIdCertificatesResponse>

listServerCas(SqlInstancesListServerCasRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<InstancesListServerCasResponse>

listServerCertificates(SqlInstancesListServerCertificatesRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<InstancesListServerCertificatesResponse>

patch(SqlInstancesPatchRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

performDiskShrink(SqlInstancesPerformDiskShrinkRequest request)

public ListenableFuture<Operation> performDiskShrink(SqlInstancesPerformDiskShrinkRequest request)

Perform Disk Shrink on primary instance.

Parameter
Name	Description
request	SqlInstancesPerformDiskShrinkRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

pointInTimeRestore(SqlInstancesPointInTimeRestoreRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

preCheckMajorVersionUpgrade(SqlInstancesPreCheckMajorVersionUpgradeRequest request)

public ListenableFuture<Operation> preCheckMajorVersionUpgrade(SqlInstancesPreCheckMajorVersionUpgradeRequest request)

Execute MVU Pre-checks

Parameter
Name	Description
request	SqlInstancesPreCheckMajorVersionUpgradeRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

promoteReplica(SqlInstancesPromoteReplicaRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

reencrypt(SqlInstancesReencryptRequest request)

public ListenableFuture<Operation> reencrypt(SqlInstancesReencryptRequest request)

Reencrypt CMEK instance with latest key version.

Parameter
Name	Description
request	SqlInstancesReencryptRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

releaseSsrsLease(SqlInstancesReleaseSsrsLeaseRequest request)

public ListenableFuture<SqlInstancesReleaseSsrsLeaseResponse> releaseSsrsLease(SqlInstancesReleaseSsrsLeaseRequest request)

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

Parameter
Name	Description
request	SqlInstancesReleaseSsrsLeaseRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<SqlInstancesReleaseSsrsLeaseResponse>

rescheduleMaintenance(SqlInstancesRescheduleMaintenanceRequest request)

public ListenableFuture<Operation> rescheduleMaintenance(SqlInstancesRescheduleMaintenanceRequest request)

Reschedules the maintenance on the given instance.

Parameter
Name	Description
request	SqlInstancesRescheduleMaintenanceRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

resetReplicaSize(SqlInstancesResetReplicaSizeRequest request)

public ListenableFuture<Operation> resetReplicaSize(SqlInstancesResetReplicaSizeRequest request)

Reset Replica Size to primary instance disk size.

Parameter
Name	Description
request	SqlInstancesResetReplicaSizeRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

resetSslConfig(SqlInstancesResetSslConfigRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

restart(SqlInstancesRestartRequest request)

public ListenableFuture<Operation> restart(SqlInstancesRestartRequest request)

Restarts a Cloud SQL instance.

Parameter
Name	Description
request	SqlInstancesRestartRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

restoreBackup(SqlInstancesRestoreBackupRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

rotateEntraIdCertificate(SqlInstancesRotateEntraIdCertificateRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

rotateServerCa(SqlInstancesRotateServerCaRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

rotateServerCertificate(SqlInstancesRotateServerCertificateRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

startExternalSync(SqlInstancesStartExternalSyncRequest request)

public ListenableFuture<Operation> startExternalSync(SqlInstancesStartExternalSyncRequest request)

Start External primary instance migration.

Parameter
Name	Description
request	SqlInstancesStartExternalSyncRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

startReplica(SqlInstancesStartReplicaRequest request)

public ListenableFuture<Operation> startReplica(SqlInstancesStartReplicaRequest request)

Starts the replication in the read replica instance.

Parameter
Name	Description
request	SqlInstancesStartReplicaRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

stopReplica(SqlInstancesStopReplicaRequest request)

public ListenableFuture<Operation> stopReplica(SqlInstancesStopReplicaRequest request)

Stops the replication in the read replica instance.

Parameter
Name	Description
request	SqlInstancesStopReplicaRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

switchover(SqlInstancesSwitchoverRequest request)

public ListenableFuture<Operation> switchover(SqlInstancesSwitchoverRequest request)

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

Parameter
Name	Description
request	SqlInstancesSwitchoverRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

truncateLog(SqlInstancesTruncateLogRequest request)

public ListenableFuture<Operation> truncateLog(SqlInstancesTruncateLogRequest request)

Truncate MySQL general and slow query log tables MySQL only.

Parameter
Name	Description
request	SqlInstancesTruncateLogRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

update(SqlInstancesUpdateRequest request)

public ListenableFuture<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
com.google.common.util.concurrent.ListenableFuture<Operation>

verifyExternalSyncSettings(SqlInstancesVerifyExternalSyncSettingsRequest request)

public ListenableFuture<SqlInstancesVerifyExternalSyncSettingsResponse> verifyExternalSyncSettings(SqlInstancesVerifyExternalSyncSettingsRequest request)

Verify External primary instance external sync settings.

Parameter
Name	Description
request	SqlInstancesVerifyExternalSyncSettingsRequest

Returns
Type	Description
com.google.common.util.concurrent.ListenableFuture<SqlInstancesVerifyExternalSyncSettingsResponse>