Class EdgeRegistryThingDescriptionExtensions.Client

Namespace

Azure.Iot.Operations.Services.EdgeRegistry.Generated

Assembly

Azure.Iot.Operations.Services.dll

public abstract class EdgeRegistryThingDescriptionExtensions.Client : IAsyncDisposable

Inheritance

object

EdgeRegistryThingDescriptionExtensions.Client

Implements

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Client(ApplicationContext, IMqttPubSubClient, Dictionary<string, string>?)

Construct a new instance of this client.

public Client(ApplicationContext applicationContext, IMqttPubSubClient mqttClient, Dictionary<string, string>? topicTokenMap = null)

Parameters

applicationContext ApplicationContext

The shared context for your application.

mqttClient IMqttPubSubClient

The MQTT client to use.

topicTokenMap Dictionary<string, string>

The topic token replacement map to use for all operations by default. Generally, this will include the token values for topic tokens that should be the same for the duration of this client's lifetime.

Properties

CreateThingDescriptionActionInvoker

public EdgeRegistryThingDescriptionExtensions.CreateThingDescriptionActionInvoker CreateThingDescriptionActionInvoker { get; }

Property Value

EdgeRegistryThingDescriptionExtensions.CreateThingDescriptionActionInvoker

CreateThingDescriptionVersionActionInvoker

public EdgeRegistryThingDescriptionExtensions.CreateThingDescriptionVersionActionInvoker CreateThingDescriptionVersionActionInvoker { get; }

Property Value

EdgeRegistryThingDescriptionExtensions.CreateThingDescriptionVersionActionInvoker

GetThingDescriptionActionInvoker

public EdgeRegistryThingDescriptionExtensions.GetThingDescriptionActionInvoker GetThingDescriptionActionInvoker { get; }

Property Value

EdgeRegistryThingDescriptionExtensions.GetThingDescriptionActionInvoker

GetThingDescriptionVersionActionInvoker

public EdgeRegistryThingDescriptionExtensions.GetThingDescriptionVersionActionInvoker GetThingDescriptionVersionActionInvoker { get; }

Property Value

EdgeRegistryThingDescriptionExtensions.GetThingDescriptionVersionActionInvoker

Methods

CreateThingDescriptionAsync(CreateThingDescriptionAttributes, CommandRequestMetadata?, Dictionary<string, string>?, TimeSpan?, CancellationToken)

Invoke a command.

public RpcCallAsync<ThingDescription> CreateThingDescriptionAsync(CreateThingDescriptionAttributes request, CommandRequestMetadata? requestMetadata = null, Dictionary<string, string>? additionalTopicTokenMap = null, TimeSpan? commandTimeout = null, CancellationToken cancellationToken = default)

Parameters

request CreateThingDescriptionAttributes

The data for this command request.

requestMetadata CommandRequestMetadata

The metadata for this command request.

additionalTopicTokenMap Dictionary<string, string>

The topic token replacement map to use in addition to the topic tokens specified in the constructor. If this map contains any keys that the topic tokens specified in the constructor also has, then values specified in this map will take precedence.

commandTimeout TimeSpan?

How long the command will be available on the broker for an executor to receive.

cancellationToken CancellationToken

Cancellation token.

Returns

RpcCallAsync<ThingDescription>

The command response.

CreateThingDescriptionVersionAsync(CreateThingDescriptionVersionAttributes, CommandRequestMetadata?, Dictionary<string, string>?, TimeSpan?, CancellationToken)

Invoke a command.

public RpcCallAsync<ThingDescriptionVersion> CreateThingDescriptionVersionAsync(CreateThingDescriptionVersionAttributes request, CommandRequestMetadata? requestMetadata = null, Dictionary<string, string>? additionalTopicTokenMap = null, TimeSpan? commandTimeout = null, CancellationToken cancellationToken = default)

Parameters

request CreateThingDescriptionVersionAttributes

The data for this command request.

requestMetadata CommandRequestMetadata

The metadata for this command request.

additionalTopicTokenMap Dictionary<string, string>

The topic token replacement map to use in addition to the topic tokens specified in the constructor. If this map contains any keys that the topic tokens specified in the constructor also has, then values specified in this map will take precedence.

commandTimeout TimeSpan?

How long the command will be available on the broker for an executor to receive.

cancellationToken CancellationToken

Cancellation token.

Returns

RpcCallAsync<ThingDescriptionVersion>

The command response.

DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

public ValueTask DisposeAsync()

Returns

ValueTask

A task that represents the asynchronous dispose operation.

DisposeAsync(bool, CancellationToken)

public ValueTask DisposeAsync(bool disposing, CancellationToken cancellationToken = default)

Parameters

disposing bool

cancellationToken CancellationToken

Returns

ValueTask

GetThingDescriptionAsync(GetThingDescriptionInputArguments, CommandRequestMetadata?, Dictionary<string, string>?, TimeSpan?, CancellationToken)

Invoke a command.

public RpcCallAsync<ThingDescription> GetThingDescriptionAsync(GetThingDescriptionInputArguments request, CommandRequestMetadata? requestMetadata = null, Dictionary<string, string>? additionalTopicTokenMap = null, TimeSpan? commandTimeout = null, CancellationToken cancellationToken = default)

Parameters

request GetThingDescriptionInputArguments

The data for this command request.

requestMetadata CommandRequestMetadata

The metadata for this command request.

additionalTopicTokenMap Dictionary<string, string>

The topic token replacement map to use in addition to the topic tokens specified in the constructor. If this map contains any keys that the topic tokens specified in the constructor also has, then values specified in this map will take precedence.

commandTimeout TimeSpan?

How long the command will be available on the broker for an executor to receive.

cancellationToken CancellationToken

Cancellation token.

Returns

RpcCallAsync<ThingDescription>

The command response.

GetThingDescriptionVersionAsync(GetThingDescriptionVersionInputArguments, CommandRequestMetadata?, Dictionary<string, string>?, TimeSpan?, CancellationToken)

Invoke a command.

public RpcCallAsync<ThingDescriptionVersion> GetThingDescriptionVersionAsync(GetThingDescriptionVersionInputArguments request, CommandRequestMetadata? requestMetadata = null, Dictionary<string, string>? additionalTopicTokenMap = null, TimeSpan? commandTimeout = null, CancellationToken cancellationToken = default)

Parameters

request GetThingDescriptionVersionInputArguments

The data for this command request.

requestMetadata CommandRequestMetadata

The metadata for this command request.

additionalTopicTokenMap Dictionary<string, string>

The topic token replacement map to use in addition to the topic tokens specified in the constructor. If this map contains any keys that the topic tokens specified in the constructor also has, then values specified in this map will take precedence.

commandTimeout TimeSpan?

How long the command will be available on the broker for an executor to receive.

cancellationToken CancellationToken

Cancellation token.

Returns

RpcCallAsync<ThingDescriptionVersion>

The command response.

StopAsync(CancellationToken)

Stop accepting telemetry for all telemetry receivers and make all command invokers unsubscribe from command topics.

public Task StopAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Cancellation token.

Returns

Task