Class BrokerClientConfig

The settings of Client Config.

Inheritance

System.Object

BrokerClientConfig

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.ResourceManager.IotOperations.dll

Syntax

public class BrokerClientConfig : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.IotOperations.Models.BrokerClientConfig>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.IotOperations.Models.BrokerClientConfig>

Constructors

BrokerClientConfig()

Initializes a new instance of BrokerClientConfig.

Declaration

public BrokerClientConfig ();

Properties

MaxKeepAliveSeconds

Upper bound of a client's Keep Alive, in seconds.

Declaration

public Nullable<int> MaxKeepAliveSeconds { get; set; }

Property Value

System.Nullable<System.Int32>

MaxMessageExpirySeconds

Upper bound of Message Expiry Interval, in seconds.

Declaration

public Nullable<int> MaxMessageExpirySeconds { get; set; }

Property Value

System.Nullable<System.Int32>

MaxPacketSizeBytes

Max message size for a packet in Bytes.

Declaration

public Nullable<int> MaxPacketSizeBytes { get; set; }

Property Value

System.Nullable<System.Int32>

MaxReceiveMaximum

Upper bound of Receive Maximum that a client can request in the CONNECT packet.

Declaration

public Nullable<int> MaxReceiveMaximum { get; set; }

Property Value

System.Nullable<System.Int32>

MaxSessionExpirySeconds

Upper bound of Session Expiry Interval, in seconds.

Declaration

public Nullable<int> MaxSessionExpirySeconds { get; set; }

Property Value

System.Nullable<System.Int32>

SubscriberQueueLimit

The limit on the number of queued messages for a subscriber.

Declaration

public Azure.ResourceManager.IotOperations.Models.SubscriberQueueLimit SubscriberQueueLimit { get; set; }

Property Value

SubscriberQueueLimit

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration

protected virtual void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonWriter writer The JSON writer.

System.ClientModel.Primitives.ModelReaderWriterOptions options The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<BrokerClientConfig>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration

Azure.ResourceManager.IotOperations.Models.BrokerClientConfig IJsonModel<BrokerClientConfig>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonReader reader The System.Text.Json.Utf8JsonReader to read.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

BrokerClientConfig A T representation of the JSON value.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<BrokerClientConfig>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration

void IJsonModel<BrokerClientConfig>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.Text.Json.Utf8JsonWriter writer The System.Text.Json.Utf8JsonWriter to write into.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<BrokerClientConfig>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration

Azure.ResourceManager.IotOperations.Models.BrokerClientConfig IPersistableModel<BrokerClientConfig>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.BinaryData data The System.BinaryData to parse.

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

BrokerClientConfig A T representation of the data.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<BrokerClientConfig>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration

string IPersistableModel<BrokerClientConfig>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.

Returns

System.String The format that the model uses when communicating with the service.

IPersistableModel<BrokerClientConfig>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration

BinaryData IPersistableModel<BrokerClientConfig>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);

Parameters

System.ClientModel.Primitives.ModelReaderWriterOptions options The System.ClientModel.Primitives.ModelReaderWriterOptions to use.

Returns

System.BinaryData A binary representation of the written model.

Exceptions

System.FormatException If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.