com.azure.communication.jobrouter.models.CreateQueueOptions Maven / Gradle / Ivy

Go to download
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.

package com.azure.communication.jobrouter.models;

import com.azure.core.annotation.Fluent;

import java.util.Map;

/**
 * Request options to create a queue.
 * Queue: A queue that can contain jobs to be routed.
 */
@Fluent
public final class CreateQueueOptions {
    /**
     * The Id of this queue
     */
    private final String queueId;

    /**
     * The name of this queue.
     */
    private String name;

    /**
     * The ID of the distribution policy that will determine how a job is
     * distributed to workers.
     */
    private final String distributionPolicyId;

    /**
     * A set of key/value pairs that are identifying attributes used by the
     * rules engines to make decisions.
     */
    private Map labels;

    /**
     * (Optional) The ID of the exception policy that determines various job
     * escalation rules.
     */
    private String exceptionPolicyId;

    /**
     * Constructor for CreateQueueOptions.
     * @param queueId The id of queue.
     * @param distributionPolicyId The id of distribution policy.
     */
    public CreateQueueOptions(String queueId, String distributionPolicyId) {
        this.queueId = queueId;
        this.distributionPolicyId = distributionPolicyId;
    }

    /**
     * Sets name
     * @param name Human-readable name of queue.
     * @return this
     */
    public CreateQueueOptions setName(String name) {
        this.name = name;
        return this;
    }

    /**
     * Sets labels
     * @param labels A set of key/value pairs that are identifying attributes used by the rules engines to make decisions.
     * @return this
     */
    public CreateQueueOptions setLabels(Map labels) {
        this.labels = labels;
        return this;
    }

    /**
     * Sets exceptionPolicyId
     * @param exceptionPolicyId (Optional) The ID of the exception policy that determines various job escalation rules.
     * @return this
     */
    public CreateQueueOptions setExceptionPolicyId(String exceptionPolicyId) {
        this.exceptionPolicyId = exceptionPolicyId;
        return this;
    }

    /**
     * Returns the id of Job Queue.
     * @return id.
     */
    public String getQueueId() {
        return this.queueId;
    }

    /**
     * Returns the name of this queue.
     * @return name
     */
    public String getName() {
        return this.name;
    }

    /**
     * Returns the id of distribution policy.
     * @return id
     */
    public String getDistributionPolicyId() {
        return this.distributionPolicyId;
    }

    /**
     * Returns labels of Queue.
     * @return labels
     */
    public Map getLabels() {
        return this.labels;
    }

    /**
     * Returns the id of exception policy.
     * @return exceptionPolicyId
     */
    public String getExceptionPolicyId() {
        return this.exceptionPolicyId;
    }
}