Class protos.google.cloud.sql.v1.SqlInstancesService (0.16.0)

Represents a SqlInstancesService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.sql.v1.SqlInstancesService

Package

@google-cloud/sql

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new SqlInstancesService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

acquireSsrsLease(request, callback)

public acquireSsrsLease(request: google.cloud.sql.v1.ISqlInstancesAcquireSsrsLeaseRequest, callback: google.cloud.sql.v1.SqlInstancesService.AcquireSsrsLeaseCallback): void;

Calls AcquireSsrsLease.

Parameters
Name Description
request ISqlInstancesAcquireSsrsLeaseRequest

SqlInstancesAcquireSsrsLeaseRequest message or plain object
callback AcquireSsrsLeaseCallback

Node-style callback called with the error, if any, and SqlInstancesAcquireSsrsLeaseResponse
Returns
Type Description
void

acquireSsrsLease(request)

public acquireSsrsLease(request: google.cloud.sql.v1.ISqlInstancesAcquireSsrsLeaseRequest): Promise<google.cloud.sql.v1.SqlInstancesAcquireSsrsLeaseResponse>;

Calls AcquireSsrsLease.

Parameter
Name Description
request ISqlInstancesAcquireSsrsLeaseRequest

SqlInstancesAcquireSsrsLeaseRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.SqlInstancesAcquireSsrsLeaseResponse>

Promise

addServerCa(request, callback)

public addServerCa(request: google.cloud.sql.v1.ISqlInstancesAddServerCaRequest, callback: google.cloud.sql.v1.SqlInstancesService.AddServerCaCallback): void;

Calls AddServerCa.

Parameters
Name Description
request ISqlInstancesAddServerCaRequest

SqlInstancesAddServerCaRequest message or plain object
callback AddServerCaCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

addServerCa(request)

public addServerCa(request: google.cloud.sql.v1.ISqlInstancesAddServerCaRequest): Promise<google.cloud.sql.v1.Operation>;

Calls AddServerCa.

Parameter
Name Description
request ISqlInstancesAddServerCaRequest

SqlInstancesAddServerCaRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

clone(request, callback)

public clone(request: google.cloud.sql.v1.ISqlInstancesCloneRequest, callback: google.cloud.sql.v1.SqlInstancesService.CloneCallback): void;

Calls Clone.

Parameters
Name Description
request ISqlInstancesCloneRequest

SqlInstancesCloneRequest message or plain object
callback CloneCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

clone(request)

public clone(request: google.cloud.sql.v1.ISqlInstancesCloneRequest): Promise<google.cloud.sql.v1.Operation>;

Calls Clone.

Parameter
Name Description
request ISqlInstancesCloneRequest

SqlInstancesCloneRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): SqlInstancesService;

Creates new SqlInstancesService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
SqlInstancesService

RPC service. Useful where requests and/or responses are streamed.

createEphemeral(request, callback)

public createEphemeral(request: google.cloud.sql.v1.ISqlInstancesCreateEphemeralCertRequest, callback: google.cloud.sql.v1.SqlInstancesService.CreateEphemeralCallback): void;

Calls CreateEphemeral.

Parameters
Name Description
request ISqlInstancesCreateEphemeralCertRequest

SqlInstancesCreateEphemeralCertRequest message or plain object
callback CreateEphemeralCallback

Node-style callback called with the error, if any, and SslCert
Returns
Type Description
void

createEphemeral(request)

public createEphemeral(request: google.cloud.sql.v1.ISqlInstancesCreateEphemeralCertRequest): Promise<google.cloud.sql.v1.SslCert>;

Calls CreateEphemeral.

Parameter
Name Description
request ISqlInstancesCreateEphemeralCertRequest

SqlInstancesCreateEphemeralCertRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.SslCert>

Promise

delete(request, callback)

public delete(request: google.cloud.sql.v1.ISqlInstancesDeleteRequest, callback: google.cloud.sql.v1.SqlInstancesService.DeleteCallback): void;

