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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-communication-jobrouter Show documentation
This package contains a Java SDK for JobRouter Azure Communication Service.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) TypeSpec Code Generator.
package com.azure.communication.jobrouter.models;

import com.azure.core.annotation.Fluent;
import com.azure.core.annotation.Generated;
import com.fasterxml.jackson.annotation.JsonProperty;

import java.time.OffsetDateTime;

/**
 * Request payload for closing jobs.
 */
@Fluent
public final class CloseJobOptions {

    /*
     * Indicates the outcome of a job, populate this field with your own custom values.
     */
    @Generated
    @JsonProperty(value = "dispositionCode")
    private String dispositionCode;

    /*
     * 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.
     */
    @Generated
    @JsonProperty(value = "closeAt")
    private OffsetDateTime closeAt;

    /*
     * A note that will be appended to a job's Notes collection with the current timestamp.
     */
    @Generated
    @JsonProperty(value = "note")
    private String note;

    /**
     * Creates an instance of CloseJobOptionsInternal class.
     */
    @Generated
    public CloseJobOptions() {
    }

    /**
     * Get the dispositionCode property: Indicates the outcome of a job, populate this field with your own custom
     * values.
     *
     * @return the dispositionCode value.
     */
    @Generated
    public String getDispositionCode() {
        return this.dispositionCode;
    }

    /**
     * Set the dispositionCode property: Indicates the outcome of a job, populate this field with your own custom
     * values.
     *
     * @param dispositionCode the dispositionCode value to set.
     * @return the CloseJobOptionsInternal object itself.
     */
    @Generated
    public CloseJobOptions setDispositionCode(String dispositionCode) {
        this.dispositionCode = dispositionCode;
        return this;
    }

    /**
     * Get the closeAt property: 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.
     *
     * @return the closeAt value.
     */
    @Generated
    public OffsetDateTime getCloseAt() {
        return this.closeAt;
    }

    /**
     * Set the closeAt property: 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.
     *
     * @param closeAt the closeAt value to set.
     * @return the CloseJobOptionsInternal object itself.
     */
    @Generated
    public CloseJobOptions setCloseAt(OffsetDateTime closeAt) {
        this.closeAt = closeAt;
        return this;
    }

    /**
     * Get the note property: A note that will be appended to a job's Notes collection with the current timestamp.
     *
     * @return the note value.
     */
    @Generated
    public String getNote() {
        return this.note;
    }

    /**
     * Set the note property: A note that will be appended to a job's Notes collection with the current timestamp.
     *
     * @param note the note value to set.
     * @return the CloseJobOptionsInternal object itself.
     */
    @Generated
    public CloseJobOptions setNote(String note) {
        this.note = note;
        return this;
    }
}