Class Maintenance.MaintenanceClient
Client for Maintenance
Inheritance
Namespace: Etcdserverpb
Assembly: cs.temp.dll.dll
Syntax
public class MaintenanceClient : grpc.ClientBase<Maintenance.MaintenanceClient>
Constructors
MaintenanceClient()
Protected parameterless constructor to allow creation of test doubles.
Declaration
protected MaintenanceClient()
MaintenanceClient(ClientBaseConfiguration)
Protected constructor to allow creation of configured clients.
Declaration
protected MaintenanceClient(ClientBaseConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
ClientBaseConfiguration | configuration | The client configuration. |
MaintenanceClient(grpc.CallInvoker)
Creates a new client for Maintenance that uses a custom CallInvoker
.
Declaration
public MaintenanceClient(grpc.CallInvoker callInvoker)
Parameters
Type | Name | Description |
---|---|---|
grpc.CallInvoker | callInvoker | The callInvoker to use to make remote calls. |
MaintenanceClient(grpc.Channel)
Creates a new client for Maintenance
Declaration
public MaintenanceClient(grpc.Channel channel)
Parameters
Type | Name | Description |
---|---|---|
grpc.Channel | channel | The channel to use to make remote calls. |
Methods
Alarm(AlarmRequest, grpc.CallOptions)
Alarm activates, deactivates, and queries alarms regarding cluster health.
Declaration
public virtual AlarmResponse Alarm(AlarmRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
AlarmRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
AlarmResponse | The response received from the server. |
Alarm(AlarmRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Alarm activates, deactivates, and queries alarms regarding cluster health.
Declaration
public virtual AlarmResponse Alarm(AlarmRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
AlarmRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
AlarmResponse | The response received from the server. |
AlarmAsync(AlarmRequest, grpc.CallOptions)
Alarm activates, deactivates, and queries alarms regarding cluster health.
Declaration
public virtual grpc.AsyncUnaryCall<AlarmResponse> AlarmAsync(AlarmRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
AlarmRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
grpc.AsyncUnaryCall<AlarmResponse> | The call object. |
AlarmAsync(AlarmRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Alarm activates, deactivates, and queries alarms regarding cluster health.
Declaration
public virtual grpc.AsyncUnaryCall<AlarmResponse> AlarmAsync(AlarmRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
AlarmRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
grpc.AsyncUnaryCall<AlarmResponse> | The call object. |
Defragment(DefragmentRequest, grpc.CallOptions)
Defragment defragments a member's backend database to recover storage space.
Declaration
public virtual DefragmentResponse Defragment(DefragmentRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
DefragmentRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
DefragmentResponse | The response received from the server. |
Defragment(DefragmentRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Defragment defragments a member's backend database to recover storage space.
Declaration
public virtual DefragmentResponse Defragment(DefragmentRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
DefragmentRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
DefragmentResponse | The response received from the server. |
DefragmentAsync(DefragmentRequest, grpc.CallOptions)
Defragment defragments a member's backend database to recover storage space.
Declaration
public virtual grpc.AsyncUnaryCall<DefragmentResponse> DefragmentAsync(DefragmentRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
DefragmentRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
grpc.AsyncUnaryCall<DefragmentResponse> | The call object. |
DefragmentAsync(DefragmentRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Defragment defragments a member's backend database to recover storage space.
Declaration
public virtual grpc.AsyncUnaryCall<DefragmentResponse> DefragmentAsync(DefragmentRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
DefragmentRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
grpc.AsyncUnaryCall<DefragmentResponse> | The call object. |
Hash(HashRequest, grpc.CallOptions)
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 virtual HashResponse Hash(HashRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
HashRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
HashResponse | The response received from the server. |
Hash(HashRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
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 virtual HashResponse Hash(HashRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
HashRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
HashResponse | The response received from the server. |
HashAsync(HashRequest, grpc.CallOptions)
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 virtual grpc.AsyncUnaryCall<HashResponse> HashAsync(HashRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
HashRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
grpc.AsyncUnaryCall<HashResponse> | The call object. |
HashAsync(HashRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
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 virtual grpc.AsyncUnaryCall<HashResponse> HashAsync(HashRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
HashRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
grpc.AsyncUnaryCall<HashResponse> | The call object. |
NewInstance(ClientBaseConfiguration)
Creates a new instance of client from given ClientBaseConfiguration
.
Declaration
protected override Maintenance.MaintenanceClient NewInstance(ClientBaseConfiguration configuration)
Parameters
Type | Name | Description |
---|---|---|
ClientBaseConfiguration | configuration |
Returns
Type | Description |
---|---|
Maintenance.MaintenanceClient |
Snapshot(SnapshotRequest, grpc.CallOptions)
Snapshot sends a snapshot of the entire backend from a member over a stream to a client.
Declaration
public virtual grpc.AsyncServerStreamingCall<SnapshotResponse> Snapshot(SnapshotRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
SnapshotRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
grpc.AsyncServerStreamingCall<SnapshotResponse> | The call object. |
Snapshot(SnapshotRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Snapshot sends a snapshot of the entire backend from a member over a stream to a client.
Declaration
public virtual grpc.AsyncServerStreamingCall<SnapshotResponse> Snapshot(SnapshotRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
SnapshotRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
grpc.AsyncServerStreamingCall<SnapshotResponse> | The call object. |
Status(StatusRequest, grpc.CallOptions)
Status gets the status of the member.
Declaration
public virtual StatusResponse Status(StatusRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
StatusRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
StatusResponse | The response received from the server. |
Status(StatusRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Status gets the status of the member.
Declaration
public virtual StatusResponse Status(StatusRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
StatusRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
StatusResponse | The response received from the server. |
StatusAsync(StatusRequest, grpc.CallOptions)
Status gets the status of the member.
Declaration
public virtual grpc.AsyncUnaryCall<StatusResponse> StatusAsync(StatusRequest request, grpc.CallOptions options)
Parameters
Type | Name | Description |
---|---|---|
StatusRequest | request | The request to send to the server. |
grpc.CallOptions | options | The options for the call. |
Returns
Type | Description |
---|---|
grpc.AsyncUnaryCall<StatusResponse> | The call object. |
StatusAsync(StatusRequest, grpc.Metadata, Nullable<DateTime>, CancellationToken)
Status gets the status of the member.
Declaration
public virtual grpc.AsyncUnaryCall<StatusResponse> StatusAsync(StatusRequest request, grpc.Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
StatusRequest | request | The request to send to the server. |
grpc.Metadata | headers | The initial metadata to send with the call. This parameter is optional. |
System.Nullable<DateTime> | deadline | An optional deadline for the call. The call will be cancelled if deadline is hit. |
CancellationToken | cancellationToken | An optional token for canceling the call. |
Returns
Type | Description |
---|---|
grpc.AsyncUnaryCall<StatusResponse> | The call object. |