com.azure.resourcemanager.automation.models.JobSchedule Maven / Gradle / Ivy

Go to download
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.automation.models;

import com.azure.core.util.Context;
import com.azure.resourcemanager.automation.fluent.models.JobScheduleInner;
import java.util.Map;

/**
 * An immutable client-side representation of JobSchedule.
 */
public interface JobSchedule {
    /**
     * Gets the id property: Gets the id of the resource.
     * 
     * @return the id value.
     */
    String id();

    /**
     * Gets the name property: Gets the name of the variable.
     * 
     * @return the name value.
     */
    String name();

    /**
     * Gets the type property: Resource type.
     * 
     * @return the type value.
     */
    String type();

    /**
     * Gets the jobScheduleId property: Gets or sets the id of job schedule.
     * 
     * @return the jobScheduleId value.
     */
    String jobScheduleId();

    /**
     * Gets the schedule property: Gets or sets the schedule.
     * 
     * @return the schedule value.
     */
    ScheduleAssociationProperty schedule();

    /**
     * Gets the runbook property: Gets or sets the runbook.
     * 
     * @return the runbook value.
     */
    RunbookAssociationProperty runbook();

    /**
     * Gets the runOn property: Gets or sets the hybrid worker group that the scheduled job should run on.
     * 
     * @return the runOn value.
     */
    String runOn();

    /**
     * Gets the parameters property: Gets or sets the parameters of the job schedule.
     * 
     * @return the parameters value.
     */
    Map parameters();

    /**
     * Gets the inner com.azure.resourcemanager.automation.fluent.models.JobScheduleInner object.
     * 
     * @return the inner object.
     */
    JobScheduleInner innerModel();

    /**
     * The entirety of the JobSchedule definition.
     */
    interface Definition extends DefinitionStages.Blank, DefinitionStages.WithParentResource,
        DefinitionStages.WithSchedule, DefinitionStages.WithRunbook, DefinitionStages.WithCreate {
    }

    /**
     * The JobSchedule definition stages.
     */
    interface DefinitionStages {
        /**
         * The first stage of the JobSchedule definition.
         */
        interface Blank extends WithParentResource {
        }

        /**
         * The stage of the JobSchedule definition allowing to specify parent resource.
         */
        interface WithParentResource {
            /**
             * Specifies resourceGroupName, automationAccountName.
             * 
             * @param resourceGroupName Name of an Azure Resource group.
             * @param automationAccountName The name of the automation account.
             * @return the next definition stage.
             */
            WithSchedule withExistingAutomationAccount(String resourceGroupName, String automationAccountName);
        }

        /**
         * The stage of the JobSchedule definition allowing to specify schedule.
         */
        interface WithSchedule {
            /**
             * Specifies the schedule property: Gets or sets the schedule..
             * 
             * @param schedule Gets or sets the schedule.
             * @return the next definition stage.
             */
            WithRunbook withSchedule(ScheduleAssociationProperty schedule);
        }

        /**
         * The stage of the JobSchedule definition allowing to specify runbook.
         */
        interface WithRunbook {
            /**
             * Specifies the runbook property: Gets or sets the runbook..
             * 
             * @param runbook Gets or sets the runbook.
             * @return the next definition stage.
             */
            WithCreate withRunbook(RunbookAssociationProperty runbook);
        }

        /**
         * The stage of the JobSchedule definition which contains all the minimum required properties for the resource
         * to be created, but also allows for any other optional properties to be specified.
         */
        interface WithCreate extends DefinitionStages.WithRunOn, DefinitionStages.WithParameters {
            /**
             * Executes the create request.
             * 
             * @return the created resource.
             */
            JobSchedule create();

            /**
             * Executes the create request.
             * 
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            JobSchedule create(Context context);
        }

        /**
         * The stage of the JobSchedule definition allowing to specify runOn.
         */
        interface WithRunOn {
            /**
             * Specifies the runOn property: Gets or sets the hybrid worker group that the scheduled job should run on..
             * 
             * @param runOn Gets or sets the hybrid worker group that the scheduled job should run on.
             * @return the next definition stage.
             */
            WithCreate withRunOn(String runOn);
        }

        /**
         * The stage of the JobSchedule definition allowing to specify parameters.
         */
        interface WithParameters {
            /**
             * Specifies the parameters property: Gets or sets a list of job properties..
             * 
             * @param parameters Gets or sets a list of job properties.
             * @return the next definition stage.
             */
            WithCreate withParameters(Map parameters);
        }
    }

    /**
     * Refreshes the resource to sync with Azure.
     * 
     * @return the refreshed resource.
     */
    JobSchedule refresh();

    /**
     * Refreshes the resource to sync with Azure.
     * 
     * @param context The context to associate with this operation.
     * @return the refreshed resource.
     */
    JobSchedule refresh(Context context);
}