Calls Delete.

Parameters
Name Description
request ISqlInstancesDeleteRequest

SqlInstancesDeleteRequest message or plain object
callback DeleteCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

delete(request)

public delete(request: google.cloud.sql.v1.ISqlInstancesDeleteRequest): Promise<google.cloud.sql.v1.Operation>;

Calls Delete.

Parameter
Name Description
request ISqlInstancesDeleteRequest

SqlInstancesDeleteRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

demote(request, callback)

public demote(request: google.cloud.sql.v1.ISqlInstancesDemoteRequest, callback: google.cloud.sql.v1.SqlInstancesService.DemoteCallback): void;

Calls Demote.

Parameters
Name Description
request ISqlInstancesDemoteRequest

SqlInstancesDemoteRequest message or plain object
callback DemoteCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

demote(request)

public demote(request: google.cloud.sql.v1.ISqlInstancesDemoteRequest): Promise<google.cloud.sql.v1.Operation>;

Calls Demote.

Parameter
Name Description
request ISqlInstancesDemoteRequest

SqlInstancesDemoteRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

demoteMaster(request, callback)

public demoteMaster(request: google.cloud.sql.v1.ISqlInstancesDemoteMasterRequest, callback: google.cloud.sql.v1.SqlInstancesService.DemoteMasterCallback): void;

Calls DemoteMaster.

Parameters
Name Description
request ISqlInstancesDemoteMasterRequest

SqlInstancesDemoteMasterRequest message or plain object
callback DemoteMasterCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

demoteMaster(request)

public demoteMaster(request: google.cloud.sql.v1.ISqlInstancesDemoteMasterRequest): Promise<google.cloud.sql.v1.Operation>;

Calls DemoteMaster.

Parameter
Name Description
request ISqlInstancesDemoteMasterRequest

SqlInstancesDemoteMasterRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

export(request, callback)

public export(request: google.cloud.sql.v1.ISqlInstancesExportRequest, callback: google.cloud.sql.v1.SqlInstancesService.ExportCallback): void;

Calls Export.

Parameters
Name Description
request ISqlInstancesExportRequest

SqlInstancesExportRequest message or plain object
callback ExportCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

export(request)

public export(request: google.cloud.sql.v1.ISqlInstancesExportRequest): Promise<google.cloud.sql.v1.Operation>;

Calls Export.

Parameter
Name Description
request ISqlInstancesExportRequest

SqlInstancesExportRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

failover(request, callback)

public failover(request: google.cloud.sql.v1.ISqlInstancesFailoverRequest, callback: google.cloud.sql.v1.SqlInstancesService.FailoverCallback): void;

Calls Failover.

Parameters
Name Description
request ISqlInstancesFailoverRequest

SqlInstancesFailoverRequest message or plain object
callback FailoverCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

failover(request)

public failover(request: google.cloud.sql.v1.ISqlInstancesFailoverRequest): Promise<google.cloud.sql.v1.Operation>;

Calls Failover.

Parameter
Name Description
request ISqlInstancesFailoverRequest

SqlInstancesFailoverRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

get(request, callback)

public get(request: google.cloud.sql.v1.ISqlInstancesGetRequest, callback: google.cloud.sql.v1.SqlInstancesService.GetCallback): void;

Calls Get.

Parameters
Name Description
request ISqlInstancesGetRequest

SqlInstancesGetRequest message or plain object
callback GetCallback

Node-style callback called with the error, if any, and DatabaseInstance
Returns
Type Description
void

get(request)

public get(request: google.cloud.sql.v1.ISqlInstancesGetRequest): Promise<google.cloud.sql.v1.DatabaseInstance>;

Calls Get.

Parameter
Name Description
request ISqlInstancesGetRequest

SqlInstancesGetRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.DatabaseInstance>

Promise

getDiskShrinkConfig(request, callback)

