CloudMemcache

google.cloud.memcache.v1. CloudMemcache

Represents a CloudMemcache

Constructor

new CloudMemcache(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new CloudMemcache 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

applyParameters(request, callback) → {undefined}

Calls ApplyParameters.

Parameters:
Name Type Description
request google.cloud.memcache.v1.IApplyParametersRequest

ApplyParametersRequest message or plain object

callback google.cloud.memcache.v1.CloudMemcache.ApplyParametersCallback

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

Returns:
Type Description
undefined

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

Calls ApplyParameters.

Parameters:
Name Type Description
request google.cloud.memcache.v1.IApplyParametersRequest

ApplyParametersRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

createInstance(request, callback) → {undefined}

Calls CreateInstance.

Parameters:
Name Type Description
request google.cloud.memcache.v1.ICreateInstanceRequest

CreateInstanceRequest message or plain object

callback google.cloud.memcache.v1.CloudMemcache.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.memcache.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.memcache.v1.IDeleteInstanceRequest

DeleteInstanceRequest message or plain object

callback google.cloud.memcache.v1.CloudMemcache.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.memcache.v1.IDeleteInstanceRequest

DeleteInstanceRequest 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.memcache.v1.IGetInstanceRequest

GetInstanceRequest message or plain object

callback google.cloud.memcache.v1.CloudMemcache.GetInstanceCallback

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

Returns:
Type Description
undefined

getInstance(request) → {Promise.<google.cloud.memcache.v1.Instance>}

Calls GetInstance.

Parameters:
Name Type Description
request google.cloud.memcache.v1.IGetInstanceRequest

GetInstanceRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.memcache.v1.Instance>

Promise

listInstances(request, callback) → {undefined}

Calls ListInstances.

Parameters:
Name Type Description
request google.cloud.memcache.v1.IListInstancesRequest

ListInstancesRequest message or plain object

callback google.cloud.memcache.v1.CloudMemcache.ListInstancesCallback

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

Returns:
Type Description
undefined

listInstances(request) → {Promise.<google.cloud.memcache.v1.ListInstancesResponse>}

Calls ListInstances.

Parameters:
Name Type Description
request google.cloud.memcache.v1.IListInstancesRequest

ListInstancesRequest message or plain object

Returns:
Type Description
Promise.<google.cloud.memcache.v1.ListInstancesResponse>

Promise

rescheduleMaintenance(request, callback) → {undefined}

Calls RescheduleMaintenance.

Parameters:
Name Type Description
request google.cloud.memcache.v1.IRescheduleMaintenanceRequest

RescheduleMaintenanceRequest message or plain object

callback google.cloud.memcache.v1.CloudMemcache.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.memcache.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.memcache.v1.IUpdateInstanceRequest

UpdateInstanceRequest message or plain object

callback google.cloud.memcache.v1.CloudMemcache.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.memcache.v1.IUpdateInstanceRequest

UpdateInstanceRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

updateParameters(request, callback) → {undefined}

Calls UpdateParameters.

Parameters:
Name Type Description
request google.cloud.memcache.v1.IUpdateParametersRequest

UpdateParametersRequest message or plain object

callback google.cloud.memcache.v1.CloudMemcache.UpdateParametersCallback

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

Returns:
Type Description
undefined

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

Calls UpdateParameters.

Parameters:
Name Type Description
request google.cloud.memcache.v1.IUpdateParametersRequest

UpdateParametersRequest message or plain object

Returns:
Type Description
Promise.<google.longrunning.Operation>

Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {CloudMemcache}

Creates new CloudMemcache 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
CloudMemcache

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

Type Definitions

ApplyParametersCallback(error, responseopt)

Callback as used by applyParameters.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation

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

GetInstanceCallback(error, responseopt)

Callback as used by getInstance.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.memcache.v1.Instance <optional>

Instance

ListInstancesCallback(error, responseopt)

Callback as used by listInstances.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.cloud.memcache.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

UpdateParametersCallback(error, responseopt)

Callback as used by updateParameters.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any

response google.longrunning.Operation <optional>

Operation