com.azure.resourcemanager.costmanagement.models.ScheduleProperties Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure-resourcemanager-costmanagement Show documentation
This package contains Microsoft Azure SDK for CostManagement Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. CostManagement management client provides access to CostManagement resources for Azure Enterprise Subscriptions. Package tag package-2022-10.
The newest version!
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.costmanagement.models;

import com.azure.core.annotation.Fluent;
import com.azure.core.util.logging.ClientLogger;
import com.fasterxml.jackson.annotation.JsonProperty;
import java.time.OffsetDateTime;
import java.util.List;

/** The properties of the schedule. */
@Fluent
public final class ScheduleProperties {
    /*
     * Frequency of the schedule.
     */
    @JsonProperty(value = "frequency", required = true)
    private ScheduleFrequency frequency;

    /*
     * UTC time at which cost analysis data will be emailed.
     */
    @JsonProperty(value = "hourOfDay")
    private Integer hourOfDay;

    /*
     * Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is
     * Weekly or Monthly.
     */
    @JsonProperty(value = "daysOfWeek")
    private List daysOfWeek;

    /*
     * Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and
     * used in combination with daysOfWeek.
     */
    @JsonProperty(value = "weeksOfMonth")
    private List weeksOfMonth;

    /*
     * UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when
     * frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
     */
    @JsonProperty(value = "dayOfMonth")
    private Integer dayOfMonth;

    /*
     * The start date and time of the scheduled action (UTC).
     */
    @JsonProperty(value = "startDate", required = true)
    private OffsetDateTime startDate;

    /*
     * The end date and time of the scheduled action (UTC).
     */
    @JsonProperty(value = "endDate", required = true)
    private OffsetDateTime endDate;

    /** Creates an instance of ScheduleProperties class. */
    public ScheduleProperties() {
    }

    /**
     * Get the frequency property: Frequency of the schedule.
     *
     * @return the frequency value.
     */
    public ScheduleFrequency frequency() {
        return this.frequency;
    }

    /**
     * Set the frequency property: Frequency of the schedule.
     *
     * @param frequency the frequency value to set.
     * @return the ScheduleProperties object itself.
     */
    public ScheduleProperties withFrequency(ScheduleFrequency frequency) {
        this.frequency = frequency;
        return this;
    }

    /**
     * Get the hourOfDay property: UTC time at which cost analysis data will be emailed.
     *
     * @return the hourOfDay value.
     */
    public Integer hourOfDay() {
        return this.hourOfDay;
    }

    /**
     * Set the hourOfDay property: UTC time at which cost analysis data will be emailed.
     *
     * @param hourOfDay the hourOfDay value to set.
     * @return the ScheduleProperties object itself.
     */
    public ScheduleProperties withHourOfDay(Integer hourOfDay) {
        this.hourOfDay = hourOfDay;
        return this;
    }

    /**
     * Get the daysOfWeek property: Day names in english on which cost analysis data will be emailed. This property is
     * applicable when frequency is Weekly or Monthly.
     *
     * @return the daysOfWeek value.
     */
    public List daysOfWeek() {
        return this.daysOfWeek;
    }

    /**
     * Set the daysOfWeek property: Day names in english on which cost analysis data will be emailed. This property is
     * applicable when frequency is Weekly or Monthly.
     *
     * @param daysOfWeek the daysOfWeek value to set.
     * @return the ScheduleProperties object itself.
     */
    public ScheduleProperties withDaysOfWeek(List daysOfWeek) {
        this.daysOfWeek = daysOfWeek;
        return this;
    }

    /**
     * Get the weeksOfMonth property: Weeks in which cost analysis data will be emailed. This property is applicable
     * when frequency is Monthly and used in combination with daysOfWeek.
     *
     * @return the weeksOfMonth value.
     */
    public List weeksOfMonth() {
        return this.weeksOfMonth;
    }

    /**
     * Set the weeksOfMonth property: Weeks in which cost analysis data will be emailed. This property is applicable
     * when frequency is Monthly and used in combination with daysOfWeek.
     *
     * @param weeksOfMonth the weeksOfMonth value to set.
     * @return the ScheduleProperties object itself.
     */
    public ScheduleProperties withWeeksOfMonth(List weeksOfMonth) {
        this.weeksOfMonth = weeksOfMonth;
        return this;
    }

    /**
     * Get the dayOfMonth property: UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This
     * property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
     *
     * @return the dayOfMonth value.
     */
    public Integer dayOfMonth() {
        return this.dayOfMonth;
    }

    /**
     * Set the dayOfMonth property: UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This
     * property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.
     *
     * @param dayOfMonth the dayOfMonth value to set.
     * @return the ScheduleProperties object itself.
     */
    public ScheduleProperties withDayOfMonth(Integer dayOfMonth) {
        this.dayOfMonth = dayOfMonth;
        return this;
    }

    /**
     * Get the startDate property: The start date and time of the scheduled action (UTC).
     *
     * @return the startDate value.
     */
    public OffsetDateTime startDate() {
        return this.startDate;
    }

    /**
     * Set the startDate property: The start date and time of the scheduled action (UTC).
     *
     * @param startDate the startDate value to set.
     * @return the ScheduleProperties object itself.
     */
    public ScheduleProperties withStartDate(OffsetDateTime startDate) {
        this.startDate = startDate;
        return this;
    }

    /**
     * Get the endDate property: The end date and time of the scheduled action (UTC).
     *
     * @return the endDate value.
     */
    public OffsetDateTime endDate() {
        return this.endDate;
    }

    /**
     * Set the endDate property: The end date and time of the scheduled action (UTC).
     *
     * @param endDate the endDate value to set.
     * @return the ScheduleProperties object itself.
     */
    public ScheduleProperties withEndDate(OffsetDateTime endDate) {
        this.endDate = endDate;
        return this;
    }

    /**
     * Validates the instance.
     *
     * @throws IllegalArgumentException thrown if the instance is not valid.
     */
    public void validate() {
        if (frequency() == null) {
            throw LOGGER
                .logExceptionAsError(
                    new IllegalArgumentException("Missing required property frequency in model ScheduleProperties"));
        }
        if (startDate() == null) {
            throw LOGGER
                .logExceptionAsError(
                    new IllegalArgumentException("Missing required property startDate in model ScheduleProperties"));
        }
        if (endDate() == null) {
            throw LOGGER
                .logExceptionAsError(
                    new IllegalArgumentException("Missing required property endDate in model ScheduleProperties"));
        }
    }

    private static final ClientLogger LOGGER = new ClientLogger(ScheduleProperties.class);
}