public getDiskShrinkConfig(request: google.cloud.sql.v1.ISqlInstancesGetDiskShrinkConfigRequest, callback: google.cloud.sql.v1.SqlInstancesService.GetDiskShrinkConfigCallback): void;

Calls GetDiskShrinkConfig.

Parameters
Name Description
request ISqlInstancesGetDiskShrinkConfigRequest

SqlInstancesGetDiskShrinkConfigRequest message or plain object
callback GetDiskShrinkConfigCallback

Node-style callback called with the error, if any, and SqlInstancesGetDiskShrinkConfigResponse
Returns
Type Description
void

getDiskShrinkConfig(request)

public getDiskShrinkConfig(request: google.cloud.sql.v1.ISqlInstancesGetDiskShrinkConfigRequest): Promise<google.cloud.sql.v1.SqlInstancesGetDiskShrinkConfigResponse>;

Calls GetDiskShrinkConfig.

Parameter
Name Description
request ISqlInstancesGetDiskShrinkConfigRequest

SqlInstancesGetDiskShrinkConfigRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.SqlInstancesGetDiskShrinkConfigResponse>

Promise

getLatestRecoveryTime(request, callback)

public getLatestRecoveryTime(request: google.cloud.sql.v1.ISqlInstancesGetLatestRecoveryTimeRequest, callback: google.cloud.sql.v1.SqlInstancesService.GetLatestRecoveryTimeCallback): void;

Calls GetLatestRecoveryTime.

Parameters
Name Description
request ISqlInstancesGetLatestRecoveryTimeRequest

SqlInstancesGetLatestRecoveryTimeRequest message or plain object
callback GetLatestRecoveryTimeCallback

Node-style callback called with the error, if any, and SqlInstancesGetLatestRecoveryTimeResponse
Returns
Type Description
void

getLatestRecoveryTime(request)

public getLatestRecoveryTime(request: google.cloud.sql.v1.ISqlInstancesGetLatestRecoveryTimeRequest): Promise<google.cloud.sql.v1.SqlInstancesGetLatestRecoveryTimeResponse>;

Calls GetLatestRecoveryTime.

Parameter
Name Description
request ISqlInstancesGetLatestRecoveryTimeRequest

SqlInstancesGetLatestRecoveryTimeRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.SqlInstancesGetLatestRecoveryTimeResponse>

Promise

import(request, callback)

public import(request: google.cloud.sql.v1.ISqlInstancesImportRequest, callback: google.cloud.sql.v1.SqlInstancesService.ImportCallback): void;

Calls Import.

Parameters
Name Description
request ISqlInstancesImportRequest

SqlInstancesImportRequest message or plain object
callback ImportCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

import(request)

public import(request: google.cloud.sql.v1.ISqlInstancesImportRequest): Promise<google.cloud.sql.v1.Operation>;

Calls Import.

Parameter
Name Description
request ISqlInstancesImportRequest

SqlInstancesImportRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

insert(request, callback)

public insert(request: google.cloud.sql.v1.ISqlInstancesInsertRequest, callback: google.cloud.sql.v1.SqlInstancesService.InsertCallback): void;

Calls Insert.

Parameters
Name Description
request ISqlInstancesInsertRequest

SqlInstancesInsertRequest message or plain object
callback InsertCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

insert(request)

public insert(request: google.cloud.sql.v1.ISqlInstancesInsertRequest): Promise<google.cloud.sql.v1.Operation>;

Calls Insert.

Parameter
Name Description
request ISqlInstancesInsertRequest

SqlInstancesInsertRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

list(request, callback)

public list(request: google.cloud.sql.v1.ISqlInstancesListRequest, callback: google.cloud.sql.v1.SqlInstancesService.ListCallback): void;

Calls List.

Parameters
Name Description
request ISqlInstancesListRequest

SqlInstancesListRequest message or plain object
callback ListCallback

