Represents a SqlInstancesService
Inheritance
$protobuf.rpc.Service > protos.google.cloud.sql.v1beta4.SqlInstancesServicePackage
@google-cloud/sqlConstructors
(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.v1beta4.ISqlInstancesAcquireSsrsLeaseRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesAcquireSsrsLeaseRequest): Promise<google.cloud.sql.v1beta4.SqlInstancesAcquireSsrsLeaseResponse>;Calls AcquireSsrsLease.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesAcquireSsrsLeaseRequest
SqlInstancesAcquireSsrsLeaseRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.SqlInstancesAcquireSsrsLeaseResponse> |
Promise |
addEntraIdCertificate(request, callback)
public addEntraIdCertificate(request: google.cloud.sql.v1beta4.ISqlInstancesAddEntraIdCertificateRequest, callback: google.cloud.sql.v1beta4.SqlInstancesService.AddEntraIdCertificateCallback): void;Calls AddEntraIdCertificate.
| Parameters | |
|---|---|
| Name | Description |
request |
ISqlInstancesAddEntraIdCertificateRequest
SqlInstancesAddEntraIdCertificateRequest message or plain object |
callback |
AddEntraIdCertificateCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
addEntraIdCertificate(request)
public addEntraIdCertificate(request: google.cloud.sql.v1beta4.ISqlInstancesAddEntraIdCertificateRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls AddEntraIdCertificate.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesAddEntraIdCertificateRequest
SqlInstancesAddEntraIdCertificateRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
addServerCa(request, callback)
public addServerCa(request: google.cloud.sql.v1beta4.ISqlInstancesAddServerCaRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesAddServerCaRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls AddServerCa.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesAddServerCaRequest
SqlInstancesAddServerCaRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
addServerCertificate(request, callback)
public addServerCertificate(request: google.cloud.sql.v1beta4.ISqlInstancesAddServerCertificateRequest, callback: google.cloud.sql.v1beta4.SqlInstancesService.AddServerCertificateCallback): void;Calls AddServerCertificate.
| Parameters | |
|---|---|
| Name | Description |
request |
ISqlInstancesAddServerCertificateRequest
SqlInstancesAddServerCertificateRequest message or plain object |
callback |
AddServerCertificateCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
addServerCertificate(request)
public addServerCertificate(request: google.cloud.sql.v1beta4.ISqlInstancesAddServerCertificateRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls AddServerCertificate.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesAddServerCertificateRequest
SqlInstancesAddServerCertificateRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
clone(request, callback)
public clone(request: google.cloud.sql.v1beta4.ISqlInstancesCloneRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesCloneRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls Clone.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesCloneRequest
SqlInstancesCloneRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesCreateEphemeralCertRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesCreateEphemeralCertRequest): Promise<google.cloud.sql.v1beta4.SslCert>;Calls CreateEphemeral.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesCreateEphemeralCertRequest
SqlInstancesCreateEphemeralCertRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.SslCert> |
Promise |
delete(request, callback)
public delete(request: google.cloud.sql.v1beta4.ISqlInstancesDeleteRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesDeleteRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls Delete.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesDeleteRequest
SqlInstancesDeleteRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
demote(request, callback)
public demote(request: google.cloud.sql.v1beta4.ISqlInstancesDemoteRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesDemoteRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls Demote.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesDemoteRequest
SqlInstancesDemoteRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
demoteMaster(request, callback)
public demoteMaster(request: google.cloud.sql.v1beta4.ISqlInstancesDemoteMasterRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesDemoteMasterRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls DemoteMaster.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesDemoteMasterRequest
SqlInstancesDemoteMasterRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
executeSql(request, callback)
public executeSql(request: google.cloud.sql.v1beta4.ISqlInstancesExecuteSqlRequest, callback: google.cloud.sql.v1beta4.SqlInstancesService.ExecuteSqlCallback): void;Calls ExecuteSql.
| Parameters | |
|---|---|
| Name | Description |
request |
ISqlInstancesExecuteSqlRequest
SqlInstancesExecuteSqlRequest message or plain object |
callback |
ExecuteSqlCallback
Node-style callback called with the error, if any, and SqlInstancesExecuteSqlResponse |
| Returns | |
|---|---|
| Type | Description |
void |
|
executeSql(request)
public executeSql(request: google.cloud.sql.v1beta4.ISqlInstancesExecuteSqlRequest): Promise<google.cloud.sql.v1beta4.SqlInstancesExecuteSqlResponse>;Calls ExecuteSql.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesExecuteSqlRequest
SqlInstancesExecuteSqlRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.SqlInstancesExecuteSqlResponse> |
Promise |
export(request, callback)
public export(request: google.cloud.sql.v1beta4.ISqlInstancesExportRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesExportRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls Export.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesExportRequest
SqlInstancesExportRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
failover(request, callback)
public failover(request: google.cloud.sql.v1beta4.ISqlInstancesFailoverRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesFailoverRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls Failover.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesFailoverRequest
SqlInstancesFailoverRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
get(request, callback)
public get(request: google.cloud.sql.v1beta4.ISqlInstancesGetRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesGetRequest): Promise<google.cloud.sql.v1beta4.DatabaseInstance>;Calls Get.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesGetRequest
SqlInstancesGetRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.DatabaseInstance> |
Promise |
getDiskShrinkConfig(request, callback)
public getDiskShrinkConfig(request: google.cloud.sql.v1beta4.ISqlInstancesGetDiskShrinkConfigRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesGetDiskShrinkConfigRequest): Promise<google.cloud.sql.v1beta4.SqlInstancesGetDiskShrinkConfigResponse>;Calls GetDiskShrinkConfig.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesGetDiskShrinkConfigRequest
SqlInstancesGetDiskShrinkConfigRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.SqlInstancesGetDiskShrinkConfigResponse> |
Promise |
getLatestRecoveryTime(request, callback)
public getLatestRecoveryTime(request: google.cloud.sql.v1beta4.ISqlInstancesGetLatestRecoveryTimeRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesGetLatestRecoveryTimeRequest): Promise<google.cloud.sql.v1beta4.SqlInstancesGetLatestRecoveryTimeResponse>;Calls GetLatestRecoveryTime.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesGetLatestRecoveryTimeRequest
SqlInstancesGetLatestRecoveryTimeRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.SqlInstancesGetLatestRecoveryTimeResponse> |
Promise |
import(request, callback)
public import(request: google.cloud.sql.v1beta4.ISqlInstancesImportRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesImportRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls Import.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesImportRequest
SqlInstancesImportRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
insert(request, callback)
public insert(request: google.cloud.sql.v1beta4.ISqlInstancesInsertRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesInsertRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls Insert.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesInsertRequest
SqlInstancesInsertRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
list(request, callback)
public list(request: google.cloud.sql.v1beta4.ISqlInstancesListRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesListRequest): Promise<google.cloud.sql.v1beta4.InstancesListResponse>;Calls List.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesListRequest
SqlInstancesListRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.InstancesListResponse> |
Promise |
listEntraIdCertificates(request, callback)
public listEntraIdCertificates(request: google.cloud.sql.v1beta4.ISqlInstancesListEntraIdCertificatesRequest, callback: google.cloud.sql.v1beta4.SqlInstancesService.ListEntraIdCertificatesCallback): void;Calls ListEntraIdCertificates.
| Parameters | |
|---|---|
| Name | Description |
request |
ISqlInstancesListEntraIdCertificatesRequest
SqlInstancesListEntraIdCertificatesRequest message or plain object |
callback |
ListEntraIdCertificatesCallback
Node-style callback called with the error, if any, and InstancesListEntraIdCertificatesResponse |
| Returns | |
|---|---|
| Type | Description |
void |
|
listEntraIdCertificates(request)
public listEntraIdCertificates(request: google.cloud.sql.v1beta4.ISqlInstancesListEntraIdCertificatesRequest): Promise<google.cloud.sql.v1beta4.InstancesListEntraIdCertificatesResponse>;Calls ListEntraIdCertificates.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesListEntraIdCertificatesRequest
SqlInstancesListEntraIdCertificatesRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.InstancesListEntraIdCertificatesResponse> |
Promise |
listServerCas(request, callback)
public listServerCas(request: google.cloud.sql.v1beta4.ISqlInstancesListServerCasRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesListServerCasRequest): Promise<google.cloud.sql.v1beta4.InstancesListServerCasResponse>;Calls ListServerCas.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesListServerCasRequest
SqlInstancesListServerCasRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.InstancesListServerCasResponse> |
Promise |
listServerCertificates(request, callback)
public listServerCertificates(request: google.cloud.sql.v1beta4.ISqlInstancesListServerCertificatesRequest, callback: google.cloud.sql.v1beta4.SqlInstancesService.ListServerCertificatesCallback): void;Calls ListServerCertificates.
| Parameters | |
|---|---|
| Name | Description |
request |
ISqlInstancesListServerCertificatesRequest
SqlInstancesListServerCertificatesRequest message or plain object |
callback |
ListServerCertificatesCallback
Node-style callback called with the error, if any, and InstancesListServerCertificatesResponse |
| Returns | |
|---|---|
| Type | Description |
void |
|
listServerCertificates(request)
public listServerCertificates(request: google.cloud.sql.v1beta4.ISqlInstancesListServerCertificatesRequest): Promise<google.cloud.sql.v1beta4.InstancesListServerCertificatesResponse>;Calls ListServerCertificates.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesListServerCertificatesRequest
SqlInstancesListServerCertificatesRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.InstancesListServerCertificatesResponse> |
Promise |
patch(request, callback)
public patch(request: google.cloud.sql.v1beta4.ISqlInstancesPatchRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesPatchRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls Patch.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesPatchRequest
SqlInstancesPatchRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
performDiskShrink(request, callback)
public performDiskShrink(request: google.cloud.sql.v1beta4.ISqlInstancesPerformDiskShrinkRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesPerformDiskShrinkRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls PerformDiskShrink.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesPerformDiskShrinkRequest
SqlInstancesPerformDiskShrinkRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
pointInTimeRestore(request, callback)
public pointInTimeRestore(request: google.cloud.sql.v1beta4.ISqlInstancesPointInTimeRestoreRequest, callback: google.cloud.sql.v1beta4.SqlInstancesService.PointInTimeRestoreCallback): void;Calls PointInTimeRestore.
| Parameters | |
|---|---|
| Name | Description |
request |
ISqlInstancesPointInTimeRestoreRequest
SqlInstancesPointInTimeRestoreRequest message or plain object |
callback |
PointInTimeRestoreCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
pointInTimeRestore(request)
public pointInTimeRestore(request: google.cloud.sql.v1beta4.ISqlInstancesPointInTimeRestoreRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls PointInTimeRestore.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesPointInTimeRestoreRequest
SqlInstancesPointInTimeRestoreRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
preCheckMajorVersionUpgrade(request, callback)
public preCheckMajorVersionUpgrade(request: google.cloud.sql.v1beta4.ISqlInstancesPreCheckMajorVersionUpgradeRequest, callback: google.cloud.sql.v1beta4.SqlInstancesService.PreCheckMajorVersionUpgradeCallback): void;Calls PreCheckMajorVersionUpgrade.
| Parameters | |
|---|---|
| Name | Description |
request |
ISqlInstancesPreCheckMajorVersionUpgradeRequest
SqlInstancesPreCheckMajorVersionUpgradeRequest message or plain object |
callback |
PreCheckMajorVersionUpgradeCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
preCheckMajorVersionUpgrade(request)
public preCheckMajorVersionUpgrade(request: google.cloud.sql.v1beta4.ISqlInstancesPreCheckMajorVersionUpgradeRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls PreCheckMajorVersionUpgrade.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesPreCheckMajorVersionUpgradeRequest
SqlInstancesPreCheckMajorVersionUpgradeRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
promoteReplica(request, callback)
public promoteReplica(request: google.cloud.sql.v1beta4.ISqlInstancesPromoteReplicaRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesPromoteReplicaRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls PromoteReplica.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesPromoteReplicaRequest
SqlInstancesPromoteReplicaRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
reencrypt(request, callback)
public reencrypt(request: google.cloud.sql.v1beta4.ISqlInstancesReencryptRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesReencryptRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls Reencrypt.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesReencryptRequest
SqlInstancesReencryptRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
releaseSsrsLease(request, callback)
public releaseSsrsLease(request: google.cloud.sql.v1beta4.ISqlInstancesReleaseSsrsLeaseRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesReleaseSsrsLeaseRequest): Promise<google.cloud.sql.v1beta4.SqlInstancesReleaseSsrsLeaseResponse>;Calls ReleaseSsrsLease.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesReleaseSsrsLeaseRequest
SqlInstancesReleaseSsrsLeaseRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.SqlInstancesReleaseSsrsLeaseResponse> |
Promise |
rescheduleMaintenance(request, callback)
public rescheduleMaintenance(request: google.cloud.sql.v1beta4.ISqlInstancesRescheduleMaintenanceRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesRescheduleMaintenanceRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls RescheduleMaintenance.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesRescheduleMaintenanceRequest
SqlInstancesRescheduleMaintenanceRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
resetReplicaSize(request, callback)
public resetReplicaSize(request: google.cloud.sql.v1beta4.ISqlInstancesResetReplicaSizeRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesResetReplicaSizeRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls ResetReplicaSize.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesResetReplicaSizeRequest
SqlInstancesResetReplicaSizeRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
resetSslConfig(request, callback)
public resetSslConfig(request: google.cloud.sql.v1beta4.ISqlInstancesResetSslConfigRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesResetSslConfigRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls ResetSslConfig.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesResetSslConfigRequest
SqlInstancesResetSslConfigRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
restart(request, callback)
public restart(request: google.cloud.sql.v1beta4.ISqlInstancesRestartRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesRestartRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls Restart.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesRestartRequest
SqlInstancesRestartRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
restoreBackup(request, callback)
public restoreBackup(request: google.cloud.sql.v1beta4.ISqlInstancesRestoreBackupRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesRestoreBackupRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls RestoreBackup.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesRestoreBackupRequest
SqlInstancesRestoreBackupRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
rotateEntraIdCertificate(request, callback)
public rotateEntraIdCertificate(request: google.cloud.sql.v1beta4.ISqlInstancesRotateEntraIdCertificateRequest, callback: google.cloud.sql.v1beta4.SqlInstancesService.RotateEntraIdCertificateCallback): void;Calls RotateEntraIdCertificate.
| Parameters | |
|---|---|
| Name | Description |
request |
ISqlInstancesRotateEntraIdCertificateRequest
SqlInstancesRotateEntraIdCertificateRequest message or plain object |
callback |
RotateEntraIdCertificateCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
rotateEntraIdCertificate(request)
public rotateEntraIdCertificate(request: google.cloud.sql.v1beta4.ISqlInstancesRotateEntraIdCertificateRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls RotateEntraIdCertificate.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesRotateEntraIdCertificateRequest
SqlInstancesRotateEntraIdCertificateRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
rotateServerCa(request, callback)
public rotateServerCa(request: google.cloud.sql.v1beta4.ISqlInstancesRotateServerCaRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesRotateServerCaRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls RotateServerCa.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesRotateServerCaRequest
SqlInstancesRotateServerCaRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
rotateServerCertificate(request, callback)
public rotateServerCertificate(request: google.cloud.sql.v1beta4.ISqlInstancesRotateServerCertificateRequest, callback: google.cloud.sql.v1beta4.SqlInstancesService.RotateServerCertificateCallback): void;Calls RotateServerCertificate.
| Parameters | |
|---|---|
| Name | Description |
request |
ISqlInstancesRotateServerCertificateRequest
SqlInstancesRotateServerCertificateRequest message or plain object |
callback |
RotateServerCertificateCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void |
|
rotateServerCertificate(request)
public rotateServerCertificate(request: google.cloud.sql.v1beta4.ISqlInstancesRotateServerCertificateRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls RotateServerCertificate.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesRotateServerCertificateRequest
SqlInstancesRotateServerCertificateRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
startExternalSync(request, callback)
public startExternalSync(request: google.cloud.sql.v1beta4.ISqlInstancesStartExternalSyncRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesStartExternalSyncRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls StartExternalSync.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesStartExternalSyncRequest
SqlInstancesStartExternalSyncRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
startReplica(request, callback)
public startReplica(request: google.cloud.sql.v1beta4.ISqlInstancesStartReplicaRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesStartReplicaRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls StartReplica.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesStartReplicaRequest
SqlInstancesStartReplicaRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
stopReplica(request, callback)
public stopReplica(request: google.cloud.sql.v1beta4.ISqlInstancesStopReplicaRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesStopReplicaRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls StopReplica.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesStopReplicaRequest
SqlInstancesStopReplicaRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
switchover(request, callback)
public switchover(request: google.cloud.sql.v1beta4.ISqlInstancesSwitchoverRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesSwitchoverRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls Switchover.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesSwitchoverRequest
SqlInstancesSwitchoverRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
truncateLog(request, callback)
public truncateLog(request: google.cloud.sql.v1beta4.ISqlInstancesTruncateLogRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesTruncateLogRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls TruncateLog.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesTruncateLogRequest
SqlInstancesTruncateLogRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
update(request, callback)
public update(request: google.cloud.sql.v1beta4.ISqlInstancesUpdateRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesUpdateRequest): Promise<google.cloud.sql.v1beta4.Operation>;Calls Update.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesUpdateRequest
SqlInstancesUpdateRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.Operation> |
Promise |
verifyExternalSyncSettings(request, callback)
public verifyExternalSyncSettings(request: google.cloud.sql.v1beta4.ISqlInstancesVerifyExternalSyncSettingsRequest, callback: google.cloud.sql.v1beta4.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.v1beta4.ISqlInstancesVerifyExternalSyncSettingsRequest): Promise<google.cloud.sql.v1beta4.SqlInstancesVerifyExternalSyncSettingsResponse>;Calls VerifyExternalSyncSettings.
| Parameter | |
|---|---|
| Name | Description |
request |
ISqlInstancesVerifyExternalSyncSettingsRequest
SqlInstancesVerifyExternalSyncSettingsRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.sql.v1beta4.SqlInstancesVerifyExternalSyncSettingsResponse> |
Promise |