Represents a CloudRedis
Inheritance
$protobuf.rpc.Service > protos.google.cloud.redis.v1beta1.CloudRedisPackage
@google-cloud/redisConstructors
(constructor)(rpcImpl, requestDelimited, responseDelimited)
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);Constructs a new CloudRedis service.
| Parameters | |
|---|---|
| Name | Description |
rpcImpl |
$protobuf.RPCImpl
RPC implementation |
requestDelimited |
boolean
Whether requests are length-delimited |
responseDelimited |
boolean
Whether responses are length-delimited |
Methods
create(rpcImpl, requestDelimited, responseDelimited)
public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): CloudRedis;Creates new CloudRedis 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 |
CloudRedis | RPC service. Useful where requests and/or responses are streamed. |
createInstance(request, callback)
public createInstance(request: google.cloud.redis.v1beta1.ICreateInstanceRequest, callback: google.cloud.redis.v1beta1.CloudRedis.CreateInstanceCallback): void;Calls CreateInstance.
| Parameters | |
|---|---|
| Name | Description |
request |
ICreateInstanceRequest
CreateInstanceRequest message or plain object |
callback |
CreateInstanceCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
createInstance(request)
public createInstance(request: google.cloud.redis.v1beta1.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.redis.v1beta1.IDeleteInstanceRequest, callback: google.cloud.redis.v1beta1.CloudRedis.DeleteInstanceCallback): void;Calls DeleteInstance.
| Parameters | |
|---|---|
| Name | Description |
request |
IDeleteInstanceRequest
DeleteInstanceRequest message or plain object |
callback |
DeleteInstanceCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
deleteInstance(request)
public deleteInstance(request: google.cloud.redis.v1beta1.IDeleteInstanceRequest): Promise<google.longrunning.Operation>;Calls DeleteInstance.
| Parameter | |
|---|---|
| Name | Description |
request |
IDeleteInstanceRequest
DeleteInstanceRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> | Promise |
exportInstance(request, callback)
public exportInstance(request: google.cloud.redis.v1beta1.IExportInstanceRequest, callback: google.cloud.redis.v1beta1.CloudRedis.ExportInstanceCallback): void;Calls ExportInstance.
| Parameters | |
|---|---|
| Name | Description |
request |
IExportInstanceRequest
ExportInstanceRequest message or plain object |
callback |
ExportInstanceCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
exportInstance(request)
public exportInstance(request: google.cloud.redis.v1beta1.IExportInstanceRequest): Promise<google.longrunning.Operation>;Calls ExportInstance.
| Parameter | |
|---|---|
| Name | Description |
request |
IExportInstanceRequest
ExportInstanceRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> | Promise |
failoverInstance(request, callback)
public failoverInstance(request: google.cloud.redis.v1beta1.IFailoverInstanceRequest, callback: google.cloud.redis.v1beta1.CloudRedis.FailoverInstanceCallback): void;Calls FailoverInstance.
| Parameters | |
|---|---|
| Name | Description |
request |
IFailoverInstanceRequest
FailoverInstanceRequest message or plain object |
callback |
FailoverInstanceCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
failoverInstance(request)
public failoverInstance(request: google.cloud.redis.v1beta1.IFailoverInstanceRequest): Promise<google.longrunning.Operation>;Calls FailoverInstance.
| Parameter | |
|---|---|
| Name | Description |
request |
IFailoverInstanceRequest
FailoverInstanceRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> | Promise |
getInstance(request, callback)
public getInstance(request: google.cloud.redis.v1beta1.IGetInstanceRequest, callback: google.cloud.redis.v1beta1.CloudRedis.GetInstanceCallback): void;Calls GetInstance.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetInstanceRequest
GetInstanceRequest message or plain object |
callback |
GetInstanceCallback
Node-style callback called with the error, if any, and Instance |
| Returns | |
|---|---|
| Type | Description |
void | |
getInstance(request)
public getInstance(request: google.cloud.redis.v1beta1.IGetInstanceRequest): Promise<google.cloud.redis.v1beta1.Instance>;Calls GetInstance.
| Parameter | |
|---|---|
| Name | Description |
request |
IGetInstanceRequest
GetInstanceRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.redis.v1beta1.Instance> | Promise |
getInstanceAuthString(request, callback)
public getInstanceAuthString(request: google.cloud.redis.v1beta1.IGetInstanceAuthStringRequest, callback: google.cloud.redis.v1beta1.CloudRedis.GetInstanceAuthStringCallback): void;Calls GetInstanceAuthString.
| Parameters | |
|---|---|
| Name | Description |
request |
IGetInstanceAuthStringRequest
GetInstanceAuthStringRequest message or plain object |
callback |
GetInstanceAuthStringCallback
Node-style callback called with the error, if any, and InstanceAuthString |
| Returns | |
|---|---|
| Type | Description |
void | |
getInstanceAuthString(request)
public getInstanceAuthString(request: google.cloud.redis.v1beta1.IGetInstanceAuthStringRequest): Promise<google.cloud.redis.v1beta1.InstanceAuthString>;Calls GetInstanceAuthString.
| Parameter | |
|---|---|
| Name | Description |
request |
IGetInstanceAuthStringRequest
GetInstanceAuthStringRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.redis.v1beta1.InstanceAuthString> | Promise |
importInstance(request, callback)
public importInstance(request: google.cloud.redis.v1beta1.IImportInstanceRequest, callback: google.cloud.redis.v1beta1.CloudRedis.ImportInstanceCallback): void;Calls ImportInstance.
| Parameters | |
|---|---|
| Name | Description |
request |
IImportInstanceRequest
ImportInstanceRequest message or plain object |
callback |
ImportInstanceCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
importInstance(request)
public importInstance(request: google.cloud.redis.v1beta1.IImportInstanceRequest): Promise<google.longrunning.Operation>;Calls ImportInstance.
| Parameter | |
|---|---|
| Name | Description |
request |
IImportInstanceRequest
ImportInstanceRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> | Promise |
listInstances(request, callback)
public listInstances(request: google.cloud.redis.v1beta1.IListInstancesRequest, callback: google.cloud.redis.v1beta1.CloudRedis.ListInstancesCallback): void;Calls ListInstances.
| Parameters | |
|---|---|
| Name | Description |
request |
IListInstancesRequest
ListInstancesRequest message or plain object |
callback |
ListInstancesCallback
Node-style callback called with the error, if any, and ListInstancesResponse |
| Returns | |
|---|---|
| Type | Description |
void | |
listInstances(request)
public listInstances(request: google.cloud.redis.v1beta1.IListInstancesRequest): Promise<google.cloud.redis.v1beta1.ListInstancesResponse>;Calls ListInstances.
| Parameter | |
|---|---|
| Name | Description |
request |
IListInstancesRequest
ListInstancesRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.cloud.redis.v1beta1.ListInstancesResponse> | Promise |
rescheduleMaintenance(request, callback)
public rescheduleMaintenance(request: google.cloud.redis.v1beta1.IRescheduleMaintenanceRequest, callback: google.cloud.redis.v1beta1.CloudRedis.RescheduleMaintenanceCallback): void;Calls RescheduleMaintenance.
| Parameters | |
|---|---|
| Name | Description |
request |
IRescheduleMaintenanceRequest
RescheduleMaintenanceRequest 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.redis.v1beta1.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.redis.v1beta1.IUpdateInstanceRequest, callback: google.cloud.redis.v1beta1.CloudRedis.UpdateInstanceCallback): void;Calls UpdateInstance.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpdateInstanceRequest
UpdateInstanceRequest message or plain object |
callback |
UpdateInstanceCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
updateInstance(request)
public updateInstance(request: google.cloud.redis.v1beta1.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 |
upgradeInstance(request, callback)
public upgradeInstance(request: google.cloud.redis.v1beta1.IUpgradeInstanceRequest, callback: google.cloud.redis.v1beta1.CloudRedis.UpgradeInstanceCallback): void;Calls UpgradeInstance.
| Parameters | |
|---|---|
| Name | Description |
request |
IUpgradeInstanceRequest
UpgradeInstanceRequest message or plain object |
callback |
UpgradeInstanceCallback
Node-style callback called with the error, if any, and Operation |
| Returns | |
|---|---|
| Type | Description |
void | |
upgradeInstance(request)
public upgradeInstance(request: google.cloud.redis.v1beta1.IUpgradeInstanceRequest): Promise<google.longrunning.Operation>;Calls UpgradeInstance.
| Parameter | |
|---|---|
| Name | Description |
request |
IUpgradeInstanceRequest
UpgradeInstanceRequest message or plain object |
| Returns | |
|---|---|
| Type | Description |
Promise<google.longrunning.Operation> | Promise |