Class GrpcClient

Namespace: ArmoniK.Api.Client.Options
Assembly: ArmoniK.Api.Client.dll

Options for creating a gRPC Client with

[ExtractDocumentation("Options for GrpcClient")]
[PublicAPI]
public class GrpcClient

Inheritance

object ← GrpcClient

Inherited Members

object.Equals(object), object.Equals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object, object), object.ToString()

Fields

SettingSection

Path to the section containing the values in the configuration object

public const string SettingSection = "GrpcClient"

Field Value

string

Properties

AllowUnsafeConnection

Allow unsafe connections to the endpoint (without SSL), defaults to false

public bool AllowUnsafeConnection { get; set; }

Property Value

bool

BackoffMultiplier

The backoff will be multiplied by this multiplier after each retry attempt and will increase exponentially when the multiplier is greater than 1.

public double BackoffMultiplier { get; set; }

Property Value

double

CaCert

Path to the Certificate Authority file in pem format

public string CaCert { get; set; }

Property Value

string

CertP12

Path to the certificate file in p12/pfx format

public string CertP12 { get; set; }

Property Value

string

CertPem

Path to the certificate file in pem format

public string CertPem { get; set; }

Property Value

string

Endpoint

Endpoint for sending requests

public string? Endpoint { get; set; }

Property Value

string?

HasClientCertificate

True if the options specify a client certificate

public bool HasClientCertificate { get; }

Property Value

bool

HttpMessageHandler

Which HttpMessageHandler to use. Valid options:

HttpClientHandler
WinHttpHandler
GrpcWebHandler If the handler is not set, the best one will be used.

public string HttpMessageHandler { get; set; }

Property Value

string

InitialBackOff

InitialBackOff is a property that gets and sets the initial backOff time for retrying an operation.

public TimeSpan InitialBackOff { get; set; }

Property Value

TimeSpan

KeepAliveTime

KeepAliveTime is the time after which the connection will be kept alive.

public TimeSpan KeepAliveTime { get; set; }

Property Value

TimeSpan

KeepAliveTimeInterval

KeepAliveTimeInterval is the interval at which the connection will be kept alive.

public TimeSpan KeepAliveTimeInterval { get; set; }

Property Value

TimeSpan

KeyPem

Path to the key file in pem format

public string KeyPem { get; set; }

Property Value

string

MaxAttempts

MaxAttempts is a property that gets and sets the maximum number of attempts to retry an operation.

public int MaxAttempts { get; set; }

Property Value

int

MaxBackOff

MaxBackOff is a property that gets and sets the maximum backOff time for retrying an operation.

public TimeSpan MaxBackOff { get; set; }

Property Value

TimeSpan

MaxIdleTime

MaxIdleTime is the maximum idle time after which the connection will be closed.

public TimeSpan MaxIdleTime { get; set; }

Property Value

TimeSpan

OverrideTargetName

Override the endpoint name during SSL verification. This option is only used when AllowUnsafeConnection is true and only when the runtime is .NET Framework. Automatic target name by default. Should be overriden by the right name to reduce performance cost.

public string OverrideTargetName { get; set; }

Property Value

string

Proxy

Proxy configuration. If empty, the default proxy configuration is used. If “none”, proxy is disabled. If “system”, the system proxy is used Otherwise, it is the URL of the proxy to use

public string Proxy { get; set; }

Property Value

string

ProxyPassword

Password used for proxy authentication

public string ProxyPassword { get; set; }

Property Value

string

ProxyUsername

Username used for proxy authentication

public string ProxyUsername { get; set; }

Property Value

string

RequestTimeout

Timeout for grpc requests. Defaults to no timeout.

public TimeSpan RequestTimeout { get; set; }

Property Value

TimeSpan

ReusePorts

Enable the option SO_REUSE_UNICASTPORT upon socket opening to limit port exhaustion

public bool ReusePorts { get; set; }

Property Value

bool