Node-style callback called with the error, if any, and InstancesListResponse
Returns
Type Description
void

list(request)

public list(request: google.cloud.sql.v1.ISqlInstancesListRequest): Promise<google.cloud.sql.v1.InstancesListResponse>;

Calls List.

Parameter
Name Description
request ISqlInstancesListRequest

SqlInstancesListRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.InstancesListResponse>

Promise

listServerCas(request, callback)

public listServerCas(request: google.cloud.sql.v1.ISqlInstancesListServerCasRequest, callback: google.cloud.sql.v1.SqlInstancesService.ListServerCasCallback): void;

Calls ListServerCas.

Parameters
Name Description
request ISqlInstancesListServerCasRequest

SqlInstancesListServerCasRequest message or plain object
callback ListServerCasCallback

Node-style callback called with the error, if any, and InstancesListServerCasResponse
Returns
Type Description
void

listServerCas(request)

public listServerCas(request: google.cloud.sql.v1.ISqlInstancesListServerCasRequest): Promise<google.cloud.sql.v1.InstancesListServerCasResponse>;

Calls ListServerCas.

Parameter
Name Description
request ISqlInstancesListServerCasRequest

SqlInstancesListServerCasRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.InstancesListServerCasResponse>

Promise

patch(request, callback)

public patch(request: google.cloud.sql.v1.ISqlInstancesPatchRequest, callback: google.cloud.sql.v1.SqlInstancesService.PatchCallback): void;

Calls Patch.

Parameters
Name Description
request ISqlInstancesPatchRequest

SqlInstancesPatchRequest message or plain object
callback PatchCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

patch(request)

public patch(request: google.cloud.sql.v1.ISqlInstancesPatchRequest): Promise<google.cloud.sql.v1.Operation>;

Calls Patch.

Parameter
Name Description
request ISqlInstancesPatchRequest

SqlInstancesPatchRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

performDiskShrink(request, callback)

public performDiskShrink(request: google.cloud.sql.v1.ISqlInstancesPerformDiskShrinkRequest, callback: google.cloud.sql.v1.SqlInstancesService.PerformDiskShrinkCallback): void;

Calls PerformDiskShrink.

Parameters
Name Description
request ISqlInstancesPerformDiskShrinkRequest

SqlInstancesPerformDiskShrinkRequest message or plain object
callback PerformDiskShrinkCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

performDiskShrink(request)

public performDiskShrink(request: google.cloud.sql.v1.ISqlInstancesPerformDiskShrinkRequest): Promise<google.cloud.sql.v1.Operation>;

Calls PerformDiskShrink.

Parameter
Name Description
request ISqlInstancesPerformDiskShrinkRequest

SqlInstancesPerformDiskShrinkRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

promoteReplica(request, callback)

public promoteReplica(request: google.cloud.sql.v1.ISqlInstancesPromoteReplicaRequest, callback: google.cloud.sql.v1.SqlInstancesService.PromoteReplicaCallback): void;

Calls PromoteReplica.

Parameters
Name Description
request ISqlInstancesPromoteReplicaRequest

SqlInstancesPromoteReplicaRequest message or plain object
callback PromoteReplicaCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

promoteReplica(request)

public promoteReplica(request: google.cloud.sql.v1.ISqlInstancesPromoteReplicaRequest): Promise<google.cloud.sql.v1.Operation>;

Calls PromoteReplica.

Parameter
Name Description
request ISqlInstancesPromoteReplicaRequest

SqlInstancesPromoteReplicaRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

reencrypt(request, callback)

public reencrypt(request: google.cloud.sql.v1.ISqlInstancesReencryptRequest, callback: google.cloud.sql.v1.SqlInstancesService.ReencryptCallback): void;

Calls Reencrypt.

Parameters
Name Description
request ISqlInstancesReencryptRequest

SqlInstancesReencryptRequest message or plain object
callback ReencryptCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

reencrypt(request)

