Package com.microsoft.azure.batch.protocol.models

Class CloudJobSchedule

  • public class CloudJobSchedule
extends Object
    A Job Schedule that allows recurring Jobs by specifying when to run Jobs and a specification used to create each Job.

    • Constructor Detail

      • CloudJobSchedule

        public CloudJobSchedule()

    • Method Detail

      • id

        public String id()
        Get the id value.
        Returns:
        the id value

      • withId

        public CloudJobSchedule withId​(String id)
        Set the id value.
        Parameters:
        id - the id value to set
        Returns:
        the CloudJobSchedule object itself.

      • displayName

        public String displayName()
        Get the displayName value.
        Returns:
        the displayName value

      • withDisplayName

        public CloudJobSchedule withDisplayName​(String displayName)
        Set the displayName value.
        Parameters:
        displayName - the displayName value to set
        Returns:
        the CloudJobSchedule object itself.

      • url

        public String url()
        Get the url value.
        Returns:
        the url value

      • withUrl

        public CloudJobSchedule withUrl​(String url)
        Set the url value.
        Parameters:
        url - the url value to set
        Returns:
        the CloudJobSchedule object itself.

      • eTag

        public String eTag()
        Get this is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime.
        Returns:
        the eTag value

      • withETag

        public CloudJobSchedule withETag​(String eTag)
        Set this is an opaque string. You can use it to detect whether the Job Schedule has changed between requests. In particular, you can be pass the ETag with an Update Job Schedule request to specify that your changes should take effect only if nobody else has modified the schedule in the meantime.
        Parameters:
        eTag - the eTag value to set
        Returns:
        the CloudJobSchedule object itself.

      • lastModified

        public org.joda.time.DateTime lastModified()
        Get this is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state.
        Returns:
        the lastModified value

      • withLastModified

        public CloudJobSchedule withLastModified​(org.joda.time.DateTime lastModified)
        Set this is the last time at which the schedule level data, such as the Job specification or recurrence information, changed. It does not factor in job-level changes such as new Jobs being created or Jobs changing state.
        Parameters:
        lastModified - the lastModified value to set
        Returns:
        the CloudJobSchedule object itself.

      • creationTime

        public org.joda.time.DateTime creationTime()
        Get the creationTime value.
        Returns:
        the creationTime value

      • withCreationTime

        public CloudJobSchedule withCreationTime​(org.joda.time.DateTime creationTime)
        Set the creationTime value.
        Parameters:
        creationTime - the creationTime value to set
        Returns:
        the CloudJobSchedule object itself.

      • state

        public JobScheduleState state()
        Get possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'.
        Returns:
        the state value

      • withState

        public CloudJobSchedule withState​(JobScheduleState state)
        Set possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'.
        Parameters:
        state - the state value to set
        Returns:
        the CloudJobSchedule object itself.

      • stateTransitionTime

        public org.joda.time.DateTime stateTransitionTime()
        Get the stateTransitionTime value.
        Returns:
        the stateTransitionTime value

      • withStateTransitionTime

        public CloudJobSchedule withStateTransitionTime​(org.joda.time.DateTime stateTransitionTime)
        Set the stateTransitionTime value.
        Parameters:
        stateTransitionTime - the stateTransitionTime value to set
        Returns:
        the CloudJobSchedule object itself.

      • previousState

        public JobScheduleState previousState()
        Get this property is not present if the Job Schedule is in its initial active state. Possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'.
        Returns:
        the previousState value

      • withPreviousState

        public CloudJobSchedule withPreviousState​(JobScheduleState previousState)
        Set this property is not present if the Job Schedule is in its initial active state. Possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'.
        Parameters:
        previousState - the previousState value to set
        Returns:
        the CloudJobSchedule object itself.

      • previousStateTransitionTime

        public org.joda.time.DateTime previousStateTransitionTime()
        Get this property is not present if the Job Schedule is in its initial active state.
        Returns:
        the previousStateTransitionTime value

      • withPreviousStateTransitionTime

        public CloudJobSchedule withPreviousStateTransitionTime​(org.joda.time.DateTime previousStateTransitionTime)
        Set this property is not present if the Job Schedule is in its initial active state.
        Parameters:
        previousStateTransitionTime - the previousStateTransitionTime value to set
        Returns:
        the CloudJobSchedule object itself.

      • schedule

        public Schedule schedule()
        Get the schedule value.
        Returns:
        the schedule value

      • withSchedule

        public CloudJobSchedule withSchedule​(Schedule schedule)
        Set the schedule value.
        Parameters:
        schedule - the schedule value to set
        Returns:
        the CloudJobSchedule object itself.

      • jobSpecification

        public JobSpecification jobSpecification()
        Get the jobSpecification value.
        Returns:
        the jobSpecification value

      • withJobSpecification

        public CloudJobSchedule withJobSpecification​(JobSpecification jobSpecification)
        Set the jobSpecification value.
        Parameters:
        jobSpecification - the jobSpecification value to set
        Returns:
        the CloudJobSchedule object itself.

      • withExecutionInfo

        public CloudJobSchedule withExecutionInfo​(JobScheduleExecutionInformation executionInfo)
        Set the executionInfo value.
        Parameters:
        executionInfo - the executionInfo value to set
        Returns:
        the CloudJobSchedule object itself.

      • metadata

        public List<MetadataItem> metadata()
        Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code.
        Returns:
        the metadata value

      • withMetadata

        public CloudJobSchedule withMetadata​(List<MetadataItem> metadata)
        Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code.
        Parameters:
        metadata - the metadata value to set
        Returns:
        the CloudJobSchedule object itself.

      • withStats

        public CloudJobSchedule withStats​(JobScheduleStatistics stats)
        Set the stats value.
        Parameters:
        stats - the stats value to set
        Returns:
        the CloudJobSchedule object itself.