diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/AcceptJobOfferResult.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/AcceptJobOfferResult.cs index 8c0ea8fa827b..fcea57cce57e 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/AcceptJobOfferResult.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/AcceptJobOfferResult.cs @@ -10,13 +10,13 @@ namespace Azure.Communication.JobRouter { - /// Response containing Id's for the worker, job, and assignment from an accepted offer. + /// Response containing ids for the worker, job, and assignment from an accepted offer. public partial class AcceptJobOfferResult { /// Initializes a new instance of AcceptJobOfferResult. - /// The assignment Id that assigns a worker that has accepted an offer to a job. - /// The Id of the job assigned. - /// The Id of the worker that has been assigned this job. + /// Id of job assignment that assigns a worker that has accepted an offer to a job. + /// Id of the job assigned. + /// Id of the worker that has been assigned this job. /// , or is null. internal AcceptJobOfferResult(string assignmentId, string jobId, string workerId) { @@ -29,11 +29,11 @@ internal AcceptJobOfferResult(string assignmentId, string jobId, string workerId WorkerId = workerId; } - /// The assignment Id that assigns a worker that has accepted an offer to a job. + /// Id of job assignment that assigns a worker that has accepted an offer to a job. public string AssignmentId { get; } - /// The Id of the job assigned. + /// Id of the job assigned. public string JobId { get; } - /// The Id of the worker that has been assigned this job. + /// Id of the worker that has been assigned this job. public string WorkerId { get; } } } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/BestWorkerMode.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/BestWorkerMode.cs index cad728f54377..b300cef307c7 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/BestWorkerMode.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/BestWorkerMode.cs @@ -13,7 +13,7 @@ public partial class BestWorkerMode : DistributionMode /// Initializes a new instance of BestWorkerMode. /// Governs the minimum desired number of active concurrent offers a job can have. /// Governs the maximum number of active concurrent offers a job can have. - /// If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for the job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false. + /// If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for a job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false. /// The type discriminator describing a sub-type of DistributionMode. /// Define a scoring rule to use, when calculating a score to determine the best worker. If not set, will use a default scoring formula that uses the number of job labels that the worker labels match, as well as the number of label selectors the worker labels match and/or exceed using a logistic function (https://en.wikipedia.org/wiki/Logistic_function). /// Options to configure 'scoringRule'. If not set, default values are used. diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/CancelExceptionAction.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/CancelExceptionAction.cs index c28fb7501987..da1e813798bb 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/CancelExceptionAction.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/CancelExceptionAction.cs @@ -13,8 +13,8 @@ public partial class CancelExceptionAction : ExceptionAction /// Initializes a new instance of CancelExceptionAction. /// Unique Id of the exception action. /// The type discriminator describing a sub-type of ExceptionAction. - /// A note that will be appended to the jobs' Notes collection with the current timestamp. - /// Indicates the outcome of the job, populate this field with your own custom values. + /// A note that will be appended to a job's notes collection with the current timestamp. + /// Indicates the outcome of a job, populate this field with your own custom values. internal CancelExceptionAction(string id, ExceptionActionKind kind, string note, string dispositionCode) : base(id, kind) { Note = note; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/CancelJobOptions.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/CancelJobOptions.cs index afdc0972ea9e..5a18047af864 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/CancelJobOptions.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/CancelJobOptions.cs @@ -7,12 +7,12 @@ namespace Azure.Communication.JobRouter { - /// Request payload for deleting a job. + /// Request payload for cancelling a job. public partial class CancelJobOptions { /// Initializes a new instance of CancelJobOptions. - /// A note that will be appended to the jobs' Notes collection with the current timestamp. - /// Indicates the outcome of the job, populate this field with your own custom values. If not provided, default value of "Cancelled" is set. + /// A note that will be appended to a job's Notes collection with the current timestamp. + /// Indicates the outcome of a job, populate this field with your own custom values. If not provided, default value of "Cancelled" is set. internal CancelJobOptions(string note, string dispositionCode) { Note = note; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ClassificationPolicy.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ClassificationPolicy.cs index 2b346c573e92..a2b808d00791 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ClassificationPolicy.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ClassificationPolicy.cs @@ -22,12 +22,12 @@ internal ClassificationPolicy() /// Initializes a new instance of ClassificationPolicy. /// The entity tag for this resource. - /// Unique identifier of this policy. + /// Id of a classification policy. /// Friendly name of this policy. - /// The fallback queue to select if the queue selector doesn't find a match. - /// The queue selector attachments used to resolve a queue for a given job. - /// The rule to determine a priority score for a given job. - /// The worker selector attachments used to attach worker selectors to a given job. + /// Id of a fallback queue to select if queue selector attachments doesn't find a match. + /// Queue selector attachments used to resolve a queue for a job. + /// A rule to determine a priority score for a job. + /// Worker selector attachments used to attach worker selectors to a job. internal ClassificationPolicy(string etag, string id, string name, string fallbackQueueId, IList queueSelectorAttachments, RouterRule prioritizationRule, IList workerSelectorAttachments) { _etag = etag; @@ -38,7 +38,7 @@ internal ClassificationPolicy(string etag, string id, string name, string fallba PrioritizationRule = prioritizationRule; WorkerSelectorAttachments = workerSelectorAttachments; } - /// Unique identifier of this policy. + /// Id of a classification policy. public string Id { get; } } } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/CloseJobOptions.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/CloseJobOptions.cs index 7ef9aefb5ff6..e85b213fb002 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/CloseJobOptions.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/CloseJobOptions.cs @@ -13,9 +13,9 @@ namespace Azure.Communication.JobRouter public partial class CloseJobOptions { /// Initializes a new instance of CloseJobOptions. - /// Indicates the outcome of the job, populate this field with your own custom values. + /// Indicates the outcome of a job, populate this field with your own custom values. /// If not provided, worker capacity is released immediately along with a JobClosedEvent notification. If provided, worker capacity is released along with a JobClosedEvent notification at a future time in UTC. - /// A note that will be appended to the jobs' Notes collection with the current timestamp. + /// A note that will be appended to a job's Notes collection with the current timestamp. internal CloseJobOptions(string dispositionCode, DateTimeOffset closeAt, string note) { DispositionCode = dispositionCode; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/CommunicationJobRouterClientBuilderExtensions.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/CommunicationJobRouterClientBuilderExtensions.cs index 00ea7a113659..f17575034663 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/CommunicationJobRouterClientBuilderExtensions.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/CommunicationJobRouterClientBuilderExtensions.cs @@ -16,7 +16,7 @@ internal static partial class CommunicationJobRouterClientBuilderExtensions { /// Registers a instance. /// The builder to register with. - /// The Uri to use. + /// Uri of your Communication resource. public static IAzureClientBuilder AddJobRouterAdministrationClient(this TBuilder builder, Uri endpoint) where TBuilder : IAzureClientFactoryBuilder { @@ -25,7 +25,7 @@ public static IAzureClientBuilder Registers a instance. /// The builder to register with. - /// The Uri to use. + /// Uri of your Communication resource. public static IAzureClientBuilder AddJobRouterClient(this TBuilder builder, Uri endpoint) where TBuilder : IAzureClientFactoryBuilder { diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/CompleteJobOptions.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/CompleteJobOptions.cs index 5b9cb1dd6e2f..c7e3ffb02722 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/CompleteJobOptions.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/CompleteJobOptions.cs @@ -11,7 +11,7 @@ namespace Azure.Communication.JobRouter public partial class CompleteJobOptions { /// Initializes a new instance of CompleteJobOptions. - /// A note that will be appended to the jobs' Notes collection with the current timestamp. + /// A note that will be appended to a job's Notes collection with the current timestamp. internal CompleteJobOptions(string note) { Note = note; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ConditionalQueueSelectorAttachment.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ConditionalQueueSelectorAttachment.cs index e0a0a7bb41c1..413329d9ac61 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ConditionalQueueSelectorAttachment.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ConditionalQueueSelectorAttachment.cs @@ -40,7 +40,7 @@ internal ConditionalQueueSelectorAttachment(QueueSelectorAttachmentKind kind, Ro } /// - /// The condition that must be true for the queue selectors to be attached + /// The condition that must be true for the queue selectors to be attached. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include , , , and . /// diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ConditionalWorkerSelectorAttachment.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ConditionalWorkerSelectorAttachment.cs index d2376c7ecf67..9d8a940dac78 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ConditionalWorkerSelectorAttachment.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ConditionalWorkerSelectorAttachment.cs @@ -40,7 +40,7 @@ internal ConditionalWorkerSelectorAttachment(WorkerSelectorAttachmentKind kind, } /// - /// The condition that must be true for the worker selectors to be attached + /// The condition that must be true for the worker selectors to be attached. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include , , , and . /// diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/DistributionMode.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/DistributionMode.cs index 6beb6b5c22ae..8831486d0205 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/DistributionMode.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/DistributionMode.cs @@ -8,7 +8,7 @@ namespace Azure.Communication.JobRouter { /// - /// Abstract base class for defining a distribution mode + /// Abstract base class for defining a distribution mode. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include , and . /// @@ -22,7 +22,7 @@ protected DistributionMode() /// Initializes a new instance of DistributionMode. /// Governs the minimum desired number of active concurrent offers a job can have. /// Governs the maximum number of active concurrent offers a job can have. - /// If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for the job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false. + /// If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for a job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false. /// The type discriminator describing a sub-type of DistributionMode. internal DistributionMode(int minConcurrentOffers, int maxConcurrentOffers, bool? bypassSelectors, DistributionModeKind kind) { diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/DistributionModeKind.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/DistributionModeKind.cs index af876deeac3b..50ec9c0ee3b9 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/DistributionModeKind.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/DistributionModeKind.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Supported distribution mode types. + /// Discriminators for supported distribution mode types. public readonly partial struct DistributionModeKind : IEquatable { private readonly string _value; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/DistributionPolicy.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/DistributionPolicy.cs index 7015e89871db..fa35fb0af4b6 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/DistributionPolicy.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/DistributionPolicy.cs @@ -17,10 +17,10 @@ internal DistributionPolicy() /// Initializes a new instance of DistributionPolicy. /// The entity tag for this resource. - /// The unique identifier of the policy. - /// The human readable name of the policy. - /// The number of seconds after which any offers created under this policy will be expired. - /// Abstract base class for defining a distribution mode. + /// Id of a distribution policy. + /// Friendly name of this policy. + /// Number of seconds after which any offers created under this policy will be expired. + /// Mode governing the specific distribution method. internal DistributionPolicy(string etag, string id, string name, double? offerExpiresAfterSeconds, DistributionMode mode) { _etag = etag; @@ -29,7 +29,7 @@ internal DistributionPolicy(string etag, string id, string name, double? offerEx _offerExpiresAfterSeconds = offerExpiresAfterSeconds; Mode = mode; } - /// The unique identifier of the policy. + /// Id of a distribution policy. public string Id { get; } } } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionAction.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionAction.cs index 842eceb2a1a8..224dae27a1bf 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionAction.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionAction.cs @@ -8,7 +8,7 @@ namespace Azure.Communication.JobRouter { /// - /// The action to take when the exception is triggered + /// The action to take when the exception is triggered. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include , and . /// diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionActionKind.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionActionKind.cs index f819adc24601..e12b1a808962 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionActionKind.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionActionKind.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Supported exception action types. + /// Discriminators for supported exception action types. public readonly partial struct ExceptionActionKind : IEquatable { private readonly string _value; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionPolicy.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionPolicy.cs index 4f3c58a87bba..5c8574c94a23 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionPolicy.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionPolicy.cs @@ -21,8 +21,8 @@ internal ExceptionPolicy() /// Initializes a new instance of ExceptionPolicy. /// The entity tag for this resource. - /// The Id of the exception policy. - /// The name of the exception policy. + /// Id of an exception policy. + /// Friendly name of this policy. /// A collection of exception rules on the exception policy. internal ExceptionPolicy(string etag, string id, string name, IList exceptionRules) { @@ -31,7 +31,7 @@ internal ExceptionPolicy(string etag, string id, string name, IList The Id of the exception policy. + /// Id of an exception policy. public string Id { get; } } } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionRule.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionRule.cs index c6f06f1107a3..543959b5d23a 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionRule.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionRule.cs @@ -16,7 +16,7 @@ namespace Azure.Communication.JobRouter public partial class ExceptionRule { /// Initializes a new instance of ExceptionRule. - /// Id of the exception rule. + /// Id of an exception rule. /// The trigger for this exception rule. /// A collection of actions to perform once the exception is triggered. /// , or is null. @@ -32,7 +32,7 @@ internal ExceptionRule(string id, ExceptionTrigger trigger, IEnumerable Initializes a new instance of ExceptionRule. - /// Id of the exception rule. + /// Id of an exception rule. /// The trigger for this exception rule. /// A collection of actions to perform once the exception is triggered. internal ExceptionRule(string id, ExceptionTrigger trigger, IList actions) @@ -42,10 +42,10 @@ internal ExceptionRule(string id, ExceptionTrigger trigger, IList Id of the exception rule. + /// Id of an exception rule. public string Id { get; } /// - /// The trigger for this exception rule + /// The trigger for this exception rule. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include and . /// diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionTrigger.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionTrigger.cs index d3aff61347c3..9eb6f3fc0ec1 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionTrigger.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionTrigger.cs @@ -8,7 +8,7 @@ namespace Azure.Communication.JobRouter { /// - /// The trigger for this exception rule + /// Abstract base class for defining a trigger for exception rules. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include and . /// diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionTriggerKind.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionTriggerKind.cs index 4ad0fb4e85af..1961417cd219 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionTriggerKind.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExceptionTriggerKind.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Supported exception trigger types. + /// Discriminators for supported exception trigger types. public readonly partial struct ExceptionTriggerKind : IEquatable { private readonly string _value; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExpressionRouterRule.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExpressionRouterRule.cs index 39850d80a0d7..3fc2688567e6 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExpressionRouterRule.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExpressionRouterRule.cs @@ -16,13 +16,13 @@ public partial class ExpressionRouterRule : RouterRule /// Initializes a new instance of ExpressionRouterRule. /// The type discriminator describing a sub-type of RouterRule. /// The expression language to compile to and execute. - /// The string containing the expression to evaluate. Should contain return statement with calculated values. + /// An expression to evaluate. Should contain return statement with calculated values. internal ExpressionRouterRule(RouterRuleKind kind, string language, string expression) : base(kind) { Language = language; Expression = expression; } - /// The string containing the expression to evaluate. Should contain return statement with calculated values. + /// An expression to evaluate. Should contain return statement with calculated values. public string Expression { get; } } } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExpressionRouterRuleLanguage.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExpressionRouterRuleLanguage.cs index 688f830a662f..5f33e0d5ab63 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExpressionRouterRuleLanguage.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ExpressionRouterRuleLanguage.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// The available expression languages that can be configured. + /// Available expression languages that can be configured. internal readonly partial struct ExpressionRouterRuleLanguage : IEquatable { private readonly string _value; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobMatchingModeKind.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobMatchingModeKind.cs index 3a0465159123..74c108857f59 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobMatchingModeKind.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobMatchingModeKind.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Supported matching mode types. + /// Discriminators for supported matching mode types. public readonly partial struct JobMatchingModeKind : IEquatable { private readonly string _value; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobRouterAdministrationClient.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobRouterAdministrationClient.cs index c104cefbc634..fb31c9b8e3c6 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobRouterAdministrationClient.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobRouterAdministrationClient.cs @@ -39,7 +39,7 @@ public partial class JobRouterAdministrationClient /// /// /// - /// The unique identifier of the policy. + /// Id of a distribution policy. /// The content to send as the body of the request. /// The content to send as the request conditions of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. @@ -79,7 +79,7 @@ internal virtual async Task UpsertDistributionPolicyAsync(string distr /// /// /// - /// The unique identifier of the policy. + /// Id of a distribution policy. /// The content to send as the body of the request. /// The content to send as the request conditions of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. @@ -110,7 +110,7 @@ internal virtual Response UpsertDistributionPolicy(string distributionPolicyId, } /// Retrieves an existing distribution policy by Id. - /// The unique identifier of the policy. + /// Id of a distribution policy. /// The cancellation token to use. /// is null. /// is an empty string, and was expected to be non-empty. @@ -124,7 +124,7 @@ public virtual async Task> GetDistributionPolicyAsy } /// Retrieves an existing distribution policy by Id. - /// The unique identifier of the policy. + /// Id of a distribution policy. /// The cancellation token to use. /// is null. /// is an empty string, and was expected to be non-empty. @@ -152,7 +152,7 @@ public virtual Response GetDistributionPolicy(string distrib /// /// /// - /// The unique identifier of the policy. + /// Id of a distribution policy. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -191,7 +191,7 @@ public virtual async Task GetDistributionPolicyAsync(string distributi /// /// /// - /// The unique identifier of the policy. + /// Id of a distribution policy. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -226,7 +226,7 @@ public virtual Response GetDistributionPolicy(string distributionPolicyId, Reque /// /// /// - /// The unique identifier of the policy. + /// Id of a distribution policy. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -261,7 +261,7 @@ public virtual async Task DeleteDistributionPolicyAsync(string distrib /// /// /// - /// The unique identifier of the policy. + /// Id of a distribution policy. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -295,7 +295,7 @@ public virtual Response DeleteDistributionPolicy(string distributionPolicyId, Re /// /// /// - /// Unique identifier of this policy. + /// Id of a classification policy. /// The content to send as the body of the request. /// The content to send as the request conditions of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. @@ -335,7 +335,7 @@ internal virtual async Task UpsertClassificationPolicyAsync(string cla /// /// /// - /// Unique identifier of this policy. + /// Id of a classification policy. /// The content to send as the body of the request. /// The content to send as the request conditions of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. @@ -366,7 +366,7 @@ internal virtual Response UpsertClassificationPolicy(string classificationPolicy } /// Retrieves an existing classification policy by Id. - /// Unique identifier of this policy. + /// Id of a classification policy. /// The cancellation token to use. /// is null. /// is an empty string, and was expected to be non-empty. @@ -380,7 +380,7 @@ public virtual async Task> GetClassificationPolic } /// Retrieves an existing classification policy by Id. - /// Unique identifier of this policy. + /// Id of a classification policy. /// The cancellation token to use. /// is null. /// is an empty string, and was expected to be non-empty. @@ -408,7 +408,7 @@ public virtual Response GetClassificationPolicy(string cla /// /// /// - /// Unique identifier of this policy. + /// Id of a classification policy. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -447,7 +447,7 @@ public virtual async Task GetClassificationPolicyAsync(string classifi /// /// /// - /// Unique identifier of this policy. + /// Id of a classification policy. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -482,7 +482,7 @@ public virtual Response GetClassificationPolicy(string classificationPolicyId, R /// /// /// - /// Unique identifier of this policy. + /// Id of a classification policy. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -517,7 +517,7 @@ public virtual async Task DeleteClassificationPolicyAsync(string class /// /// /// - /// Unique identifier of this policy. + /// Id of a classification policy. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -551,7 +551,7 @@ public virtual Response DeleteClassificationPolicy(string classificationPolicyId /// /// /// - /// The Id of the exception policy. + /// Id of an exception policy. /// The content to send as the body of the request. /// The content to send as the request conditions of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. @@ -591,7 +591,7 @@ internal virtual async Task UpsertExceptionPolicyAsync(string exceptio /// /// /// - /// The Id of the exception policy. + /// Id of an exception policy. /// The content to send as the body of the request. /// The content to send as the request conditions of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. @@ -622,7 +622,7 @@ internal virtual Response UpsertExceptionPolicy(string exceptionPolicyId, Reques } /// Retrieves an existing exception policy by Id. - /// The Id of the exception policy. + /// Id of an exception policy. /// The cancellation token to use. /// is null. /// is an empty string, and was expected to be non-empty. @@ -636,7 +636,7 @@ public virtual async Task> GetExceptionPolicyAsync(str } /// Retrieves an existing exception policy by Id. - /// The Id of the exception policy. + /// Id of an exception policy. /// The cancellation token to use. /// is null. /// is an empty string, and was expected to be non-empty. @@ -664,7 +664,7 @@ public virtual Response GetExceptionPolicy(string exceptionPoli /// /// /// - /// The Id of the exception policy. + /// Id of an exception policy. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -703,7 +703,7 @@ public virtual async Task GetExceptionPolicyAsync(string exceptionPoli /// /// /// - /// The Id of the exception policy. + /// Id of an exception policy. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -738,7 +738,7 @@ public virtual Response GetExceptionPolicy(string exceptionPolicyId, RequestCont /// /// /// - /// The Id of the exception policy. + /// Id of an exception policy. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -773,7 +773,7 @@ public virtual async Task DeleteExceptionPolicyAsync(string exceptionP /// /// /// - /// The Id of the exception policy. + /// Id of an exception policy. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -807,7 +807,7 @@ public virtual Response DeleteExceptionPolicy(string exceptionPolicyId, RequestC /// /// /// - /// The Id of this queue. + /// Id of a queue. /// The content to send as the body of the request. /// The content to send as the request conditions of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. @@ -847,7 +847,7 @@ internal virtual async Task UpsertQueueAsync(string queueId, RequestCo /// /// /// - /// The Id of this queue. + /// Id of a queue. /// The content to send as the body of the request. /// The content to send as the request conditions of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. @@ -878,7 +878,7 @@ internal virtual Response UpsertQueue(string queueId, RequestContent content, Re } /// Retrieves an existing queue by Id. - /// The Id of this queue. + /// Id of a queue. /// The cancellation token to use. /// is null. /// is an empty string, and was expected to be non-empty. @@ -892,7 +892,7 @@ public virtual async Task> GetQueueAsync(string queueId, C } /// Retrieves an existing queue by Id. - /// The Id of this queue. + /// Id of a queue. /// The cancellation token to use. /// is null. /// is an empty string, and was expected to be non-empty. @@ -920,7 +920,7 @@ public virtual Response GetQueue(string queueId, CancellationToken /// /// /// - /// The Id of this queue. + /// Id of a queue. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -959,7 +959,7 @@ public virtual async Task GetQueueAsync(string queueId, RequestContext /// /// /// - /// The Id of this queue. + /// Id of a queue. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -994,7 +994,7 @@ public virtual Response GetQueue(string queueId, RequestContext context) /// /// /// - /// The Id of this queue. + /// Id of a queue. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -1029,7 +1029,7 @@ public virtual async Task DeleteQueueAsync(string queueId, RequestCont /// /// /// - /// The Id of this queue. + /// Id of a queue. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobRouterClient.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobRouterClient.cs index 8007157e938d..981bf4969be9 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobRouterClient.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobRouterClient.cs @@ -39,7 +39,7 @@ public partial class JobRouterClient /// /// /// - /// The id of the job. + /// Id of a job. /// The content to send as the body of the request. /// The content to send as the request conditions of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. @@ -79,7 +79,7 @@ internal virtual async Task UpsertJobAsync(string jobId, RequestConten /// /// /// - /// The id of the job. + /// Id of a job. /// The content to send as the body of the request. /// The content to send as the request conditions of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. @@ -110,7 +110,7 @@ internal virtual Response UpsertJob(string jobId, RequestContent content, Reques } /// Retrieves an existing job by Id. - /// The id of the job. + /// Id of a job. /// The cancellation token to use. /// is null. /// is an empty string, and was expected to be non-empty. @@ -124,7 +124,7 @@ public virtual async Task> GetJobAsync(string jobId, Cancell } /// Retrieves an existing job by Id. - /// The id of the job. + /// Id of a job. /// The cancellation token to use. /// is null. /// is an empty string, and was expected to be non-empty. @@ -152,7 +152,7 @@ public virtual Response GetJob(string jobId, CancellationToken cancel /// /// /// - /// The id of the job. + /// Id of a job. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -191,7 +191,7 @@ public virtual async Task GetJobAsync(string jobId, RequestContext con /// /// /// - /// The id of the job. + /// Id of a job. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -226,7 +226,7 @@ public virtual Response GetJob(string jobId, RequestContext context) /// /// /// - /// The id of the job. + /// Id of a job. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -261,7 +261,7 @@ public virtual async Task DeleteJobAsync(string jobId, RequestContext /// /// /// - /// The id of the job. + /// Id of a job. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -286,7 +286,7 @@ public virtual Response DeleteJob(string jobId, RequestContext context = null) } /// Reclassify a job. - /// The id of the job. + /// Id of a job. /// Request object for reclassifying a job. /// The cancellation token to use. /// is null. @@ -302,7 +302,7 @@ internal virtual async Task> ReclassifyJobAsync(st } /// Reclassify a job. - /// The id of the job. + /// Id of a job. /// Request object for reclassifying a job. /// The cancellation token to use. /// is null. @@ -332,7 +332,7 @@ internal virtual Response ReclassifyJob(string jobId, Recla /// /// /// - /// The id of the job. + /// Id of a job. /// The content to send as the body of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. @@ -372,7 +372,7 @@ internal virtual async Task ReclassifyJobAsync(string jobId, RequestCo /// /// /// - /// The id of the job. + /// Id of a job. /// The content to send as the body of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. @@ -398,7 +398,7 @@ internal virtual Response ReclassifyJob(string jobId, RequestContent content, Re } /// Submits request to cancel an existing job by Id while supplying free-form cancellation reason. - /// The id of the job. + /// Id of a job. /// Request model for cancelling job. /// The cancellation token to use. /// is null. @@ -414,7 +414,7 @@ internal virtual async Task> CancelJobAsync(string job } /// Submits request to cancel an existing job by Id while supplying free-form cancellation reason. - /// The id of the job. + /// Id of a job. /// Request model for cancelling job. /// The cancellation token to use. /// is null. @@ -444,7 +444,7 @@ internal virtual Response CancelJob(string jobId, CancelJobOpti /// /// /// - /// The id of the job. + /// Id of a job. /// The content to send as the body of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. @@ -484,7 +484,7 @@ internal virtual async Task CancelJobAsync(string jobId, RequestConten /// /// /// - /// The id of the job. + /// Id of a job. /// The content to send as the body of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. @@ -510,8 +510,8 @@ internal virtual Response CancelJob(string jobId, RequestContent content, Reques } /// Completes an assigned job. - /// The id of the job. - /// The Id of the job assignment. + /// Id of a job. + /// Id of a job assignment. /// Request model for completing job. /// The cancellation token to use. /// or is null. @@ -528,8 +528,8 @@ internal virtual async Task> CompleteJobAsync(string } /// Completes an assigned job. - /// The id of the job. - /// The Id of the job assignment. + /// Id of a job. + /// Id of a job assignment. /// Request model for completing job. /// The cancellation token to use. /// or is null. @@ -560,8 +560,8 @@ internal virtual Response CompleteJob(string jobId, string as /// /// /// - /// The id of the job. - /// The Id of the job assignment. + /// Id of a job. + /// Id of a job assignment. /// The content to send as the body of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// or is null. @@ -602,8 +602,8 @@ internal virtual async Task CompleteJobAsync(string jobId, string assi /// /// /// - /// The id of the job. - /// The Id of the job assignment. + /// Id of a job. + /// Id of a job assignment. /// The content to send as the body of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// or is null. @@ -630,8 +630,8 @@ internal virtual Response CompleteJob(string jobId, string assignmentId, Request } /// Closes a completed job. - /// The id of the job. - /// The Id of the job assignment. + /// Id of a job. + /// Id of a job assignment. /// Request model for closing job. /// The cancellation token to use. /// or is null. @@ -648,8 +648,8 @@ internal virtual async Task> CloseJobAsync(string jobId } /// Closes a completed job. - /// The id of the job. - /// The Id of the job assignment. + /// Id of a job. + /// Id of a job assignment. /// Request model for closing job. /// The cancellation token to use. /// or is null. @@ -680,8 +680,8 @@ internal virtual Response CloseJob(string jobId, string assignme /// /// /// - /// The id of the job. - /// The Id of the job assignment. + /// Id of a job. + /// Id of a job assignment. /// The content to send as the body of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// or is null. @@ -722,8 +722,8 @@ internal virtual async Task CloseJobAsync(string jobId, string assignm /// /// /// - /// The id of the job. - /// The Id of the job assignment. + /// Id of a job. + /// Id of a job assignment. /// The content to send as the body of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// or is null. @@ -855,9 +855,9 @@ public virtual Response GetQueuePosition(string jobId, RequestContext context) } } - /// Un-assign a job. - /// The id of the job. - /// The Id of the job assignment. + /// Unassign a job. + /// Id of a job. + /// Id of a job assignment. /// Request body for unassign route. /// The cancellation token to use. /// or is null. @@ -873,9 +873,9 @@ internal virtual async Task> UnassignJobAsync(string return Response.FromValue(UnassignJobResult.FromResponse(response), response); } - /// Un-assign a job. - /// The id of the job. - /// The Id of the job assignment. + /// Unassign a job. + /// Id of a job. + /// Id of a job assignment. /// Request body for unassign route. /// The cancellation token to use. /// or is null. @@ -892,7 +892,7 @@ internal virtual Response UnassignJob(string jobId, string as } /// - /// [Protocol Method] Un-assign a job. + /// [Protocol Method] Unassign a job. /// /// /// @@ -906,8 +906,8 @@ internal virtual Response UnassignJob(string jobId, string as /// /// /// - /// The id of the job. - /// The Id of the job assignment. + /// Id of a job. + /// Id of a job assignment. /// The content to send as the body of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// or is null. @@ -934,7 +934,7 @@ internal virtual async Task UnassignJobAsync(string jobId, string assi } /// - /// [Protocol Method] Un-assign a job. + /// [Protocol Method] Unassign a job. /// /// /// @@ -948,8 +948,8 @@ internal virtual async Task UnassignJobAsync(string jobId, string assi /// /// /// - /// The id of the job. - /// The Id of the job assignment. + /// Id of a job. + /// Id of a job assignment. /// The content to send as the body of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// or is null. @@ -976,8 +976,8 @@ internal virtual Response UnassignJob(string jobId, string assignmentId, Request } /// Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already. - /// Id of the worker. - /// The Id of the offer. + /// Id of a worker. + /// Id of an offer. /// The cancellation token to use. /// or is null. /// or is an empty string, and was expected to be non-empty. @@ -992,8 +992,8 @@ public virtual async Task> AcceptJobOfferAsync(st } /// Accepts an offer to work on a job and returns a 409/Conflict if another agent accepted the job already. - /// Id of the worker. - /// The Id of the offer. + /// Id of a worker. + /// Id of an offer. /// The cancellation token to use. /// or is null. /// or is an empty string, and was expected to be non-empty. @@ -1022,8 +1022,8 @@ public virtual Response AcceptJobOffer(string workerId, st /// /// /// - /// Id of the worker. - /// The Id of the offer. + /// Id of a worker. + /// Id of an offer. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// or is null. /// or is an empty string, and was expected to be non-empty. @@ -1063,8 +1063,8 @@ public virtual async Task AcceptJobOfferAsync(string workerId, string /// /// /// - /// Id of the worker. - /// The Id of the offer. + /// Id of a worker. + /// Id of an offer. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// or is null. /// or is an empty string, and was expected to be non-empty. @@ -1090,8 +1090,8 @@ public virtual Response AcceptJobOffer(string workerId, string offerId, RequestC } /// Declines an offer to work on a job. - /// Id of the worker. - /// The Id of the offer. + /// Id of a worker. + /// Id of an offer. /// Request model for declining offer. /// The cancellation token to use. /// or is null. @@ -1108,8 +1108,8 @@ internal virtual async Task> DeclineJobOfferAsyn } /// Declines an offer to work on a job. - /// Id of the worker. - /// The Id of the offer. + /// Id of a worker. + /// Id of an offer. /// Request model for declining offer. /// The cancellation token to use. /// or is null. @@ -1140,8 +1140,8 @@ internal virtual Response DeclineJobOffer(string workerId /// /// /// - /// Id of the worker. - /// The Id of the offer. + /// Id of a worker. + /// Id of an offer. /// The content to send as the body of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// or is null. @@ -1182,8 +1182,8 @@ internal virtual async Task DeclineJobOfferAsync(string workerId, stri /// /// /// - /// Id of the worker. - /// The Id of the offer. + /// Id of a worker. + /// Id of an offer. /// The content to send as the body of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// or is null. @@ -1325,7 +1325,7 @@ public virtual Response GetQueueStatistics(string queueId, RequestContext contex /// /// /// - /// Id of the worker. + /// Id of a worker. /// The content to send as the body of the request. /// The content to send as the request conditions of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. @@ -1365,7 +1365,7 @@ internal virtual async Task UpsertWorkerAsync(string workerId, Request /// /// /// - /// Id of the worker. + /// Id of a worker. /// The content to send as the body of the request. /// The content to send as the request conditions of the request. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. @@ -1396,7 +1396,7 @@ internal virtual Response UpsertWorker(string workerId, RequestContent content, } /// Retrieves an existing worker by Id. - /// Id of the worker. + /// Id of a worker. /// The cancellation token to use. /// is null. /// is an empty string, and was expected to be non-empty. @@ -1410,7 +1410,7 @@ public virtual async Task> GetWorkerAsync(string workerId } /// Retrieves an existing worker by Id. - /// Id of the worker. + /// Id of a worker. /// The cancellation token to use. /// is null. /// is an empty string, and was expected to be non-empty. @@ -1438,7 +1438,7 @@ public virtual Response GetWorker(string workerId, CancellationTok /// /// /// - /// Id of the worker. + /// Id of a worker. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -1477,7 +1477,7 @@ public virtual async Task GetWorkerAsync(string workerId, RequestConte /// /// /// - /// Id of the worker. + /// Id of a worker. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -1512,7 +1512,7 @@ public virtual Response GetWorker(string workerId, RequestContext context) /// /// /// - /// Id of the worker. + /// Id of a worker. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. @@ -1547,7 +1547,7 @@ public virtual async Task DeleteWorkerAsync(string workerId, RequestCo /// /// /// - /// Id of the worker. + /// Id of a worker. /// The request context, which can override default behaviors of the client pipeline on a per-call basis. /// is null. /// is an empty string, and was expected to be non-empty. diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobRouterModelFactory.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobRouterModelFactory.cs index 4006021a67eb..a680d435e68f 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobRouterModelFactory.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/JobRouterModelFactory.cs @@ -16,7 +16,7 @@ public static partial class JobRouterModelFactory { /// Initializes a new instance of ExpressionRouterRule. /// The expression language to compile to and execute. - /// The string containing the expression to evaluate. Should contain return statement with calculated values. + /// An expression to evaluate. Should contain return statement with calculated values. /// A new instance for mocking. public static ExpressionRouterRule ExpressionRouterRule(string language = null, string expression = null) { @@ -148,7 +148,7 @@ public static WorkerWeightedAllocation WorkerWeightedAllocation(double weight = } /// Initializes a new instance of ExceptionRule. - /// Id of the exception rule. + /// Id of an exception rule. /// The trigger for this exception rule. /// A collection of actions to perform once the exception is triggered. /// A new instance for mocking. @@ -178,8 +178,8 @@ public static ExceptionAction ExceptionAction(string id = null, string kind = "U /// Initializes a new instance of CancelExceptionAction. /// Unique Id of the exception action. - /// A note that will be appended to the jobs' Notes collection with the current timestamp. - /// Indicates the outcome of the job, populate this field with your own custom values. + /// A note that will be appended to a job's notes collection with the current timestamp. + /// Indicates the outcome of a job, populate this field with your own custom values. /// A new instance for mocking. public static CancelExceptionAction CancelExceptionAction(string id = null, string note = null, string dispositionCode = null) { @@ -200,11 +200,11 @@ public static ManualReclassifyExceptionAction ManualReclassifyExceptionAction(st } /// Initializes a new instance of RouterJobAssignment. - /// The Id of the job assignment. - /// The Id of the Worker assigned to the job. - /// The assignment time of the job in UTC. - /// The time the job was marked as completed after being assigned in UTC. - /// The time the job was marked as closed after being completed in UTC. + /// Id of a job assignment. + /// Id of the Worker assigned to the job. + /// Timestamp when the job was assigned to a worker in UTC. + /// Timestamp when the job was marked as completed after being assigned in UTC. + /// Timestamp when the job was marked as closed after being completed in UTC. /// A new instance for mocking. public static RouterJobAssignment RouterJobAssignment(string assignmentId = null, string workerId = null, DateTimeOffset assignedAt = default, DateTimeOffset? completedAt = null, DateTimeOffset? closedAt = null) { @@ -221,7 +221,7 @@ public static RouterJobNote RouterJobNote(string message = null, DateTimeOffset? } /// Initializes a new instance of ScheduleAndSuspendMode. - /// Scheduled time. + /// Requested schedule time. /// A new instance for mocking. public static ScheduleAndSuspendMode ScheduleAndSuspendMode(DateTimeOffset scheduleAt = default) { @@ -229,7 +229,7 @@ public static ScheduleAndSuspendMode ScheduleAndSuspendMode(DateTimeOffset sched } /// Initializes a new instance of UnassignJobResult. - /// The Id of the job unassigned. + /// Id of an unassigned job. /// The number of times a job is unassigned. At a maximum 3. /// is null. /// A new instance for mocking. @@ -244,9 +244,9 @@ public static UnassignJobResult UnassignJobResult(string jobId = null, int unass } /// Initializes a new instance of AcceptJobOfferResult. - /// The assignment Id that assigns a worker that has accepted an offer to a job. - /// The Id of the job assigned. - /// The Id of the worker that has been assigned this job. + /// Id of job assignment that assigns a worker that has accepted an offer to a job. + /// Id of the job assigned. + /// Id of the worker that has been assigned this job. /// , or is null. /// A new instance for mocking. public static AcceptJobOfferResult AcceptJobOfferResult(string assignmentId = null, string jobId = null, string workerId = null) @@ -268,7 +268,7 @@ public static AcceptJobOfferResult AcceptJobOfferResult(string assignmentId = nu } /// Initializes a new instance of RouterChannel. - /// Id of the channel. + /// Id of a channel. /// The amount of capacity that an instance of a job of this channel will consume of the total worker capacity. /// The maximum number of jobs that can be supported concurrently for this channel. /// A new instance for mocking. @@ -278,11 +278,11 @@ public static RouterChannel RouterChannel(string channelId = null, int capacityC } /// Initializes a new instance of RouterJobOffer. - /// The Id of the offer. - /// The Id of the job. + /// Id of an offer. + /// Id of the job. /// The capacity cost consumed by the job offer. - /// The time the offer was created in UTC. - /// The time that the offer will expire in UTC. + /// Timestamp when the offer was created in UTC. + /// Timestamp when the offer will expire in UTC. /// A new instance for mocking. public static RouterJobOffer RouterJobOffer(string offerId = null, string jobId = null, int capacityCost = default, DateTimeOffset? offeredAt = null, DateTimeOffset? expiresAt = null) { @@ -290,8 +290,8 @@ public static RouterJobOffer RouterJobOffer(string offerId = null, string jobId } /// Initializes a new instance of RouterWorkerAssignment. - /// The Id of the assignment. - /// The Id of the Job assigned. + /// Id of the assignment. + /// Id of the job assigned. /// The amount of capacity this assignment has consumed on the worker. /// The assignment time of the job in UTC. /// or is null. diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/LongestIdleMode.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/LongestIdleMode.cs index 1b3a6e4eac65..3c7a1402ad51 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/LongestIdleMode.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/LongestIdleMode.cs @@ -13,7 +13,7 @@ public partial class LongestIdleMode : DistributionMode /// Initializes a new instance of LongestIdleMode. /// Governs the minimum desired number of active concurrent offers a job can have. /// Governs the maximum number of active concurrent offers a job can have. - /// If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for the job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false. + /// If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for a job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false. /// The type discriminator describing a sub-type of DistributionMode. internal LongestIdleMode(int minConcurrentOffers, int maxConcurrentOffers, bool? bypassSelectors, DistributionModeKind kind) : base(minConcurrentOffers, maxConcurrentOffers, bypassSelectors, kind) { diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/PassThroughQueueSelectorAttachment.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/PassThroughQueueSelectorAttachment.cs index db278469c38b..a5ced7bcad85 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/PassThroughQueueSelectorAttachment.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/PassThroughQueueSelectorAttachment.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Attaches a queue selector where the value is passed through from the job label with the same key. + /// Attaches a queue selector where the value is passed through from a job's label with the same key. public partial class PassThroughQueueSelectorAttachment : QueueSelectorAttachment { /// Initializes a new instance of PassThroughQueueSelectorAttachment. diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/PassThroughWorkerSelectorAttachment.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/PassThroughWorkerSelectorAttachment.cs index e0dba7216520..f1f62273641f 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/PassThroughWorkerSelectorAttachment.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/PassThroughWorkerSelectorAttachment.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Attaches a worker selector where the value is passed through from the job label with the same key. + /// Attaches a worker selector where the value is passed through from a job's label with the same key. public partial class PassThroughWorkerSelectorAttachment : WorkerSelectorAttachment { /// Initializes a new instance of PassThroughWorkerSelectorAttachment. diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/QueueSelectorAttachment.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/QueueSelectorAttachment.cs index 2a9c8b3102eb..c9a39cc16b35 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/QueueSelectorAttachment.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/QueueSelectorAttachment.cs @@ -8,7 +8,7 @@ namespace Azure.Communication.JobRouter { /// - /// An attachment of queue selectors to resolve a queue to a job from a classification policy + /// An attachment of queue selectors to resolve a queue to a job from a classification policy. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include , , , and . /// diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/QueueSelectorAttachmentKind.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/QueueSelectorAttachmentKind.cs index 661fd70b2253..bfa0afe2557d 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/QueueSelectorAttachmentKind.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/QueueSelectorAttachmentKind.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Supported queue selector attachment types. + /// Discriminators for supported queue selector attachment types. public readonly partial struct QueueSelectorAttachmentKind : IEquatable { private readonly string _value; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RoundRobinMode.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RoundRobinMode.cs index 7e901d1eae60..c48fe548238d 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RoundRobinMode.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RoundRobinMode.cs @@ -13,7 +13,7 @@ public partial class RoundRobinMode : DistributionMode /// Initializes a new instance of RoundRobinMode. /// Governs the minimum desired number of active concurrent offers a job can have. /// Governs the maximum number of active concurrent offers a job can have. - /// If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for the job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false. + /// If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for a job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false. /// The type discriminator describing a sub-type of DistributionMode. internal RoundRobinMode(int minConcurrentOffers, int maxConcurrentOffers, bool? bypassSelectors, DistributionModeKind kind) : base(minConcurrentOffers, maxConcurrentOffers, bypassSelectors, kind) { diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterChannel.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterChannel.cs index 49cb981c8b8f..e623d8584997 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterChannel.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterChannel.cs @@ -14,7 +14,7 @@ namespace Azure.Communication.JobRouter public partial class RouterChannel { /// Initializes a new instance of RouterChannel. - /// Id of the channel. + /// Id of a channel. /// The amount of capacity that an instance of a job of this channel will consume of the total worker capacity. /// The maximum number of jobs that can be supported concurrently for this channel. internal RouterChannel(string channelId, int capacityCostPerJob, int? maxNumberOfJobs) @@ -24,7 +24,7 @@ internal RouterChannel(string channelId, int capacityCostPerJob, int? maxNumberO MaxNumberOfJobs = maxNumberOfJobs; } - /// Id of the channel. + /// Id of a channel. public string ChannelId { get; } /// The amount of capacity that an instance of a job of this channel will consume of the total worker capacity. public int CapacityCostPerJob { get; } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJob.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJob.cs index ebd430105968..9bd415a77941 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJob.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJob.cs @@ -27,17 +27,17 @@ internal RouterJob() /// Initializes a new instance of RouterJob. /// The entity tag for this resource. - /// The id of the job. + /// Id of a job. /// Reference to an external parent context, eg. call ID. - /// The status of the Job. - /// The time a job was queued in UTC. + /// The status of the job. + /// Timestamp a job was queued in UTC. /// The channel identifier. eg. voice, chat, etc. - /// The Id of the Classification policy used for classifying a job. - /// The Id of the Queue that this job is queued to. - /// The priority of this job. + /// Id of a classification policy used for classifying this job. + /// Id of a queue that this job is queued to. + /// Priority of this job. /// Reason code for cancelled or closed jobs. - /// A collection of manually specified label selectors, which a worker must satisfy in order to process this job. - /// A collection of label selectors attached by a classification policy, which a worker must satisfy in order to process this job. + /// A collection of manually specified worker selectors, which a worker must satisfy in order to process this job. + /// A collection of worker selectors attached by a classification policy, which a worker must satisfy in order to process this job. /// A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean. /// A collection of the assignments of the job. Key is AssignmentId. /// A set of non-identifying attributes attached to this job. Values must be primitive values - number, string, boolean. @@ -65,13 +65,13 @@ internal RouterJob(string etag, string id, string channelReference, RouterJobSta ScheduledAt = scheduledAt; MatchingMode = matchingMode; } - /// The id of the job. + /// Id of a job. public string Id { get; } - /// The status of the Job. + /// The status of the job. public RouterJobStatus? Status { get; } - /// The time a job was queued in UTC. + /// Timestamp a job was queued in UTC. public DateTimeOffset? EnqueuedAt { get; } - /// A collection of label selectors attached by a classification policy, which a worker must satisfy in order to process this job. + /// A collection of worker selectors attached by a classification policy, which a worker must satisfy in order to process this job. public IReadOnlyList AttachedWorkerSelectors { get; } /// A collection of the assignments of the job. Key is AssignmentId. public IReadOnlyDictionary Assignments { get; } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobAssignment.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobAssignment.cs index 0b75bd74a298..d93fcd8d281f 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobAssignment.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobAssignment.cs @@ -13,18 +13,18 @@ namespace Azure.Communication.JobRouter public partial class RouterJobAssignment { /// Initializes a new instance of RouterJobAssignment. - /// The assignment time of the job in UTC. + /// Timestamp when the job was assigned to a worker in UTC. internal RouterJobAssignment(DateTimeOffset assignedAt) { AssignedAt = assignedAt; } /// Initializes a new instance of RouterJobAssignment. - /// The Id of the job assignment. - /// The Id of the Worker assigned to the job. - /// The assignment time of the job in UTC. - /// The time the job was marked as completed after being assigned in UTC. - /// The time the job was marked as closed after being completed in UTC. + /// Id of a job assignment. + /// Id of the Worker assigned to the job. + /// Timestamp when the job was assigned to a worker in UTC. + /// Timestamp when the job was marked as completed after being assigned in UTC. + /// Timestamp when the job was marked as closed after being completed in UTC. internal RouterJobAssignment(string assignmentId, string workerId, DateTimeOffset assignedAt, DateTimeOffset? completedAt, DateTimeOffset? closedAt) { AssignmentId = assignmentId; @@ -34,15 +34,15 @@ internal RouterJobAssignment(string assignmentId, string workerId, DateTimeOffse ClosedAt = closedAt; } - /// The Id of the job assignment. + /// Id of a job assignment. public string AssignmentId { get; } - /// The Id of the Worker assigned to the job. + /// Id of the Worker assigned to the job. public string WorkerId { get; } - /// The assignment time of the job in UTC. + /// Timestamp when the job was assigned to a worker in UTC. public DateTimeOffset AssignedAt { get; } - /// The time the job was marked as completed after being assigned in UTC. + /// Timestamp when the job was marked as completed after being assigned in UTC. public DateTimeOffset? CompletedAt { get; } - /// The time the job was marked as closed after being completed in UTC. + /// Timestamp when the job was marked as closed after being completed in UTC. public DateTimeOffset? ClosedAt { get; } } } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobOffer.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobOffer.cs index 74766d972573..acf58c8f6cba 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobOffer.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobOffer.cs @@ -14,7 +14,7 @@ namespace Azure.Communication.JobRouter public partial class RouterJobOffer { /// Initializes a new instance of RouterJobOffer. - /// The Id of the job. + /// Id of the job. /// The capacity cost consumed by the job offer. /// is null. internal RouterJobOffer(string jobId, int capacityCost) @@ -26,11 +26,11 @@ internal RouterJobOffer(string jobId, int capacityCost) } /// Initializes a new instance of RouterJobOffer. - /// The Id of the offer. - /// The Id of the job. + /// Id of an offer. + /// Id of the job. /// The capacity cost consumed by the job offer. - /// The time the offer was created in UTC. - /// The time that the offer will expire in UTC. + /// Timestamp when the offer was created in UTC. + /// Timestamp when the offer will expire in UTC. internal RouterJobOffer(string offerId, string jobId, int capacityCost, DateTimeOffset? offeredAt, DateTimeOffset? expiresAt) { OfferId = offerId; @@ -40,15 +40,15 @@ internal RouterJobOffer(string offerId, string jobId, int capacityCost, DateTime ExpiresAt = expiresAt; } - /// The Id of the offer. + /// Id of an offer. public string OfferId { get; } - /// The Id of the job. + /// Id of the job. public string JobId { get; } /// The capacity cost consumed by the job offer. public int CapacityCost { get; } - /// The time the offer was created in UTC. + /// Timestamp when the offer was created in UTC. public DateTimeOffset? OfferedAt { get; } - /// The time that the offer will expire in UTC. + /// Timestamp when the offer will expire in UTC. public DateTimeOffset? ExpiresAt { get; } } } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobStatus.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobStatus.cs index db941c41ac46..274ab4094641 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobStatus.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobStatus.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// The status of the Job. + /// Describes the various status of a job. public readonly partial struct RouterJobStatus : IEquatable { private readonly string _value; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobStatusSelector.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobStatusSelector.cs index e154c07929bf..9c027cfca928 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobStatusSelector.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterJobStatusSelector.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Enums used to filters jobs by state. + /// Enums used to filters jobs by status. public readonly partial struct RouterJobStatusSelector : IEquatable { private readonly string _value; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterQueue.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterQueue.cs index 597fbb150fcb..767692dca64d 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterQueue.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterQueue.cs @@ -15,11 +15,11 @@ public partial class RouterQueue { /// Initializes a new instance of RouterQueue. /// The entity tag for this resource. - /// The Id of this queue. - /// The name of this queue. - /// The ID of the distribution policy that will determine how a job is distributed to workers. + /// Id of a queue. + /// Friendly name of this queue. + /// Id of a distribution policy that will determine how a job is distributed to workers. /// A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean. - /// The ID of the exception policy that determines various job escalation rules. + /// Id of an exception policy that determines various job escalation rules. internal RouterQueue(string etag, string id, string name, string distributionPolicyId, IDictionary labels, string exceptionPolicyId) { _etag = etag; @@ -29,7 +29,7 @@ internal RouterQueue(string etag, string id, string name, string distributionPol _labels = labels; ExceptionPolicyId = exceptionPolicyId; } - /// The Id of this queue. + /// Id of a queue. public string Id { get; } } } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterRuleKind.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterRuleKind.cs index 86d52e17249e..e1c55ae696df 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterRuleKind.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterRuleKind.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Supported router rule types. + /// Discriminators for supported router rule types. public readonly partial struct RouterRuleKind : IEquatable { private readonly string _value; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorker.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorker.cs index 3b31829dcce6..f5bf523716ad 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorker.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorker.cs @@ -27,13 +27,13 @@ internal RouterWorker() /// Initializes a new instance of RouterWorker. /// The entity tag for this resource. - /// Id of the worker. - /// The current state of the worker. - /// The queue(s) that this worker can receive work from. + /// Id of a worker. + /// Current state of a worker. + /// Collection of queue(s) that this worker can receive work from. /// The total capacity score this worker has to manage multiple concurrent jobs. /// A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean. /// A set of non-identifying attributes attached to this worker. Values must be primitive values - number, string, boolean. - /// The channel(s) this worker can handle and their impact on the workers capacity. + /// Collection of channel(s) this worker can handle and their impact on the workers capacity. /// A list of active offers issued to this worker. /// A list of assigned jobs attached to this worker. /// A value indicating the workers capacity. A value of '1' means all capacity is consumed. A value of '0' means no capacity is currently consumed. @@ -53,9 +53,9 @@ internal RouterWorker(string etag, string id, RouterWorkerState? state, IList Id of the worker. + /// Id of a worker. public string Id { get; } - /// The current state of the worker. + /// Current state of a worker. public RouterWorkerState? State { get; } /// A list of active offers issued to this worker. public IReadOnlyList Offers { get; } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerAssignment.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerAssignment.cs index ed77ff0b75f7..013c28f1b54e 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerAssignment.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerAssignment.cs @@ -14,8 +14,8 @@ namespace Azure.Communication.JobRouter public partial class RouterWorkerAssignment { /// Initializes a new instance of RouterWorkerAssignment. - /// The Id of the assignment. - /// The Id of the Job assigned. + /// Id of the assignment. + /// Id of the job assigned. /// The amount of capacity this assignment has consumed on the worker. /// The assignment time of the job in UTC. /// or is null. @@ -30,9 +30,9 @@ internal RouterWorkerAssignment(string assignmentId, string jobId, int capacityC AssignedAt = assignedAt; } - /// The Id of the assignment. + /// Id of the assignment. public string AssignmentId { get; } - /// The Id of the Job assigned. + /// Id of the job assigned. public string JobId { get; } /// The amount of capacity this assignment has consumed on the worker. public int CapacityCost { get; } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerSelector.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerSelector.cs index 4fb16d9ac788..c5420ef37a6f 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerSelector.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerSelector.cs @@ -15,7 +15,7 @@ public partial class RouterWorkerSelector { /// Initializes a new instance of RouterWorkerSelector. /// The label key to query against. - /// Describes how the value of the label is compared to the value defined on the label selector. + /// Describes how the value of the label is compared to the value defined on the worker selector. /// is null. internal RouterWorkerSelector(string key, LabelOperator labelOperator) { @@ -27,11 +27,11 @@ internal RouterWorkerSelector(string key, LabelOperator labelOperator) /// Initializes a new instance of RouterWorkerSelector. /// The label key to query against. - /// Describes how the value of the label is compared to the value defined on the label selector. + /// Describes how the value of the label is compared to the value defined on the worker selector. /// The value to compare against the actual label value with the given operator. Values must be primitive values - number, string, boolean. /// Describes how long this label selector is valid in seconds. - /// Pushes the job to the front of the queue as long as this selector is active. - /// The status of the worker selector. + /// Pushes a job to the front of the queue as long as this selector is active. + /// Status of the worker selector. /// The time at which this worker selector expires in UTC. internal RouterWorkerSelector(string key, LabelOperator labelOperator, BinaryData value, double? expiresAfterSeconds, bool? expedite, RouterWorkerSelectorStatus? status, DateTimeOffset? expiresAt) { @@ -46,9 +46,9 @@ internal RouterWorkerSelector(string key, LabelOperator labelOperator, BinaryDat /// The label key to query against. public string Key { get; } - /// Describes how the value of the label is compared to the value defined on the label selector. + /// Describes how the value of the label is compared to the value defined on the worker selector. public LabelOperator LabelOperator { get; } - /// The status of the worker selector. + /// Status of the worker selector. public RouterWorkerSelectorStatus? Status { get; } /// The time at which this worker selector expires in UTC. public DateTimeOffset? ExpiresAt { get; } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerSelectorStatus.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerSelectorStatus.cs index 4f8b793e1c3a..339d37dd1cdb 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerSelectorStatus.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerSelectorStatus.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// The status of the worker selector. + /// Describes the status of a worker selector. public readonly partial struct RouterWorkerSelectorStatus : IEquatable { private readonly string _value; @@ -25,9 +25,9 @@ public RouterWorkerSelectorStatus(string value) private const string ActiveValue = "active"; private const string ExpiredValue = "expired"; - /// Active. + /// Worker selector is valid. public static RouterWorkerSelectorStatus Active { get; } = new RouterWorkerSelectorStatus(ActiveValue); - /// Expired. + /// Worker selector is not valid. public static RouterWorkerSelectorStatus Expired { get; } = new RouterWorkerSelectorStatus(ExpiredValue); /// Determines if two values are the same. public static bool operator ==(RouterWorkerSelectorStatus left, RouterWorkerSelectorStatus right) => left.Equals(right); diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerState.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerState.cs index 35b83c044214..f7a846862aa5 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerState.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RouterWorkerState.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Enums for worker status. + /// Enums for worker states. public readonly partial struct RouterWorkerState : IEquatable { private readonly string _value; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RuleEngineQueueSelectorAttachment.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RuleEngineQueueSelectorAttachment.cs index 4deb5c0327b4..71eb34b32006 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RuleEngineQueueSelectorAttachment.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RuleEngineQueueSelectorAttachment.cs @@ -22,7 +22,7 @@ internal RuleEngineQueueSelectorAttachment(QueueSelectorAttachmentKind kind, Rou } /// - /// A RouterRule that resolves a collection of queue selectors to attach + /// A RouterRule that resolves a collection of queue selectors to attach. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include , , , and . /// diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RuleEngineWorkerSelectorAttachment.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RuleEngineWorkerSelectorAttachment.cs index 2a3e368310ea..973984694b0d 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/RuleEngineWorkerSelectorAttachment.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/RuleEngineWorkerSelectorAttachment.cs @@ -22,7 +22,7 @@ internal RuleEngineWorkerSelectorAttachment(WorkerSelectorAttachmentKind kind, R } /// - /// A RouterRule that resolves a collection of worker selectors to attach + /// A RouterRule that resolves a collection of worker selectors to attach. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include , , , and . /// diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ScheduleAndSuspendMode.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ScheduleAndSuspendMode.cs index 9ca18a640765..0a5e28e18c11 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ScheduleAndSuspendMode.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ScheduleAndSuspendMode.cs @@ -14,13 +14,13 @@ public partial class ScheduleAndSuspendMode : JobMatchingMode { /// Initializes a new instance of ScheduleAndSuspendMode. /// The type discriminator describing a sub-type of JobMatchingMode. - /// Scheduled time. + /// Requested schedule time. internal ScheduleAndSuspendMode(JobMatchingModeKind kind, DateTimeOffset scheduleAt) : base(kind) { ScheduleAt = scheduleAt; } - /// Scheduled time. + /// Requested schedule time. public DateTimeOffset ScheduleAt { get; } } } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ScoringRuleOptions.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ScoringRuleOptions.cs index 40e52fe4a71b..7394cc83f276 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ScoringRuleOptions.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ScoringRuleOptions.cs @@ -21,7 +21,7 @@ internal ScoringRuleOptions() /// Initializes a new instance of ScoringRuleOptions. /// Set batch size when 'isBatchScoringEnabled' is set to true. Defaults to 20 if not configured. - /// List of extra parameters from the job that will be sent as part of the payload to scoring rule. If not set, the job's labels (sent in the payload as `job`) and the job's worker selectors (sent in the payload as `selectors`) are added to the payload of the scoring rule by default. Note: Worker labels are always sent with scoring payload. + /// List of extra parameters from a job that will be sent as part of the payload to scoring rule. If not set, a job's labels (sent in the payload as `job`) and a job's worker selectors (sent in the payload as `selectors`) are added to the payload of the scoring rule by default. Note: Worker labels are always sent with scoring payload. /// If set to true, will score workers in batches, and the parameter name of the worker labels will be sent as `workers`. By default, set to false and the parameter name for the worker labels will be sent as `worker`. Note: If enabled, use 'batchSize' to set batch size. /// If false, will sort scores by ascending order. By default, set to true. internal ScoringRuleOptions(int? batchSize, IList scoringParameters, bool? isBatchScoringEnabled, bool? descendingOrder) diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ScoringRuleParameterSelector.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ScoringRuleParameterSelector.cs index 892d4c801296..adea4d7cb628 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/ScoringRuleParameterSelector.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/ScoringRuleParameterSelector.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Supported parameters for scoring workers. + /// Supported parameters for scoring workers used with BestWorkerMode. public readonly partial struct ScoringRuleParameterSelector : IEquatable { private readonly string _value; @@ -27,7 +27,7 @@ public ScoringRuleParameterSelector(string value) /// Parameter to add job labels to scoring payload. Property is sent as `job`. public static ScoringRuleParameterSelector JobLabels { get; } = new ScoringRuleParameterSelector(JobLabelsValue); - /// Parameter to add worker selectors from the job to scoring payload. Property is sent as `selectors`. + /// Parameter to add worker selectors from a job to scoring payload. Property is sent as `selectors`. public static ScoringRuleParameterSelector WorkerSelectors { get; } = new ScoringRuleParameterSelector(WorkerSelectorsValue); /// Determines if two values are the same. public static bool operator ==(ScoringRuleParameterSelector left, ScoringRuleParameterSelector right) => left.Equals(right); diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/StaticQueueSelectorAttachment.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/StaticQueueSelectorAttachment.cs index ebb32b27eac5..ee6c6defbd31 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/StaticQueueSelectorAttachment.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/StaticQueueSelectorAttachment.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Describes a queue selector that will be attached to the job. + /// Describes a queue selector that will be attached to a job. public partial class StaticQueueSelectorAttachment : QueueSelectorAttachment { /// Initializes a new instance of StaticQueueSelectorAttachment. diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/StaticWorkerSelectorAttachment.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/StaticWorkerSelectorAttachment.cs index 740580360dd3..3e223d4509da 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/StaticWorkerSelectorAttachment.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/StaticWorkerSelectorAttachment.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Describes a worker selector that will be attached to the job. + /// Describes a worker selector that will be attached to a job. public partial class StaticWorkerSelectorAttachment : WorkerSelectorAttachment { /// Initializes a new instance of StaticWorkerSelectorAttachment. diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/UnassignJobOptions.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/UnassignJobOptions.cs index a921595b9a2a..503a347e8673 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/UnassignJobOptions.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/UnassignJobOptions.cs @@ -11,7 +11,7 @@ namespace Azure.Communication.JobRouter public partial class UnassignJobOptions { /// Initializes a new instance of UnassignJobOptions. - /// If SuspendMatching is true, then the job is not queued for re-matching with a worker. + /// If SuspendMatching is true, then a job is not queued for re-matching with a worker. internal UnassignJobOptions(bool? suspendMatching) { SuspendMatching = suspendMatching; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/UnassignJobResult.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/UnassignJobResult.cs index aec541824a5c..f55f93565bc9 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/UnassignJobResult.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/UnassignJobResult.cs @@ -14,7 +14,7 @@ namespace Azure.Communication.JobRouter public partial class UnassignJobResult { /// Initializes a new instance of UnassignJobResult. - /// The Id of the job unassigned. + /// Id of an unassigned job. /// The number of times a job is unassigned. At a maximum 3. /// is null. internal UnassignJobResult(string jobId, int unassignmentCount) @@ -25,7 +25,7 @@ internal UnassignJobResult(string jobId, int unassignmentCount) UnassignmentCount = unassignmentCount; } - /// The Id of the job unassigned. + /// Id of an unassigned job. public string JobId { get; } /// The number of times a job is unassigned. At a maximum 3. public int UnassignmentCount { get; } diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/UnknownDistributionMode.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/UnknownDistributionMode.cs index 80b2f22783e6..b5211ec4180f 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/UnknownDistributionMode.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/UnknownDistributionMode.cs @@ -18,7 +18,7 @@ internal UnknownDistributionMode() /// Initializes a new instance of UnknownDistributionMode. /// Governs the minimum desired number of active concurrent offers a job can have. /// Governs the maximum number of active concurrent offers a job can have. - /// If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for the job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false. + /// If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for a job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false. /// The type discriminator describing a sub-type of DistributionMode. internal UnknownDistributionMode(int minConcurrentOffers, int maxConcurrentOffers, bool? bypassSelectors, DistributionModeKind kind) : base(minConcurrentOffers, maxConcurrentOffers, bypassSelectors, kind) { diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/WorkerSelectorAttachment.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/WorkerSelectorAttachment.cs index 641deb62e47f..754fe6451e0d 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/WorkerSelectorAttachment.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/WorkerSelectorAttachment.cs @@ -8,7 +8,7 @@ namespace Azure.Communication.JobRouter { /// - /// An attachment which attaches worker selectors to a job + /// An attachment which attaches worker selectors to a job. /// Please note is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. /// The available derived classes include , , , and . /// diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/WorkerSelectorAttachmentKind.cs b/sdk/communication/Azure.Communication.JobRouter/src/Generated/WorkerSelectorAttachmentKind.cs index 921bcf6b3f29..f31416f9934a 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/WorkerSelectorAttachmentKind.cs +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/WorkerSelectorAttachmentKind.cs @@ -10,7 +10,7 @@ namespace Azure.Communication.JobRouter { - /// Supported worker selector attachment types. + /// Discriminators for supported worker selector attachment types. public readonly partial struct WorkerSelectorAttachmentKind : IEquatable { private readonly string _value; diff --git a/sdk/communication/Azure.Communication.JobRouter/src/Generated/tspCodeModel.json b/sdk/communication/Azure.Communication.JobRouter/src/Generated/tspCodeModel.json index c183e73c8b16..c22fb6ef9b7a 100644 --- a/sdk/communication/Azure.Communication.JobRouter/src/Generated/tspCodeModel.json +++ b/sdk/communication/Azure.Communication.JobRouter/src/Generated/tspCodeModel.json @@ -32,7 +32,7 @@ ], "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Supported distribution mode types", + "Description": "Discriminators for supported distribution mode types.", "IsExtensible": true, "IsNullable": false, "Usage": "Output" @@ -75,7 +75,7 @@ ], "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Supported router rule types", + "Description": "Discriminators for supported router rule types.", "IsExtensible": true, "IsNullable": false, "Usage": "Output" @@ -94,7 +94,7 @@ ], "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "The available expression languages that can be configured", + "Description": "Available expression languages that can be configured.", "IsExtensible": true, "IsNullable": false, "Usage": "Output" @@ -114,12 +114,12 @@ "$id": "16", "Name": "workerSelectors", "Value": "workerSelectors", - "Description": "Parameter to add worker selectors from the job to scoring payload. Property is sent as `selectors`." + "Description": "Parameter to add worker selectors from a job to scoring payload. Property is sent as `selectors`." } ], "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Supported parameters for scoring workers", + "Description": "Supported parameters for scoring workers used with BestWorkerMode.", "IsExtensible": true, "IsNullable": false, "Usage": "Output" @@ -162,7 +162,7 @@ ], "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Supported queue selector attachment types", + "Description": "Discriminators for supported queue selector attachment types.", "IsExtensible": true, "IsNullable": false, "Usage": "Output" @@ -176,37 +176,37 @@ "$id": "24", "Name": "equal", "Value": "equal", - "Description": "Equal" + "Description": "Equal." }, { "$id": "25", "Name": "notEqual", "Value": "notEqual", - "Description": "Not Equal" + "Description": "Not Equal." }, { "$id": "26", "Name": "lessThan", "Value": "lessThan", - "Description": "Less than" + "Description": "Less than." }, { "$id": "27", "Name": "lessThanOrEqual", "Value": "lessThanOrEqual", - "Description": "Less than or equal" + "Description": "Less than or equal." }, { "$id": "28", "Name": "greaterThan", "Value": "greaterThan", - "Description": "Greater than" + "Description": "Greater than." }, { "$id": "29", "Name": "greaterThanOrEqual", "Value": "greaterThanOrEqual", - "Description": "Greater than or equal" + "Description": "Greater than or equal." } ], "Namespace": "AzureCommunicationRoutingService", @@ -254,7 +254,7 @@ ], "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Supported worker selector attachment types", + "Description": "Discriminators for supported worker selector attachment types.", "IsExtensible": true, "IsNullable": false, "Usage": "Output" @@ -268,18 +268,18 @@ "$id": "37", "Name": "active", "Value": "active", - "Description": "Active" + "Description": "Worker selector is valid." }, { "$id": "38", "Name": "expired", "Value": "expired", - "Description": "Expired" + "Description": "Worker selector is not valid." } ], "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "The status of the worker selector.", + "Description": "Describes the status of a worker selector.", "IsExtensible": true, "IsNullable": false, "Usage": "Output" @@ -304,7 +304,7 @@ ], "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Supported exception trigger types", + "Description": "Discriminators for supported exception trigger types.", "IsExtensible": true, "IsNullable": false, "Usage": "Output" @@ -335,7 +335,7 @@ ], "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Supported exception action types", + "Description": "Discriminators for supported exception action types.", "IsExtensible": true, "IsNullable": false, "Usage": "Output" @@ -420,7 +420,7 @@ ], "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "The status of the Job.", + "Description": "Describes the various status of a job.", "IsExtensible": true, "IsNullable": false, "Usage": "Output" @@ -451,7 +451,7 @@ ], "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Supported matching mode types", + "Description": "Discriminators for supported matching mode types.", "IsExtensible": true, "IsNullable": false, "Usage": "Output" @@ -548,7 +548,7 @@ ], "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Enums used to filters jobs by state", + "Description": "Enums used to filters jobs by status.", "IsExtensible": true, "IsNullable": false, "Usage": "Input" @@ -579,7 +579,7 @@ ], "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Enums for worker status", + "Description": "Enums for worker states.", "IsExtensible": true, "IsNullable": false, "Usage": "Output" @@ -667,7 +667,7 @@ "$id": "92", "Name": "id", "SerializedName": "id", - "Description": "The unique identifier of the policy.", + "Description": "Id of a distribution policy.", "Type": { "$id": "93", "Name": "string", @@ -681,7 +681,7 @@ "$id": "94", "Name": "name", "SerializedName": "name", - "Description": "The human readable name of the policy.", + "Description": "Friendly name of this policy.", "Type": { "$id": "95", "Name": "string", @@ -695,7 +695,7 @@ "$id": "96", "Name": "offerExpiresAfterSeconds", "SerializedName": "offerExpiresAfterSeconds", - "Description": "The number of seconds after which any offers created under this policy will be expired.", + "Description": "Number of seconds after which any offers created under this policy will be expired.", "Type": { "$id": "97", "Name": "float64", @@ -709,13 +709,13 @@ "$id": "98", "Name": "mode", "SerializedName": "mode", - "Description": "Abstract base class for defining a distribution mode", + "Description": "Mode governing the specific distribution method.", "Type": { "$id": "99", "Name": "DistributionMode", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Abstract base class for defining a distribution mode", + "Description": "Abstract base class for defining a distribution mode.", "IsNullable": false, "DiscriminatorPropertyName": "kind", "Usage": "Output", @@ -752,7 +752,7 @@ "$id": "104", "Name": "bypassSelectors", "SerializedName": "bypassSelectors", - "Description": "If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for the job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false.", + "Description": "If set to true, then router will match workers to jobs even if they don't match label selectors. Warning: You may get workers that are not qualified for a job they are matched with if you set this variable to true. This flag is intended more for temporary usage. By default, set to false.", "Type": { "$id": "105", "Name": "boolean", @@ -766,7 +766,7 @@ "$id": "106", "Name": "kind", "SerializedName": "kind", - "Description": "The type discriminator describing a sub-type of DistributionMode", + "Description": "The type discriminator describing a sub-type of DistributionMode.", "Type": { "$ref": "2" }, @@ -849,7 +849,7 @@ "$id": "113", "Name": "language", "SerializedName": "language", - "Description": "The expression language to compile to and execute", + "Description": "The expression language to compile to and execute.", "Type": { "$ref": "12" }, @@ -860,7 +860,7 @@ "$id": "114", "Name": "expression", "SerializedName": "expression", - "Description": "The string containing the expression to evaluate. Should contain return statement with calculated values.", + "Description": "An expression to evaluate. Should contain return statement with calculated values.", "Type": { "$id": "115", "Name": "string", @@ -889,7 +889,7 @@ "$id": "117", "Name": "functionUri", "SerializedName": "functionUri", - "Description": "URL for Azure Function", + "Description": "URL for Azure Function.", "Type": { "$id": "118", "Name": "url", @@ -903,13 +903,13 @@ "$id": "119", "Name": "credential", "SerializedName": "credential", - "Description": "Credentials used to access Azure function rule", + "Description": "Credentials used to access Azure function rule.", "Type": { "$id": "120", "Name": "FunctionRouterRuleCredential", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Credentials used to access Azure function rule", + "Description": "Credentials used to access Azure function rule.", "IsNullable": false, "Usage": "Output", "Properties": [ @@ -917,7 +917,7 @@ "$id": "121", "Name": "functionKey", "SerializedName": "functionKey", - "Description": "Access key scoped to a particular function", + "Description": "Access key scoped to a particular function.", "Type": { "$id": "122", "Name": "string", @@ -945,7 +945,7 @@ "$id": "125", "Name": "clientId", "SerializedName": "clientId", - "Description": "Client id, when AppKey is provided In context of Azure function, this is usually the name of the key", + "Description": "Client id, when AppKey is provided In context of Azure function, this is usually the name of the key.", "Type": { "$id": "126", "Name": "string", @@ -1096,7 +1096,7 @@ "Name": "ScoringRuleOptions", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Encapsulates all options that can be passed as parameters for scoring rule with BestWorkerMode", + "Description": "Encapsulates all options that can be passed as parameters for scoring rule with BestWorkerMode.", "IsNullable": false, "Usage": "Output", "Properties": [ @@ -1118,7 +1118,7 @@ "$id": "145", "Name": "scoringParameters", "SerializedName": "scoringParameters", - "Description": "List of extra parameters from the job that will be sent as part of the payload to scoring rule. If not set, the job's labels (sent in the payload as `job`) and the job's worker selectors (sent in the payload as `selectors`) are added to the payload of the scoring rule by default. Note: Worker labels are always sent with scoring payload.", + "Description": "List of extra parameters from a job that will be sent as part of the payload to scoring rule. If not set, a job's labels (sent in the payload as `job`) and a job's worker selectors (sent in the payload as `selectors`) are added to the payload of the scoring rule by default. Note: Worker labels are always sent with scoring payload.", "Type": { "$id": "146", "Name": "Array", @@ -1305,7 +1305,7 @@ "$id": "161", "Name": "id", "SerializedName": "id", - "Description": "Unique identifier of this policy.", + "Description": "Id of a classification policy.", "Type": { "$id": "162", "Name": "string", @@ -1333,7 +1333,7 @@ "$id": "165", "Name": "fallbackQueueId", "SerializedName": "fallbackQueueId", - "Description": "The fallback queue to select if the queue selector doesn't find a match.", + "Description": "Id of a fallback queue to select if queue selector attachments doesn't find a match.", "Type": { "$id": "166", "Name": "string", @@ -1347,7 +1347,7 @@ "$id": "167", "Name": "queueSelectorAttachments", "SerializedName": "queueSelectorAttachments", - "Description": "The queue selector attachments used to resolve a queue for a given job.", + "Description": "Queue selector attachments used to resolve a queue for a job.", "Type": { "$id": "168", "Name": "Array", @@ -1356,7 +1356,7 @@ "Name": "QueueSelectorAttachment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "An attachment of queue selectors to resolve a queue to a job from a classification policy", + "Description": "An attachment of queue selectors to resolve a queue to a job from a classification policy.", "IsNullable": false, "DiscriminatorPropertyName": "kind", "Usage": "Output", @@ -1365,7 +1365,7 @@ "$id": "170", "Name": "kind", "SerializedName": "kind", - "Description": "The type discriminator describing a sub-type of QueueSelectorAttachment", + "Description": "The type discriminator describing a sub-type of QueueSelectorAttachment.", "Type": { "$ref": "17" }, @@ -1380,7 +1380,7 @@ "Name": "ConditionalQueueSelectorAttachment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Describes a set of queue selectors that will be attached if the given condition resolves to true", + "Description": "Describes a set of queue selectors that will be attached if the given condition resolves to true.", "IsNullable": false, "DiscriminatorValue": "conditional", "BaseModel": { @@ -1392,7 +1392,7 @@ "$id": "172", "Name": "condition", "SerializedName": "condition", - "Description": "The condition that must be true for the queue selectors to be attached", + "Description": "The condition that must be true for the queue selectors to be attached.", "Type": { "$ref": "109" }, @@ -1403,7 +1403,7 @@ "$id": "173", "Name": "queueSelectors", "SerializedName": "queueSelectors", - "Description": "The queue selectors to attach", + "Description": "The queue selectors to attach.", "Type": { "$id": "174", "Name": "Array", @@ -1412,7 +1412,7 @@ "Name": "RouterQueueSelector", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Describes a condition that must be met against a set of labels for queue selection", + "Description": "Describes a condition that must be met against a set of labels for queue selection.", "IsNullable": false, "Usage": "Output", "Properties": [ @@ -1420,7 +1420,7 @@ "$id": "176", "Name": "key", "SerializedName": "key", - "Description": "The label key to query against", + "Description": "The label key to query against.", "Type": { "$id": "177", "Name": "string", @@ -1434,7 +1434,7 @@ "$id": "178", "Name": "labelOperator", "SerializedName": "labelOperator", - "Description": "Describes how the value of the label is compared to the value defined on the label selector", + "Description": "Describes how the value of the label is compared to the value defined on the label selector.", "Type": { "$ref": "23" }, @@ -1469,7 +1469,7 @@ "Name": "PassThroughQueueSelectorAttachment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Attaches a queue selector where the value is passed through from the job label with the same key", + "Description": "Attaches a queue selector where the value is passed through from a job's label with the same key.", "IsNullable": false, "DiscriminatorValue": "passThrough", "BaseModel": { @@ -1481,7 +1481,7 @@ "$id": "182", "Name": "key", "SerializedName": "key", - "Description": "The label key to query against", + "Description": "The label key to query against.", "Type": { "$id": "183", "Name": "string", @@ -1495,7 +1495,7 @@ "$id": "184", "Name": "labelOperator", "SerializedName": "labelOperator", - "Description": "Describes how the value of the label is compared to the value pass through", + "Description": "Describes how the value of the label is compared to the value pass through.", "Type": { "$ref": "23" }, @@ -1509,7 +1509,7 @@ "Name": "RuleEngineQueueSelectorAttachment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Attaches queue selectors to a job when the RouterRule is resolved", + "Description": "Attaches queue selectors to a job when the RouterRule is resolved.", "IsNullable": false, "DiscriminatorValue": "ruleEngine", "BaseModel": { @@ -1521,7 +1521,7 @@ "$id": "186", "Name": "rule", "SerializedName": "rule", - "Description": "A RouterRule that resolves a collection of queue selectors to attach", + "Description": "A RouterRule that resolves a collection of queue selectors to attach.", "Type": { "$ref": "109" }, @@ -1535,7 +1535,7 @@ "Name": "StaticQueueSelectorAttachment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Describes a queue selector that will be attached to the job", + "Description": "Describes a queue selector that will be attached to a job.", "IsNullable": false, "DiscriminatorValue": "static", "BaseModel": { @@ -1561,7 +1561,7 @@ "Name": "WeightedAllocationQueueSelectorAttachment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Describes multiple sets of queue selectors, of which one will be selected and attached according to a weighting", + "Description": "Describes multiple sets of queue selectors, of which one will be selected and attached according to a weighting.", "IsNullable": false, "DiscriminatorValue": "weightedAllocation", "BaseModel": { @@ -1636,7 +1636,7 @@ "$id": "197", "Name": "prioritizationRule", "SerializedName": "prioritizationRule", - "Description": "The rule to determine a priority score for a given job.", + "Description": "A rule to determine a priority score for a job.", "Type": { "$ref": "109" }, @@ -1647,7 +1647,7 @@ "$id": "198", "Name": "workerSelectorAttachments", "SerializedName": "workerSelectorAttachments", - "Description": "The worker selector attachments used to attach worker selectors to a given job.", + "Description": "Worker selector attachments used to attach worker selectors to a job.", "Type": { "$id": "199", "Name": "Array", @@ -1656,7 +1656,7 @@ "Name": "WorkerSelectorAttachment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "An attachment which attaches worker selectors to a job", + "Description": "An attachment which attaches worker selectors to a job.", "IsNullable": false, "DiscriminatorPropertyName": "kind", "Usage": "Output", @@ -1665,7 +1665,7 @@ "$id": "201", "Name": "kind", "SerializedName": "kind", - "Description": "The type discriminator describing a sub-type of WorkerSelectorAttachment", + "Description": "The type discriminator describing a sub-type of WorkerSelectorAttachment.", "Type": { "$ref": "30" }, @@ -1680,7 +1680,7 @@ "Name": "ConditionalWorkerSelectorAttachment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Describes a set of worker selectors that will be attached if the given condition resolves to true", + "Description": "Describes a set of worker selectors that will be attached if the given condition resolves to true.", "IsNullable": false, "DiscriminatorValue": "conditional", "BaseModel": { @@ -1692,7 +1692,7 @@ "$id": "203", "Name": "condition", "SerializedName": "condition", - "Description": "The condition that must be true for the worker selectors to be attached", + "Description": "The condition that must be true for the worker selectors to be attached.", "Type": { "$ref": "109" }, @@ -1703,7 +1703,7 @@ "$id": "204", "Name": "workerSelectors", "SerializedName": "workerSelectors", - "Description": "The worker selectors to attach", + "Description": "The worker selectors to attach.", "Type": { "$id": "205", "Name": "Array", @@ -1712,7 +1712,7 @@ "Name": "RouterWorkerSelector", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Describes a condition that must be met against a set of labels for worker selection", + "Description": "Describes a condition that must be met against a set of labels for worker selection.", "IsNullable": false, "Usage": "Output", "Properties": [ @@ -1720,7 +1720,7 @@ "$id": "207", "Name": "key", "SerializedName": "key", - "Description": "The label key to query against", + "Description": "The label key to query against.", "Type": { "$id": "208", "Name": "string", @@ -1734,7 +1734,7 @@ "$id": "209", "Name": "labelOperator", "SerializedName": "labelOperator", - "Description": "Describes how the value of the label is compared to the value defined on the label selector", + "Description": "Describes how the value of the label is compared to the value defined on the worker selector.", "Type": { "$ref": "23" }, @@ -1773,7 +1773,7 @@ "$id": "214", "Name": "expedite", "SerializedName": "expedite", - "Description": "Pushes the job to the front of the queue as long as this selector is active.", + "Description": "Pushes a job to the front of the queue as long as this selector is active.", "Type": { "$id": "215", "Name": "boolean", @@ -1787,7 +1787,7 @@ "$id": "216", "Name": "status", "SerializedName": "status", - "Description": "The status of the worker selector.", + "Description": "Status of the worker selector.", "Type": { "$ref": "36" }, @@ -1798,7 +1798,7 @@ "$id": "217", "Name": "expiresAt", "SerializedName": "expiresAt", - "Description": "The time at which this worker selector expires in UTC", + "Description": "The time at which this worker selector expires in UTC.", "Type": { "$id": "218", "Name": "utcDateTime", @@ -1822,7 +1822,7 @@ "Name": "PassThroughWorkerSelectorAttachment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Attaches a worker selector where the value is passed through from the job label with the same key", + "Description": "Attaches a worker selector where the value is passed through from a job's label with the same key.", "IsNullable": false, "DiscriminatorValue": "passThrough", "BaseModel": { @@ -1834,7 +1834,7 @@ "$id": "220", "Name": "key", "SerializedName": "key", - "Description": "The label key to query against", + "Description": "The label key to query against.", "Type": { "$id": "221", "Name": "string", @@ -1848,7 +1848,7 @@ "$id": "222", "Name": "labelOperator", "SerializedName": "labelOperator", - "Description": "Describes how the value of the label is compared to the value pass through", + "Description": "Describes how the value of the label is compared to the value pass through.", "Type": { "$ref": "23" }, @@ -1876,7 +1876,7 @@ "Name": "RuleEngineWorkerSelectorAttachment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Attaches worker selectors to a job when a RouterRule is resolved", + "Description": "Attaches worker selectors to a job when a RouterRule is resolved.", "IsNullable": false, "DiscriminatorValue": "ruleEngine", "BaseModel": { @@ -1888,7 +1888,7 @@ "$id": "226", "Name": "rule", "SerializedName": "rule", - "Description": "A RouterRule that resolves a collection of worker selectors to attach", + "Description": "A RouterRule that resolves a collection of worker selectors to attach.", "Type": { "$ref": "109" }, @@ -1902,7 +1902,7 @@ "Name": "StaticWorkerSelectorAttachment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Describes a worker selector that will be attached to the job", + "Description": "Describes a worker selector that will be attached to a job.", "IsNullable": false, "DiscriminatorValue": "static", "BaseModel": { @@ -1928,7 +1928,7 @@ "Name": "WeightedAllocationWorkerSelectorAttachment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Describes multiple sets of worker selectors, of which one will be selected and attached according to a weighting", + "Description": "Describes multiple sets of worker selectors, of which one will be selected and attached according to a weighting.", "IsNullable": false, "DiscriminatorValue": "weightedAllocation", "BaseModel": { @@ -2115,7 +2115,7 @@ "$id": "245", "Name": "id", "SerializedName": "id", - "Description": "The Id of the exception policy", + "Description": "Id of an exception policy.", "Type": { "$id": "246", "Name": "string", @@ -2129,7 +2129,7 @@ "$id": "247", "Name": "name", "SerializedName": "name", - "Description": "The name of the exception policy.", + "Description": "Friendly name of this policy.", "Type": { "$id": "248", "Name": "string", @@ -2160,7 +2160,7 @@ "$id": "252", "Name": "id", "SerializedName": "id", - "Description": "Id of the exception rule.", + "Description": "Id of an exception rule.", "Type": { "$id": "253", "Name": "string", @@ -2174,13 +2174,13 @@ "$id": "254", "Name": "trigger", "SerializedName": "trigger", - "Description": "The trigger for this exception rule", + "Description": "The trigger for this exception rule.", "Type": { "$id": "255", "Name": "ExceptionTrigger", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "The trigger for this exception rule", + "Description": "Abstract base class for defining a trigger for exception rules.", "IsNullable": false, "DiscriminatorPropertyName": "kind", "Usage": "Output", @@ -2189,7 +2189,7 @@ "$id": "256", "Name": "kind", "SerializedName": "kind", - "Description": "The type discriminator describing a sub-type of ExceptionTrigger", + "Description": "The type discriminator describing a sub-type of ExceptionTrigger.", "Type": { "$ref": "39" }, @@ -2204,7 +2204,7 @@ "Name": "QueueLengthExceptionTrigger", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Trigger for an exception action on exceeding queue length", + "Description": "Trigger for an exception action on exceeding queue length.", "IsNullable": false, "DiscriminatorValue": "queueLength", "BaseModel": { @@ -2233,7 +2233,7 @@ "Name": "WaitTimeExceptionTrigger", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Trigger for an exception action on exceeding wait time", + "Description": "Trigger for an exception action on exceeding wait time.", "IsNullable": false, "DiscriminatorValue": "waitTime", "BaseModel": { @@ -2275,7 +2275,7 @@ "Name": "ExceptionAction", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "The action to take when the exception is triggered", + "Description": "The action to take when the exception is triggered.", "IsNullable": false, "DiscriminatorPropertyName": "kind", "Usage": "Output", @@ -2284,7 +2284,7 @@ "$id": "266", "Name": "id", "SerializedName": "id", - "Description": "Unique Id of the exception action", + "Description": "Unique Id of the exception action.", "Type": { "$id": "267", "Name": "string", @@ -2298,7 +2298,7 @@ "$id": "268", "Name": "kind", "SerializedName": "kind", - "Description": "The type discriminator describing a sub-type of ExceptionAction", + "Description": "The type discriminator describing a sub-type of ExceptionAction.", "Type": { "$ref": "42" }, @@ -2313,7 +2313,7 @@ "Name": "CancelExceptionAction", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "An action that marks a job as cancelled", + "Description": "An action that marks a job as cancelled.", "IsNullable": false, "DiscriminatorValue": "cancel", "BaseModel": { @@ -2325,7 +2325,7 @@ "$id": "270", "Name": "note", "SerializedName": "note", - "Description": "A note that will be appended to the jobs' Notes collection with the current timestamp.", + "Description": "A note that will be appended to a job's notes collection with the current timestamp.", "Type": { "$id": "271", "Name": "string", @@ -2339,7 +2339,7 @@ "$id": "272", "Name": "dispositionCode", "SerializedName": "dispositionCode", - "Description": "Indicates the outcome of the job, populate this field with your own custom values.", + "Description": "Indicates the outcome of a job, populate this field with your own custom values.", "Type": { "$id": "273", "Name": "string", @@ -2415,7 +2415,7 @@ "Name": "ReclassifyExceptionAction", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "An action that modifies labels on a job and then reclassifies it", + "Description": "An action that modifies labels on a job and then reclassifies it.", "IsNullable": false, "DiscriminatorValue": "reclassify", "BaseModel": { @@ -2570,7 +2570,7 @@ "$id": "296", "Name": "id", "SerializedName": "id", - "Description": "The Id of this queue", + "Description": "Id of a queue.", "Type": { "$id": "297", "Name": "string", @@ -2584,7 +2584,7 @@ "$id": "298", "Name": "name", "SerializedName": "name", - "Description": "The name of this queue.", + "Description": "Friendly name of this queue.", "Type": { "$id": "299", "Name": "string", @@ -2598,7 +2598,7 @@ "$id": "300", "Name": "distributionPolicyId", "SerializedName": "distributionPolicyId", - "Description": "The ID of the distribution policy that will determine how a job is distributed to workers.", + "Description": "Id of a distribution policy that will determine how a job is distributed to workers.", "Type": { "$id": "301", "Name": "string", @@ -2637,7 +2637,7 @@ "$id": "306", "Name": "exceptionPolicyId", "SerializedName": "exceptionPolicyId", - "Description": "The ID of the exception policy that determines various job escalation rules.", + "Description": "Id of an exception policy that determines various job escalation rules.", "Type": { "$id": "307", "Name": "string", @@ -2715,7 +2715,7 @@ "$id": "316", "Name": "id", "SerializedName": "id", - "Description": "The id of the job.", + "Description": "Id of a job.", "Type": { "$id": "317", "Name": "string", @@ -2743,7 +2743,7 @@ "$id": "320", "Name": "status", "SerializedName": "status", - "Description": "The status of the Job.", + "Description": "The status of the job.", "Type": { "$ref": "46" }, @@ -2754,7 +2754,7 @@ "$id": "321", "Name": "enqueuedAt", "SerializedName": "enqueuedAt", - "Description": "The time a job was queued in UTC.", + "Description": "Timestamp a job was queued in UTC.", "Type": { "$id": "322", "Name": "utcDateTime", @@ -2782,7 +2782,7 @@ "$id": "325", "Name": "classificationPolicyId", "SerializedName": "classificationPolicyId", - "Description": "The Id of the Classification policy used for classifying a job.", + "Description": "Id of a classification policy used for classifying this job.", "Type": { "$id": "326", "Name": "string", @@ -2796,7 +2796,7 @@ "$id": "327", "Name": "queueId", "SerializedName": "queueId", - "Description": "The Id of the Queue that this job is queued to.", + "Description": "Id of a queue that this job is queued to.", "Type": { "$id": "328", "Name": "string", @@ -2810,7 +2810,7 @@ "$id": "329", "Name": "priority", "SerializedName": "priority", - "Description": "The priority of this job.", + "Description": "Priority of this job.", "Type": { "$id": "330", "Name": "int32", @@ -2838,7 +2838,7 @@ "$id": "333", "Name": "requestedWorkerSelectors", "SerializedName": "requestedWorkerSelectors", - "Description": "A collection of manually specified label selectors, which a worker must satisfy in order to process this job.", + "Description": "A collection of manually specified worker selectors, which a worker must satisfy in order to process this job.", "Type": { "$id": "334", "Name": "Array", @@ -2854,7 +2854,7 @@ "$id": "335", "Name": "attachedWorkerSelectors", "SerializedName": "attachedWorkerSelectors", - "Description": "A collection of label selectors attached by a classification policy, which a worker must satisfy in order to process this job.", + "Description": "A collection of worker selectors attached by a classification policy, which a worker must satisfy in order to process this job.", "Type": { "$id": "336", "Name": "Array", @@ -2910,7 +2910,7 @@ "Name": "RouterJobAssignment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Assignment details of a job to a worker", + "Description": "Assignment details of a job to a worker.", "IsNullable": false, "Usage": "Output", "Properties": [ @@ -2918,7 +2918,7 @@ "$id": "345", "Name": "assignmentId", "SerializedName": "assignmentId", - "Description": "The Id of the job assignment.", + "Description": "Id of a job assignment.", "Type": { "$id": "346", "Name": "string", @@ -2932,7 +2932,7 @@ "$id": "347", "Name": "workerId", "SerializedName": "workerId", - "Description": "The Id of the Worker assigned to the job.", + "Description": "Id of the Worker assigned to the job.", "Type": { "$id": "348", "Name": "string", @@ -2946,7 +2946,7 @@ "$id": "349", "Name": "assignedAt", "SerializedName": "assignedAt", - "Description": "The assignment time of the job in UTC.", + "Description": "Timestamp when the job was assigned to a worker in UTC.", "Type": { "$id": "350", "Name": "utcDateTime", @@ -2960,7 +2960,7 @@ "$id": "351", "Name": "completedAt", "SerializedName": "completedAt", - "Description": "The time the job was marked as completed after being assigned in UTC.", + "Description": "Timestamp when the job was marked as completed after being assigned in UTC.", "Type": { "$id": "352", "Name": "utcDateTime", @@ -2974,7 +2974,7 @@ "$id": "353", "Name": "closedAt", "SerializedName": "closedAt", - "Description": "The time the job was marked as closed after being completed in UTC.", + "Description": "Timestamp when the job was marked as closed after being completed in UTC.", "Type": { "$id": "354", "Name": "utcDateTime", @@ -3020,7 +3020,7 @@ "$id": "359", "Name": "notes", "SerializedName": "notes", - "Description": "Notes attached to a job, sorted by timestamp", + "Description": "Notes attached to a job, sorted by timestamp.", "Type": { "$id": "360", "Name": "Array", @@ -3072,7 +3072,7 @@ "$id": "366", "Name": "scheduledAt", "SerializedName": "scheduledAt", - "Description": "If set, job will be scheduled to be enqueued at a given time", + "Description": "If set, job will be scheduled to be enqueued at a given time.", "Type": { "$id": "367", "Name": "utcDateTime", @@ -3101,7 +3101,7 @@ "$id": "370", "Name": "kind", "SerializedName": "kind", - "Description": "The type discriminator describing a sub-type of JobMatchingMode", + "Description": "The type discriminator describing a sub-type of JobMatchingMode.", "Type": { "$ref": "59" }, @@ -3128,7 +3128,7 @@ "$id": "372", "Name": "scheduleAt", "SerializedName": "scheduleAt", - "Description": "Scheduled time.", + "Description": "Requested schedule time.", "Type": { "$id": "373", "Name": "utcDateTime", @@ -3198,7 +3198,7 @@ "Name": "ReclassifyJobOptions", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Request payload for reclassifying jobs", + "Description": "Request payload for reclassifying jobs.", "IsNullable": false, "Usage": "Input", "Properties": [] @@ -3208,7 +3208,7 @@ "Name": "ReclassifyJobResult", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Response payload from reclassifying a job", + "Description": "Response payload from reclassifying a job.", "IsNullable": false, "Usage": "Output", "Properties": [] @@ -3218,7 +3218,7 @@ "Name": "CancelJobOptions", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Request payload for deleting a job", + "Description": "Request payload for cancelling a job.", "IsNullable": false, "Usage": "Input", "Properties": [ @@ -3226,7 +3226,7 @@ "$id": "379", "Name": "note", "SerializedName": "note", - "Description": "A note that will be appended to the jobs' Notes collection with the current timestamp.", + "Description": "A note that will be appended to a job's Notes collection with the current timestamp.", "Type": { "$id": "380", "Name": "string", @@ -3240,7 +3240,7 @@ "$id": "381", "Name": "dispositionCode", "SerializedName": "dispositionCode", - "Description": "Indicates the outcome of the job, populate this field with your own custom values. If not provided, default value of \"Cancelled\" is set.", + "Description": "Indicates the outcome of a job, populate this field with your own custom values. If not provided, default value of \"Cancelled\" is set.", "Type": { "$id": "382", "Name": "string", @@ -3257,7 +3257,7 @@ "Name": "CancelJobResult", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Response payload from cancelling a job", + "Description": "Response payload from cancelling a job.", "IsNullable": false, "Usage": "Output", "Properties": [] @@ -3267,7 +3267,7 @@ "Name": "CompleteJobOptions", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Request payload for completing jobs", + "Description": "Request payload for completing jobs.", "IsNullable": false, "Usage": "Input", "Properties": [ @@ -3275,7 +3275,7 @@ "$id": "385", "Name": "note", "SerializedName": "note", - "Description": "A note that will be appended to the jobs' Notes collection with the current timestamp.", + "Description": "A note that will be appended to a job's Notes collection with the current timestamp.", "Type": { "$id": "386", "Name": "string", @@ -3292,7 +3292,7 @@ "Name": "CompleteJobResult", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Response payload from completing a job", + "Description": "Response payload from completing a job.", "IsNullable": false, "Usage": "Output", "Properties": [] @@ -3310,7 +3310,7 @@ "$id": "389", "Name": "dispositionCode", "SerializedName": "dispositionCode", - "Description": "Indicates the outcome of the job, populate this field with your own custom values.", + "Description": "Indicates the outcome of a job, populate this field with your own custom values.", "Type": { "$id": "390", "Name": "string", @@ -3338,7 +3338,7 @@ "$id": "393", "Name": "note", "SerializedName": "note", - "Description": "A note that will be appended to the jobs' Notes collection with the current timestamp.", + "Description": "A note that will be appended to a job's Notes collection with the current timestamp.", "Type": { "$id": "394", "Name": "string", @@ -3355,7 +3355,7 @@ "Name": "CloseJobResult", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Response payload from closing a job", + "Description": "Response payload from closing a job.", "IsNullable": false, "Usage": "Output", "Properties": [] @@ -3468,7 +3468,7 @@ "$id": "410", "Name": "estimatedWaitTimeMinutes", "SerializedName": "estimatedWaitTimeMinutes", - "Description": "Estimated wait time of the job rounded up to the nearest minute", + "Description": "Estimated wait time of the job rounded up to the nearest minute.", "Type": { "$id": "411", "Name": "float64", @@ -3493,7 +3493,7 @@ "$id": "413", "Name": "suspendMatching", "SerializedName": "suspendMatching", - "Description": "If SuspendMatching is true, then the job is not queued for re-matching with a worker.", + "Description": "If SuspendMatching is true, then a job is not queued for re-matching with a worker.", "Type": { "$id": "414", "Name": "boolean", @@ -3518,7 +3518,7 @@ "$id": "416", "Name": "jobId", "SerializedName": "jobId", - "Description": "The Id of the job unassigned.", + "Description": "Id of an unassigned job.", "Type": { "$id": "417", "Name": "string", @@ -3548,7 +3548,7 @@ "$id": "420", "Name": "AcceptJobOfferResult", "Namespace": "AzureCommunicationRoutingService", - "Description": "Response containing Id's for the worker, job, and assignment from an accepted offer", + "Description": "Response containing ids for the worker, job, and assignment from an accepted offer.", "IsNullable": false, "Usage": "Output", "Properties": [ @@ -3556,7 +3556,7 @@ "$id": "421", "Name": "assignmentId", "SerializedName": "assignmentId", - "Description": "The assignment Id that assigns a worker that has accepted an offer to a job.", + "Description": "Id of job assignment that assigns a worker that has accepted an offer to a job.", "Type": { "$id": "422", "Name": "string", @@ -3570,7 +3570,7 @@ "$id": "423", "Name": "jobId", "SerializedName": "jobId", - "Description": "The Id of the job assigned.", + "Description": "Id of the job assigned.", "Type": { "$id": "424", "Name": "string", @@ -3584,7 +3584,7 @@ "$id": "425", "Name": "workerId", "SerializedName": "workerId", - "Description": "The Id of the worker that has been assigned this job.", + "Description": "Id of the worker that has been assigned this job.", "Type": { "$id": "426", "Name": "string", @@ -3601,7 +3601,7 @@ "Name": "DeclineJobOfferOptions", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Request payload for declining offers", + "Description": "Request payload for declining offers.", "IsNullable": false, "Usage": "Input", "Properties": [ @@ -3626,7 +3626,7 @@ "Name": "DeclineJobOfferResult", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Response payload from declining a job", + "Description": "Response payload from declining a job.", "IsNullable": false, "Usage": "Output", "Properties": [] @@ -3635,7 +3635,7 @@ "$id": "431", "Name": "RouterQueueStatistics", "Namespace": "AzureCommunicationRoutingService", - "Description": "Statistics for the queue", + "Description": "Statistics for the queue.", "IsNullable": false, "Usage": "Output", "Properties": [ @@ -3671,7 +3671,7 @@ "$id": "436", "Name": "estimatedWaitTimeMinutes", "SerializedName": "estimatedWaitTimeMinutes", - "Description": "The estimated wait time of this queue rounded up to the nearest minute, grouped by job priority", + "Description": "The estimated wait time of this queue rounded up to the nearest minute, grouped by job priority.", "Type": { "$id": "437", "Name": "Dictionary", @@ -3712,7 +3712,7 @@ "$id": "442", "Name": "RouterWorker", "Namespace": "AzureCommunicationRoutingService", - "Description": "An entity for jobs to be routed to", + "Description": "An entity for jobs to be routed to.", "IsNullable": false, "Usage": "Output", "Properties": [ @@ -3734,7 +3734,7 @@ "$id": "445", "Name": "id", "SerializedName": "id", - "Description": "Id of the worker.", + "Description": "Id of a worker.", "Type": { "$id": "446", "Name": "string", @@ -3748,7 +3748,7 @@ "$id": "447", "Name": "state", "SerializedName": "state", - "Description": "The current state of the worker.", + "Description": "Current state of a worker.", "Type": { "$ref": "78" }, @@ -3759,7 +3759,7 @@ "$id": "448", "Name": "queues", "SerializedName": "queues", - "Description": "The queue(s) that this worker can receive work from.", + "Description": "Collection of queue(s) that this worker can receive work from.", "Type": { "$id": "449", "Name": "Array", @@ -3842,7 +3842,7 @@ "$id": "461", "Name": "channels", "SerializedName": "channels", - "Description": "The channel(s) this worker can handle and their impact on the workers capacity.", + "Description": "Collection of channel(s) this worker can handle and their impact on the workers capacity.", "Type": { "$id": "462", "Name": "Array", @@ -3851,7 +3851,7 @@ "Name": "RouterChannel", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "Represents the capacity a job in this channel will consume from a worker", + "Description": "Represents the capacity a job in this channel will consume from a worker.", "IsNullable": false, "Usage": "Output", "Properties": [ @@ -3859,7 +3859,7 @@ "$id": "464", "Name": "channelId", "SerializedName": "channelId", - "Description": "Id of the channel.", + "Description": "Id of a channel.", "Type": { "$id": "465", "Name": "string", @@ -3917,7 +3917,7 @@ "Name": "RouterJobOffer", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "An offer of a job to a worker", + "Description": "An offer of a job to a worker.", "IsNullable": false, "Usage": "Output", "Properties": [ @@ -3925,7 +3925,7 @@ "$id": "473", "Name": "offerId", "SerializedName": "offerId", - "Description": "The Id of the offer.", + "Description": "Id of an offer.", "Type": { "$id": "474", "Name": "string", @@ -3939,7 +3939,7 @@ "$id": "475", "Name": "jobId", "SerializedName": "jobId", - "Description": "The Id of the job.", + "Description": "Id of the job.", "Type": { "$id": "476", "Name": "string", @@ -3967,7 +3967,7 @@ "$id": "479", "Name": "offeredAt", "SerializedName": "offeredAt", - "Description": "The time the offer was created in UTC.", + "Description": "Timestamp when the offer was created in UTC.", "Type": { "$id": "480", "Name": "utcDateTime", @@ -3981,7 +3981,7 @@ "$id": "481", "Name": "expiresAt", "SerializedName": "expiresAt", - "Description": "The time that the offer will expire in UTC.", + "Description": "Timestamp when the offer will expire in UTC.", "Type": { "$id": "482", "Name": "utcDateTime", @@ -4011,7 +4011,7 @@ "Name": "RouterWorkerAssignment", "Namespace": "AzureCommunicationRoutingService", "Accessibility": "internal", - "Description": "The assignment for a worker to a job", + "Description": "The assignment for a worker to a job.", "IsNullable": false, "Usage": "Output", "Properties": [ @@ -4019,7 +4019,7 @@ "$id": "486", "Name": "assignmentId", "SerializedName": "assignmentId", - "Description": "The Id of the assignment.", + "Description": "Id of the assignment.", "Type": { "$id": "487", "Name": "string", @@ -4033,7 +4033,7 @@ "$id": "488", "Name": "jobId", "SerializedName": "jobId", - "Description": "The Id of the Job assigned.", + "Description": "Id of the job assigned.", "Type": { "$id": "489", "Name": "string", @@ -4200,7 +4200,7 @@ "$id": "507", "Name": "CancelJobResultWithOkResponse", "Namespace": "AzureCommunicationRoutingService", - "Description": "OK Response payload from cancelling a job", + "Description": "OK Response payload from cancelling a job.", "IsNullable": false, "Usage": "Output", "Properties": [ @@ -4221,7 +4221,7 @@ "$id": "509", "Name": "CompleteJobResultWithOkResponse", "Namespace": "AzureCommunicationRoutingService", - "Description": "OK Response payload from completing a job", + "Description": "OK Response payload from completing a job.", "IsNullable": false, "Usage": "Output", "Properties": [ @@ -4299,6 +4299,7 @@ "$id": "517", "Name": "endpoint", "NameInRequest": "endpoint", + "Description": "Uri of your Communication resource", "Type": { "$id": "518", "Name": "Uri", @@ -4350,7 +4351,7 @@ "$id": "523", "Name": "distributionPolicyId", "NameInRequest": "distributionPolicyId", - "Description": "The unique identifier of the policy.", + "Description": "Id of a distribution policy.", "Type": { "$id": "524", "Name": "string", @@ -4593,7 +4594,7 @@ "$id": "548", "Name": "distributionPolicyId", "NameInRequest": "distributionPolicyId", - "Description": "The unique identifier of the policy.", + "Description": "Id of a distribution policy.", "Type": { "$id": "549", "Name": "string", @@ -4792,7 +4793,7 @@ "$id": "567", "Name": "distributionPolicyId", "NameInRequest": "distributionPolicyId", - "Description": "The unique identifier of the policy.", + "Description": "Id of a distribution policy.", "Type": { "$id": "568", "Name": "string", @@ -4874,7 +4875,7 @@ "$id": "574", "Name": "classificationPolicyId", "NameInRequest": "classificationPolicyId", - "Description": "Unique identifier of this policy.", + "Description": "Id of a classification policy.", "Type": { "$id": "575", "Name": "string", @@ -5117,7 +5118,7 @@ "$id": "599", "Name": "classificationPolicyId", "NameInRequest": "classificationPolicyId", - "Description": "Unique identifier of this policy.", + "Description": "Id of a classification policy.", "Type": { "$id": "600", "Name": "string", @@ -5316,7 +5317,7 @@ "$id": "618", "Name": "classificationPolicyId", "NameInRequest": "classificationPolicyId", - "Description": "Unique identifier of this policy.", + "Description": "Id of a classification policy.", "Type": { "$id": "619", "Name": "string", @@ -5398,7 +5399,7 @@ "$id": "625", "Name": "exceptionPolicyId", "NameInRequest": "exceptionPolicyId", - "Description": "The Id of the exception policy", + "Description": "Id of an exception policy.", "Type": { "$id": "626", "Name": "string", @@ -5641,7 +5642,7 @@ "$id": "650", "Name": "exceptionPolicyId", "NameInRequest": "exceptionPolicyId", - "Description": "The Id of the exception policy", + "Description": "Id of an exception policy.", "Type": { "$id": "651", "Name": "string", @@ -5840,7 +5841,7 @@ "$id": "669", "Name": "exceptionPolicyId", "NameInRequest": "exceptionPolicyId", - "Description": "The Id of the exception policy", + "Description": "Id of an exception policy.", "Type": { "$id": "670", "Name": "string", @@ -5922,7 +5923,7 @@ "$id": "676", "Name": "queueId", "NameInRequest": "queueId", - "Description": "The Id of this queue", + "Description": "Id of a queue.", "Type": { "$id": "677", "Name": "string", @@ -6165,7 +6166,7 @@ "$id": "701", "Name": "queueId", "NameInRequest": "queueId", - "Description": "The Id of this queue", + "Description": "Id of a queue.", "Type": { "$id": "702", "Name": "string", @@ -6364,7 +6365,7 @@ "$id": "720", "Name": "queueId", "NameInRequest": "queueId", - "Description": "The Id of this queue", + "Description": "Id of a queue.", "Type": { "$id": "721", "Name": "string", @@ -6457,7 +6458,7 @@ "$id": "729", "Name": "jobId", "NameInRequest": "jobId", - "Description": "The id of the job.", + "Description": "Id of a job.", "Type": { "$id": "730", "Name": "string", @@ -6700,7 +6701,7 @@ "$id": "754", "Name": "jobId", "NameInRequest": "jobId", - "Description": "The id of the job.", + "Description": "Id of a job.", "Type": { "$id": "755", "Name": "string", @@ -6809,7 +6810,7 @@ "$id": "765", "Name": "jobId", "NameInRequest": "jobId", - "Description": "The id of the job.", + "Description": "Id of a job.", "Type": { "$id": "766", "Name": "string", @@ -6891,7 +6892,7 @@ "$id": "772", "Name": "jobId", "NameInRequest": "jobId", - "Description": "The id of the job.", + "Description": "Id of a job.", "Type": { "$id": "773", "Name": "string", @@ -7024,7 +7025,7 @@ "$id": "783", "Name": "jobId", "NameInRequest": "jobId", - "Description": "The id of the job.", + "Description": "Id of a job.", "Type": { "$id": "784", "Name": "string", @@ -7157,7 +7158,7 @@ "$id": "794", "Name": "jobId", "NameInRequest": "jobId", - "Description": "The id of the job.", + "Description": "Id of a job.", "Type": { "$id": "795", "Name": "string", @@ -7178,7 +7179,7 @@ "$id": "796", "Name": "assignmentId", "NameInRequest": "assignmentId", - "Description": "The Id of the job assignment.", + "Description": "Id of a job assignment.", "Type": { "$id": "797", "Name": "string", @@ -7311,7 +7312,7 @@ "$id": "807", "Name": "jobId", "NameInRequest": "jobId", - "Description": "The id of the job.", + "Description": "Id of a job.", "Type": { "$id": "808", "Name": "string", @@ -7332,7 +7333,7 @@ "$id": "809", "Name": "assignmentId", "NameInRequest": "assignmentId", - "Description": "The Id of the job assignment.", + "Description": "Id of a job assignment.", "Type": { "$id": "810", "Name": "string", @@ -7748,8 +7749,8 @@ "$id": "845", "Name": "unassignJob", "ResourceName": "JobRouterRestClient", - "Summary": "Un-assign a job.", - "Description": "Un-assign a job.", + "Summary": "Unassign a job.", + "Description": "Unassign a job.", "Accessibility": "internal", "Parameters": [ { @@ -7762,7 +7763,7 @@ "$id": "846", "Name": "jobId", "NameInRequest": "jobId", - "Description": "The id of the job.", + "Description": "Id of a job.", "Type": { "$id": "847", "Name": "string", @@ -7783,7 +7784,7 @@ "$id": "848", "Name": "assignmentId", "NameInRequest": "assignmentId", - "Description": "The Id of the job assignment.", + "Description": "Id of a job assignment.", "Type": { "$id": "849", "Name": "string", @@ -7915,7 +7916,7 @@ "$id": "859", "Name": "workerId", "NameInRequest": "workerId", - "Description": "Id of the worker.", + "Description": "Id of a worker.", "Type": { "$id": "860", "Name": "string", @@ -7936,7 +7937,7 @@ "$id": "861", "Name": "offerId", "NameInRequest": "offerId", - "Description": "The Id of the offer.", + "Description": "Id of an offer.", "Type": { "$id": "862", "Name": "string", @@ -8021,7 +8022,7 @@ "$id": "868", "Name": "workerId", "NameInRequest": "workerId", - "Description": "Id of the worker.", + "Description": "Id of a worker.", "Type": { "$id": "869", "Name": "string", @@ -8042,7 +8043,7 @@ "$id": "870", "Name": "offerId", "NameInRequest": "offerId", - "Description": "The Id of the offer.", + "Description": "Id of an offer.", "Type": { "$id": "871", "Name": "string", @@ -8259,7 +8260,7 @@ "$id": "888", "Name": "workerId", "NameInRequest": "workerId", - "Description": "Id of the worker.", + "Description": "Id of a worker.", "Type": { "$id": "889", "Name": "string", @@ -8502,7 +8503,7 @@ "$id": "913", "Name": "workerId", "NameInRequest": "workerId", - "Description": "Id of the worker.", + "Description": "Id of a worker.", "Type": { "$id": "914", "Name": "string", @@ -8611,7 +8612,7 @@ "$id": "924", "Name": "workerId", "NameInRequest": "workerId", - "Description": "Id of the worker.", + "Description": "Id of a worker.", "Type": { "$id": "925", "Name": "string", diff --git a/sdk/communication/Azure.Communication.JobRouter/tsp-location.yaml b/sdk/communication/Azure.Communication.JobRouter/tsp-location.yaml index 351cd075aa5a..a12c3c75ca51 100644 --- a/sdk/communication/Azure.Communication.JobRouter/tsp-location.yaml +++ b/sdk/communication/Azure.Communication.JobRouter/tsp-location.yaml @@ -1,5 +1,5 @@ -commit: 75065f761aba389ba50ce9a33f9a9da6a2ae288d directory: specification/communication/Communication.JobRouter additionalDirectories: [] -repo: sarkar-rajarshi/azure-rest-api-specs +repo: Azure/azure-rest-api-specs +commit: fae971a688cb023c19708a7551da18ea22dff5d5