public reencrypt(request: google.cloud.sql.v1.ISqlInstancesReencryptRequest): Promise<google.cloud.sql.v1.Operation>;

Calls Reencrypt.

Parameter
Name Description
request ISqlInstancesReencryptRequest

SqlInstancesReencryptRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

releaseSsrsLease(request, callback)

public releaseSsrsLease(request: google.cloud.sql.v1.ISqlInstancesReleaseSsrsLeaseRequest, callback: google.cloud.sql.v1.SqlInstancesService.ReleaseSsrsLeaseCallback): void;

Calls ReleaseSsrsLease.

Parameters
Name Description
request ISqlInstancesReleaseSsrsLeaseRequest

SqlInstancesReleaseSsrsLeaseRequest message or plain object
callback ReleaseSsrsLeaseCallback

Node-style callback called with the error, if any, and SqlInstancesReleaseSsrsLeaseResponse
Returns
Type Description
void

releaseSsrsLease(request)

public releaseSsrsLease(request: google.cloud.sql.v1.ISqlInstancesReleaseSsrsLeaseRequest): Promise<google.cloud.sql.v1.SqlInstancesReleaseSsrsLeaseResponse>;

Calls ReleaseSsrsLease.

Parameter
Name Description
request ISqlInstancesReleaseSsrsLeaseRequest

SqlInstancesReleaseSsrsLeaseRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.SqlInstancesReleaseSsrsLeaseResponse>

Promise

rescheduleMaintenance(request, callback)

public rescheduleMaintenance(request: google.cloud.sql.v1.ISqlInstancesRescheduleMaintenanceRequest, callback: google.cloud.sql.v1.SqlInstancesService.RescheduleMaintenanceCallback): void;

Calls RescheduleMaintenance.

Parameters
Name Description
request ISqlInstancesRescheduleMaintenanceRequest

SqlInstancesRescheduleMaintenanceRequest message or plain object
callback RescheduleMaintenanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

rescheduleMaintenance(request)

public rescheduleMaintenance(request: google.cloud.sql.v1.ISqlInstancesRescheduleMaintenanceRequest): Promise<google.cloud.sql.v1.Operation>;

Calls RescheduleMaintenance.

Parameter
Name Description
request ISqlInstancesRescheduleMaintenanceRequest

SqlInstancesRescheduleMaintenanceRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

resetReplicaSize(request, callback)

public resetReplicaSize(request: google.cloud.sql.v1.ISqlInstancesResetReplicaSizeRequest, callback: google.cloud.sql.v1.SqlInstancesService.ResetReplicaSizeCallback): void;

Calls ResetReplicaSize.

Parameters
Name Description
request ISqlInstancesResetReplicaSizeRequest

SqlInstancesResetReplicaSizeRequest message or plain object
callback ResetReplicaSizeCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

resetReplicaSize(request)

public resetReplicaSize(request: google.cloud.sql.v1.ISqlInstancesResetReplicaSizeRequest): Promise<google.cloud.sql.v1.Operation>;

Calls ResetReplicaSize.

Parameter
Name Description
request ISqlInstancesResetReplicaSizeRequest

SqlInstancesResetReplicaSizeRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

resetSslConfig(request, callback)

public resetSslConfig(request: google.cloud.sql.v1.ISqlInstancesResetSslConfigRequest, callback: google.cloud.sql.v1.SqlInstancesService.ResetSslConfigCallback): void;

Calls ResetSslConfig.

Parameters
Name Description
request ISqlInstancesResetSslConfigRequest

SqlInstancesResetSslConfigRequest message or plain object
callback ResetSslConfigCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

resetSslConfig(request)

public resetSslConfig(request: google.cloud.sql.v1.ISqlInstancesResetSslConfigRequest): Promise<google.cloud.sql.v1.Operation>;

Calls ResetSslConfig.

Parameter
Name Description
request ISqlInstancesResetSslConfigRequest

SqlInstancesResetSslConfigRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

restart(request, callback)

public restart(request: google.cloud.sql.v1.ISqlInstancesRestartRequest, callback: google.cloud.sql.v1.SqlInstancesService.RestartCallback): void;

Calls Restart.

Parameters
Name Description
request ISqlInstancesRestartRequest

SqlInstancesRestartRequest message or plain object
callback RestartCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

restart(request)

public restart(request: google.cloud.sql.v1.ISqlInstancesRestartRequest): Promise<google.cloud.sql.v1.Operation>;

Calls Restart.

Parameter
Name Description
request ISqlInstancesRestartRequest

SqlInstancesRestartRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

restoreBackup(request, callback)

public restoreBackup(request: google.cloud.sql.v1.ISqlInstancesRestoreBackupRequest, callback: google.cloud.sql.v1.SqlInstancesService.RestoreBackupCallback): void;

Calls RestoreBackup.

Parameters
Name Description
request ISqlInstancesRestoreBackupRequest

SqlInstancesRestoreBackupRequest message or plain object
callback RestoreBackupCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

restoreBackup(request)

public restoreBackup(request: google.cloud.sql.v1.ISqlInstancesRestoreBackupRequest): Promise<google.cloud.sql.v1.Operation>;

Calls RestoreBackup.

Parameter
Name Description
request ISqlInstancesRestoreBackupRequest

SqlInstancesRestoreBackupRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

rotateServerCa(request, callback)

public rotateServerCa(request: google.cloud.sql.v1.ISqlInstancesRotateServerCaRequest, callback: google.cloud.sql.v1.SqlInstancesService.RotateServerCaCallback): void;

Calls RotateServerCa.

Parameters
Name Description
request ISqlInstancesRotateServerCaRequest

SqlInstancesRotateServerCaRequest message or plain object
callback RotateServerCaCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

rotateServerCa(request)

public rotateServerCa(request: google.cloud.sql.v1.ISqlInstancesRotateServerCaRequest): Promise<google.cloud.sql.v1.Operation>;

Calls RotateServerCa.

Parameter
Name Description
request ISqlInstancesRotateServerCaRequest

SqlInstancesRotateServerCaRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

startExternalSync(request, callback)

public startExternalSync(request: google.cloud.sql.v1.ISqlInstancesStartExternalSyncRequest, callback: google.cloud.sql.v1.SqlInstancesService.StartExternalSyncCallback): void;

Calls StartExternalSync.

Parameters
Name Description
request ISqlInstancesStartExternalSyncRequest

SqlInstancesStartExternalSyncRequest message or plain object
callback StartExternalSyncCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

startExternalSync(request)

public startExternalSync(request: google.cloud.sql.v1.ISqlInstancesStartExternalSyncRequest): Promise<google.cloud.sql.v1.Operation>;

Calls StartExternalSync.

Parameter
Name Description
request ISqlInstancesStartExternalSyncRequest

SqlInstancesStartExternalSyncRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

startReplica(request, callback)

public startReplica(request: google.cloud.sql.v1.ISqlInstancesStartReplicaRequest, callback: google.cloud.sql.v1.SqlInstancesService.StartReplicaCallback): void;

Calls StartReplica.

Parameters
Name Description
request ISqlInstancesStartReplicaRequest

SqlInstancesStartReplicaRequest message or plain object
callback StartReplicaCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

startReplica(request)

public startReplica(request: google.cloud.sql.v1.ISqlInstancesStartReplicaRequest): Promise<google.cloud.sql.v1.Operation>;

Calls StartReplica.

Parameter
Name Description
request ISqlInstancesStartReplicaRequest

SqlInstancesStartReplicaRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

stopReplica(request, callback)

public stopReplica(request: google.cloud.sql.v1.ISqlInstancesStopReplicaRequest, callback: google.cloud.sql.v1.SqlInstancesService.StopReplicaCallback): void;

