Class protos.google.cloud.memcache.v1.CloudMemcache (2.3.2)

Version latest

• 2.3.2 (latest)
• 2.3.1
• 2.1.4
• 1.5.1
• 1.4.7

Represents a CloudMemcache

Inheritance

$protobuf.rpc.Service > protos.google.cloud.memcache.v1.CloudMemcache

Package

@google-cloud/memcache

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new CloudMemcache service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

applyParameters(request, callback)

public applyParameters(request: google.cloud.memcache.v1.IApplyParametersRequest, callback: google.cloud.memcache.v1.CloudMemcache.ApplyParametersCallback): void;

Calls ApplyParameters.

Parameters
Name	Description
request	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
void

applyParameters(request)

public applyParameters(request: google.cloud.memcache.v1.IApplyParametersRequest): Promise<google.longrunning.Operation>;

Calls ApplyParameters.

Parameter
Name	Description
request	IApplyParametersRequest ApplyParametersRequest message or plain object

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

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new CloudMemcache 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
CloudMemcache	RPC service. Useful where requests and/or responses are streamed.

createInstance(request, callback)

public createInstance(request: google.cloud.memcache.v1.ICreateInstanceRequest, callback: google.cloud.memcache.v1.CloudMemcache.CreateInstanceCallback): void;

Calls CreateInstance.

Parameters
Name	Description
request	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
void

createInstance(request)

public createInstance(request: google.cloud.memcache.v1.ICreateInstanceRequest): Promise<google.longrunning.Operation>;

Calls CreateInstance.

Parameter
Name	Description
request	ICreateInstanceRequest CreateInstanceRequest message or plain object

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

deleteInstance(request, callback)

public deleteInstance(request: google.cloud.memcache.v1.IDeleteInstanceRequest, callback: google.cloud.memcache.v1.CloudMemcache.DeleteInstanceCallback): void;

Calls DeleteInstance.

Parameters
Name	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
void

deleteInstance(request)

public deleteInstance(request: google.cloud.memcache.v1.IDeleteInstanceRequest): Promise<google.longrunning.Operation>;

Calls DeleteInstance.

Parameter
Name	Description
request	google.cloud.memcache.v1.IDeleteInstanceRequest DeleteInstanceRequest message or plain object

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

getInstance(request, callback)

public getInstance(request: google.cloud.memcache.v1.IGetInstanceRequest, callback: google.cloud.memcache.v1.CloudMemcache.GetInstanceCallback): void;

Calls GetInstance.

Parameters
Name	Description
request	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
void

getInstance(request)

public getInstance(request: google.cloud.memcache.v1.IGetInstanceRequest): Promise<google.cloud.memcache.v1.Instance>;

Calls GetInstance.

Parameter
Name	Description
request	IGetInstanceRequest GetInstanceRequest message or plain object

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

listInstances(request, callback)

public listInstances(request: google.cloud.memcache.v1.IListInstancesRequest, callback: google.cloud.memcache.v1.CloudMemcache.ListInstancesCallback): void;

Calls ListInstances.

Parameters
Name	Description
request	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
void

listInstances(request)

public listInstances(request: google.cloud.memcache.v1.IListInstancesRequest): Promise<google.cloud.memcache.v1.ListInstancesResponse>;

Calls ListInstances.

Parameter
Name	Description
request	IListInstancesRequest ListInstancesRequest message or plain object

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

rescheduleMaintenance(request, callback)

public rescheduleMaintenance(request: google.cloud.memcache.v1.IRescheduleMaintenanceRequest, callback: google.cloud.memcache.v1.CloudMemcache.RescheduleMaintenanceCallback): void;

Calls RescheduleMaintenance.

Parameters
Name	Description
request	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
void

rescheduleMaintenance(request)

public rescheduleMaintenance(request: google.cloud.memcache.v1.IRescheduleMaintenanceRequest): Promise<google.longrunning.Operation>;

Calls RescheduleMaintenance.

Parameter
Name	Description
request	IRescheduleMaintenanceRequest RescheduleMaintenanceRequest message or plain object

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

updateInstance(request, callback)

public updateInstance(request: google.cloud.memcache.v1.IUpdateInstanceRequest, callback: google.cloud.memcache.v1.CloudMemcache.UpdateInstanceCallback): void;

Calls UpdateInstance.

Parameters
Name	Description
request	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
void

updateInstance(request)

public updateInstance(request: google.cloud.memcache.v1.IUpdateInstanceRequest): Promise<google.longrunning.Operation>;

Calls UpdateInstance.

Parameter
Name	Description
request	IUpdateInstanceRequest UpdateInstanceRequest message or plain object

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

updateParameters(request, callback)

public updateParameters(request: google.cloud.memcache.v1.IUpdateParametersRequest, callback: google.cloud.memcache.v1.CloudMemcache.UpdateParametersCallback): void;

Calls UpdateParameters.

Parameters
Name	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
void

updateParameters(request)

public updateParameters(request: google.cloud.memcache.v1.IUpdateParametersRequest): Promise<google.longrunning.Operation>;

Calls UpdateParameters.

Parameter
Name	Description
request	google.cloud.memcache.v1.IUpdateParametersRequest UpdateParametersRequest message or plain object

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