Class MaintenanceExtensions

Inheritance

System.Object

MaintenanceExtensions

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: ETCD.V3

Assembly: cs.temp.dll.dll

Syntax

public static class MaintenanceExtensions

Methods

Alarm(Client, UInt64, AlarmAction, AlarmType)

Alarm activates, deactivates, and queries alarms regarding cluster health.

Declaration

public static AlarmResponse Alarm(this Client client, ulong memberID, AlarmAction action = null, AlarmType alarm = null)

Parameters

Type	Name	Description
Client	client
System.UInt64	memberID	memberID is the ID of the member associated with the alarm. If memberID is 0, the alarm request covers all members.
AlarmAction	action	action is the kind of alarm request to issue. The action may GET alarm statuses, ACTIVATE an alarm, or DEACTIVATE a raised alarm.
AlarmType	alarm	alarm is the type of alarm to consider for this request.

Returns

Type	Description
AlarmResponse	The response received from the server.

AlarmAsync(Client, UInt64, AlarmAction, AlarmType)

Alarm activates, deactivates, and queries alarms regarding cluster health.

Declaration

public static AsyncUnaryCall<AlarmResponse> AlarmAsync(this Client client, ulong memberID, AlarmAction action = null, AlarmType alarm = null)

Parameters

Type	Name	Description
Client	client
System.UInt64	memberID	memberID is the ID of the member associated with the alarm. If memberID is 0, the alarm request covers all members.
AlarmAction	action	action is the kind of alarm request to issue. The action may GET alarm statuses, ACTIVATE an alarm, or DEACTIVATE a raised alarm.
AlarmType	alarm	alarm is the type of alarm to consider for this request.

Returns

Type	Description
AsyncUnaryCall<AlarmResponse>	The call object.

CreateAlarmRequest(Client, UInt64, AlarmAction, AlarmType)

Create AlarmRequest.

Declaration

public static AlarmRequest CreateAlarmRequest(this Client client, ulong memberID, AlarmAction action = null, AlarmType alarm = null)

Parameters

Type	Name	Description
Client	client
System.UInt64	memberID	memberID is the ID of the member associated with the alarm. If memberID is 0, the alarm request covers all members.
AlarmAction	action	action is the kind of alarm request to issue. The action may GET alarm statuses, ACTIVATE an alarm, or DEACTIVATE a raised alarm.
AlarmType	alarm	alarm is the type of alarm to consider for this request.

Returns

Type	Description
AlarmRequest	AlarmRequest.

Defragment(Client)

Defragment defragments a member's backend database to recover storage space.

Declaration

public static DefragmentResponse Defragment(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
DefragmentResponse	The response received from the server.

DefragmentAsync(Client)

Defragment defragments a member's backend database to recover storage space.

Declaration

public static AsyncUnaryCall<DefragmentResponse> DefragmentAsync(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
AsyncUnaryCall<DefragmentResponse>	The call object.

Hash(Client)

Hash returns the hash of the local KV state for consistency checking purpose. This is designed for testing; do not use this in production when there are ongoing transactions.

Declaration

public static HashResponse Hash(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
HashResponse	The response received from the server.

HashAsync(Client)

Hash returns the hash of the local KV state for consistency checking purpose. This is designed for testing; do not use this in production when there are ongoing transactions.

Declaration

public static AsyncUnaryCall<HashResponse> HashAsync(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
AsyncUnaryCall<HashResponse>	The call object.

Snapshot(Client)

Snapshot sends a snapshot of the entire backend from a member over a stream to a client.

Declaration

public static AsyncServerStreamingCall<SnapshotResponse> Snapshot(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
AsyncServerStreamingCall<SnapshotResponse>	The call object.

Status(Client)

Status gets the status of the member.

Declaration

public static StatusResponse Status(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
StatusResponse	The response received from the server.

StatusAsync(Client)

Status gets the status of the member.

Declaration

public static AsyncUnaryCall<StatusResponse> StatusAsync(this Client client)

Parameters

Type	Name	Description
Client	client

Returns

Type	Description
AsyncUnaryCall<StatusResponse>	The call object.