Calls StopReplica.

Parameters
Name Description
request ISqlInstancesStopReplicaRequest

SqlInstancesStopReplicaRequest message or plain object
callback StopReplicaCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

stopReplica(request)

public stopReplica(request: google.cloud.sql.v1.ISqlInstancesStopReplicaRequest): Promise<google.cloud.sql.v1.Operation>;

Calls StopReplica.

Parameter
Name Description
request ISqlInstancesStopReplicaRequest

SqlInstancesStopReplicaRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

switchover(request, callback)

public switchover(request: google.cloud.sql.v1.ISqlInstancesSwitchoverRequest, callback: google.cloud.sql.v1.SqlInstancesService.SwitchoverCallback): void;

Calls Switchover.

Parameters
Name Description
request ISqlInstancesSwitchoverRequest

SqlInstancesSwitchoverRequest message or plain object
callback SwitchoverCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

switchover(request)

public switchover(request: google.cloud.sql.v1.ISqlInstancesSwitchoverRequest): Promise<google.cloud.sql.v1.Operation>;

Calls Switchover.

Parameter
Name Description
request ISqlInstancesSwitchoverRequest

SqlInstancesSwitchoverRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

truncateLog(request, callback)

public truncateLog(request: google.cloud.sql.v1.ISqlInstancesTruncateLogRequest, callback: google.cloud.sql.v1.SqlInstancesService.TruncateLogCallback): void;

Calls TruncateLog.

Parameters
Name Description
request ISqlInstancesTruncateLogRequest

SqlInstancesTruncateLogRequest message or plain object
callback TruncateLogCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

truncateLog(request)

public truncateLog(request: google.cloud.sql.v1.ISqlInstancesTruncateLogRequest): Promise<google.cloud.sql.v1.Operation>;

Calls TruncateLog.

Parameter
Name Description
request ISqlInstancesTruncateLogRequest

SqlInstancesTruncateLogRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

update(request, callback)

public update(request: google.cloud.sql.v1.ISqlInstancesUpdateRequest, callback: google.cloud.sql.v1.SqlInstancesService.UpdateCallback): void;

Calls Update.

Parameters
Name Description
request ISqlInstancesUpdateRequest

SqlInstancesUpdateRequest message or plain object
callback UpdateCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

update(request)

public update(request: google.cloud.sql.v1.ISqlInstancesUpdateRequest): Promise<google.cloud.sql.v1.Operation>;

Calls Update.

Parameter
Name Description
request ISqlInstancesUpdateRequest

SqlInstancesUpdateRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.Operation>

Promise

verifyExternalSyncSettings(request, callback)

public verifyExternalSyncSettings(request: google.cloud.sql.v1.ISqlInstancesVerifyExternalSyncSettingsRequest, callback: google.cloud.sql.v1.SqlInstancesService.VerifyExternalSyncSettingsCallback): void;

Calls VerifyExternalSyncSettings.

Parameters
Name Description
request ISqlInstancesVerifyExternalSyncSettingsRequest

SqlInstancesVerifyExternalSyncSettingsRequest message or plain object
callback VerifyExternalSyncSettingsCallback

Node-style callback called with the error, if any, and SqlInstancesVerifyExternalSyncSettingsResponse
Returns
Type Description
void

verifyExternalSyncSettings(request)

public verifyExternalSyncSettings(request: google.cloud.sql.v1.ISqlInstancesVerifyExternalSyncSettingsRequest): Promise<google.cloud.sql.v1.SqlInstancesVerifyExternalSyncSettingsResponse>;

Calls VerifyExternalSyncSettings.

Parameter
Name Description
request ISqlInstancesVerifyExternalSyncSettingsRequest

SqlInstancesVerifyExternalSyncSettingsRequest message or plain object
Returns
Type Description
Promise<google.cloud.sql.v1.SqlInstancesVerifyExternalSyncSettingsResponse>

Promise