Constructor
new CloudRedis(rpcImpl, requestDelimitedopt, responseDelimitedopt)
Constructs a new CloudRedis service.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Extends
- $protobuf.rpc.Service
Methods
createInstance(request, callback) → {undefined}
Calls CreateInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.ICreateInstanceRequest |
CreateInstanceRequest message or plain object |
callback |
google.cloud.redis.v1.CloudRedis.CreateInstanceCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
createInstance(request) → {Promise.<google.longrunning.Operation>}
Calls CreateInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.ICreateInstanceRequest |
CreateInstanceRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
deleteInstance(request, callback) → {undefined}
Calls DeleteInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IDeleteInstanceRequest |
DeleteInstanceRequest message or plain object |
callback |
google.cloud.redis.v1.CloudRedis.DeleteInstanceCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
deleteInstance(request) → {Promise.<google.longrunning.Operation>}
Calls DeleteInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IDeleteInstanceRequest |
DeleteInstanceRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
exportInstance(request, callback) → {undefined}
Calls ExportInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IExportInstanceRequest |
ExportInstanceRequest message or plain object |
callback |
google.cloud.redis.v1.CloudRedis.ExportInstanceCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
exportInstance(request) → {Promise.<google.longrunning.Operation>}
Calls ExportInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IExportInstanceRequest |
ExportInstanceRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
failoverInstance(request, callback) → {undefined}
Calls FailoverInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IFailoverInstanceRequest |
FailoverInstanceRequest message or plain object |
callback |
google.cloud.redis.v1.CloudRedis.FailoverInstanceCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
failoverInstance(request) → {Promise.<google.longrunning.Operation>}
Calls FailoverInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IFailoverInstanceRequest |
FailoverInstanceRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
getInstance(request, callback) → {undefined}
Calls GetInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IGetInstanceRequest |
GetInstanceRequest message or plain object |
callback |
google.cloud.redis.v1.CloudRedis.GetInstanceCallback |
Node-style callback called with the error, if any, and Instance |
Returns:
| Type | Description |
|---|---|
| undefined |
getInstance(request) → {Promise.<google.cloud.redis.v1.Instance>}
Calls GetInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IGetInstanceRequest |
GetInstanceRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.redis.v1.Instance> |
Promise |
getInstanceAuthString(request, callback) → {undefined}
Calls GetInstanceAuthString.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IGetInstanceAuthStringRequest |
GetInstanceAuthStringRequest message or plain object |
callback |
google.cloud.redis.v1.CloudRedis.GetInstanceAuthStringCallback |
Node-style callback called with the error, if any, and InstanceAuthString |
Returns:
| Type | Description |
|---|---|
| undefined |
getInstanceAuthString(request) → {Promise.<google.cloud.redis.v1.InstanceAuthString>}
Calls GetInstanceAuthString.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IGetInstanceAuthStringRequest |
GetInstanceAuthStringRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.redis.v1.InstanceAuthString> |
Promise |
importInstance(request, callback) → {undefined}
Calls ImportInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IImportInstanceRequest |
ImportInstanceRequest message or plain object |
callback |
google.cloud.redis.v1.CloudRedis.ImportInstanceCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
importInstance(request) → {Promise.<google.longrunning.Operation>}
Calls ImportInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IImportInstanceRequest |
ImportInstanceRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
listInstances(request, callback) → {undefined}
Calls ListInstances.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IListInstancesRequest |
ListInstancesRequest message or plain object |
callback |
google.cloud.redis.v1.CloudRedis.ListInstancesCallback |
Node-style callback called with the error, if any, and ListInstancesResponse |
Returns:
| Type | Description |
|---|---|
| undefined |
listInstances(request) → {Promise.<google.cloud.redis.v1.ListInstancesResponse>}
Calls ListInstances.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IListInstancesRequest |
ListInstancesRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.cloud.redis.v1.ListInstancesResponse> |
Promise |
rescheduleMaintenance(request, callback) → {undefined}
Calls RescheduleMaintenance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IRescheduleMaintenanceRequest |
RescheduleMaintenanceRequest message or plain object |
callback |
google.cloud.redis.v1.CloudRedis.RescheduleMaintenanceCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
rescheduleMaintenance(request) → {Promise.<google.longrunning.Operation>}
Calls RescheduleMaintenance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IRescheduleMaintenanceRequest |
RescheduleMaintenanceRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
updateInstance(request, callback) → {undefined}
Calls UpdateInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IUpdateInstanceRequest |
UpdateInstanceRequest message or plain object |
callback |
google.cloud.redis.v1.CloudRedis.UpdateInstanceCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
updateInstance(request) → {Promise.<google.longrunning.Operation>}
Calls UpdateInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IUpdateInstanceRequest |
UpdateInstanceRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
upgradeInstance(request, callback) → {undefined}
Calls UpgradeInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IUpgradeInstanceRequest |
UpgradeInstanceRequest message or plain object |
callback |
google.cloud.redis.v1.CloudRedis.UpgradeInstanceCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
upgradeInstance(request) → {Promise.<google.longrunning.Operation>}
Calls UpgradeInstance.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.cloud.redis.v1.IUpgradeInstanceRequest |
UpgradeInstanceRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {CloudRedis}
Creates new CloudRedis service using the specified rpc implementation.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Returns:
| Type | Description |
|---|---|
| CloudRedis |
RPC service. Useful where requests and/or responses are streamed. |
Type Definitions
CreateInstanceCallback(error, responseopt)
Callback as used by createInstance.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
DeleteInstanceCallback(error, responseopt)
Callback as used by deleteInstance.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
ExportInstanceCallback(error, responseopt)
Callback as used by exportInstance.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
FailoverInstanceCallback(error, responseopt)
Callback as used by failoverInstance.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
GetInstanceAuthStringCallback(error, responseopt)
Callback as used by getInstanceAuthString.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.redis.v1.InstanceAuthString |
<optional> |
InstanceAuthString |
GetInstanceCallback(error, responseopt)
Callback as used by getInstance.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.redis.v1.Instance |
<optional> |
Instance |
ImportInstanceCallback(error, responseopt)
Callback as used by importInstance.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
ListInstancesCallback(error, responseopt)
Callback as used by listInstances.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.redis.v1.ListInstancesResponse |
<optional> |
ListInstancesResponse |
RescheduleMaintenanceCallback(error, responseopt)
Callback as used by rescheduleMaintenance.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
UpdateInstanceCallback(error, responseopt)
Callback as used by updateInstance.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
UpgradeInstanceCallback(error, responseopt)
Callback as used by upgradeInstance.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |