CloudRedis

google.cloud.redis.v1beta1. CloudRedis

Represents a CloudRedis

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

(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

createInstance(request, callback) → {undefined}

Calls CreateInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.ICreateInstanceRequest

CreateInstanceRequest message or plain object
callback google.cloud.redis.v1beta1.CloudRedis.CreateInstanceCallback

Node-style callback called with the error, if any, and Operation

createInstance(request) → {Promise.<google.longrunning.Operation>}

Calls CreateInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.ICreateInstanceRequest

CreateInstanceRequest message or plain object

deleteInstance(request, callback) → {undefined}

Calls DeleteInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IDeleteInstanceRequest

DeleteInstanceRequest message or plain object
callback google.cloud.redis.v1beta1.CloudRedis.DeleteInstanceCallback

Node-style callback called with the error, if any, and Operation

deleteInstance(request) → {Promise.<google.longrunning.Operation>}

Calls DeleteInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IDeleteInstanceRequest

DeleteInstanceRequest message or plain object

exportInstance(request, callback) → {undefined}

Calls ExportInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IExportInstanceRequest

ExportInstanceRequest message or plain object
callback google.cloud.redis.v1beta1.CloudRedis.ExportInstanceCallback

Node-style callback called with the error, if any, and Operation

exportInstance(request) → {Promise.<google.longrunning.Operation>}

Calls ExportInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IExportInstanceRequest

ExportInstanceRequest message or plain object

failoverInstance(request, callback) → {undefined}

Calls FailoverInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IFailoverInstanceRequest

FailoverInstanceRequest message or plain object
callback google.cloud.redis.v1beta1.CloudRedis.FailoverInstanceCallback

Node-style callback called with the error, if any, and Operation

failoverInstance(request) → {Promise.<google.longrunning.Operation>}

Calls FailoverInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IFailoverInstanceRequest

FailoverInstanceRequest message or plain object

getInstance(request, callback) → {undefined}

Calls GetInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IGetInstanceRequest

GetInstanceRequest message or plain object
callback google.cloud.redis.v1beta1.CloudRedis.GetInstanceCallback

Node-style callback called with the error, if any, and Instance

getInstance(request) → {Promise.<google.cloud.redis.v1beta1.Instance>}

Calls GetInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IGetInstanceRequest

GetInstanceRequest message or plain object

importInstance(request, callback) → {undefined}

Calls ImportInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IImportInstanceRequest

ImportInstanceRequest message or plain object
callback google.cloud.redis.v1beta1.CloudRedis.ImportInstanceCallback

Node-style callback called with the error, if any, and Operation

importInstance(request) → {Promise.<google.longrunning.Operation>}

Calls ImportInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IImportInstanceRequest

ImportInstanceRequest message or plain object

listInstances(request, callback) → {undefined}

Calls ListInstances.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IListInstancesRequest

ListInstancesRequest message or plain object
callback google.cloud.redis.v1beta1.CloudRedis.ListInstancesCallback

Node-style callback called with the error, if any, and ListInstancesResponse

listInstances(request) → {Promise.<google.cloud.redis.v1beta1.ListInstancesResponse>}

Calls ListInstances.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IListInstancesRequest

ListInstancesRequest message or plain object

updateInstance(request, callback) → {undefined}

Calls UpdateInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IUpdateInstanceRequest

UpdateInstanceRequest message or plain object
callback google.cloud.redis.v1beta1.CloudRedis.UpdateInstanceCallback

Node-style callback called with the error, if any, and Operation

updateInstance(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IUpdateInstanceRequest

UpdateInstanceRequest message or plain object

upgradeInstance(request, callback) → {undefined}

Calls UpgradeInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IUpgradeInstanceRequest

UpgradeInstanceRequest message or plain object
callback google.cloud.redis.v1beta1.CloudRedis.UpgradeInstanceCallback

Node-style callback called with the error, if any, and Operation

upgradeInstance(request) → {Promise.<google.longrunning.Operation>}

Calls UpgradeInstance.

Parameters:
Name Type Description
request google.cloud.redis.v1beta1.IUpgradeInstanceRequest

UpgradeInstanceRequest message or plain object

Type Definitions

CreateInstanceCallback(error, responseopt)

Callback as used by google.cloud.redis.v1beta1.CloudRedis#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 google.cloud.redis.v1beta1.CloudRedis#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 google.cloud.redis.v1beta1.CloudRedis#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 google.cloud.redis.v1beta1.CloudRedis#failoverInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation

GetInstanceCallback(error, responseopt)

Callback as used by google.cloud.redis.v1beta1.CloudRedis#getInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.redis.v1beta1.Instance <optional>

Instance

ImportInstanceCallback(error, responseopt)

Callback as used by google.cloud.redis.v1beta1.CloudRedis#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 google.cloud.redis.v1beta1.CloudRedis#listInstances.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.redis.v1beta1.ListInstancesResponse <optional>

ListInstancesResponse

UpdateInstanceCallback(error, responseopt)

Callback as used by google.cloud.redis.v1beta1.CloudRedis#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 google.cloud.redis.v1beta1.CloudRedis#upgradeInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.longrunning.Operation <optional>

Operation