Class ClusterClient

Index

Constructors

Methods

memberAdd memberList memberPromote memberRemove memberUpdate

Constructors

constructor

new ClusterClient(client: ICallable<unknown>): ClusterClient
Parameters
- client: ICallable<unknown>
Returns ClusterClient
- Defined in src/rpc.ts:205

Methods

memberAdd

memberAdd(
req: IMemberAddRequest,
options?: CallOptions,
): Promise<IMemberAddResponse>
MemberAdd adds a member into the cluster.
Parameters
- req: IMemberAddRequest
- Optionaloptions: CallOptions
Returns Promise<IMemberAddResponse>
- Defined in src/rpc.ts:209

memberList

memberList(
req: IMemberListRequest,
options?: CallOptions,
): Promise<IMemberListResponse>
MemberList lists all the members in the cluster.
Parameters
- req: IMemberListRequest
- Optionaloptions: CallOptions
Returns Promise<IMemberListResponse>
- Defined in src/rpc.ts:236

memberPromote

memberPromote(
req: IMemberPromoteRequest,
options?: CallOptions,
): Promise<IMemberPromoteResponse>
MemberPromote promotes a member from raft learner (non-voting) to raft voting member.
Parameters
- req: IMemberPromoteRequest
- Optionaloptions: CallOptions
Returns Promise<IMemberPromoteResponse>
- Defined in src/rpc.ts:245

memberRemove

memberRemove(
req: IMemberRemoveRequest,
options?: CallOptions,
): Promise<IMemberRemoveResponse>
MemberRemove removes an existing member from the cluster.
Parameters
- req: IMemberRemoveRequest
- Optionaloptions: CallOptions
Returns Promise<IMemberRemoveResponse>
- Defined in src/rpc.ts:218

memberUpdate

memberUpdate(
req: IMemberUpdateRequest,
options?: CallOptions,
): Promise<IMemberUpdateResponse>
MemberUpdate updates the member configuration.
Parameters
- req: IMemberUpdateRequest
- Optionaloptions: CallOptions
Returns Promise<IMemberUpdateResponse>
- Defined in src/rpc.ts:227