CloudJobSchedule Class

Package:

com.microsoft.azure.batch.protocol.models

• java.lang.Object
• • com.microsoft.azure.batch.protocol.models.CloudJobSchedule

public class CloudJobSchedule

A job schedule that allows recurring jobs by specifying when to run jobs and a specification used to create each job.

Method Summary

Modifier and Type	Method and Description
DateTime	creationTime() Get the creationTime value.
String	displayName() Get the displayName value.
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.
JobScheduleExecutionInformation	executionInfo() Get the executionInfo value.
String	id() Get the id value.
JobSpecification	jobSpecification() Get the jobSpecification value.
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.
List<MetadataItem>	metadata() Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code.
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'.
DateTime	previousStateTransitionTime() Get this property is not present if the job schedule is in its initial active state.
Schedule	schedule() Get the schedule value.
JobScheduleState	state() Get possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'.
DateTime	stateTransitionTime() Get the stateTransitionTime value.
JobScheduleStatistics	stats() Get the stats value.
String	url() Get the url value.
CloudJobSchedule	withCreationTime(DateTime creationTime) Set the creationTime value.
CloudJobSchedule	withDisplayName(String displayName) Set the displayName value.
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.
CloudJobSchedule	withExecutionInfo(JobScheduleExecutionInformation executionInfo) Set the executionInfo value.
CloudJobSchedule	withId(String id) Set the id value.
CloudJobSchedule	withJobSpecification(JobSpecification jobSpecification) Set the jobSpecification value.
CloudJobSchedule	withLastModified(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.
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.
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'.
CloudJobSchedule	withPreviousStateTransitionTime(DateTime previousStateTransitionTime) Set this property is not present if the job schedule is in its initial active state.
CloudJobSchedule	withSchedule(Schedule schedule) Set the schedule value.
CloudJobSchedule	withState(JobScheduleState state) Set possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'.
CloudJobSchedule	withStateTransitionTime(DateTime stateTransitionTime) Set the stateTransitionTime value.
CloudJobSchedule	withStats(JobScheduleStatistics stats) Set the stats value.
CloudJobSchedule	withUrl(String url) Set the url value.

Method Details

creationTime

public DateTime creationTime()

Get the creationTime value.

Returns:

the creationTime value

displayName

public String displayName()

Get the displayName value.

Returns:

the displayName value

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

executionInfo

public JobScheduleExecutionInformation executionInfo()

Get the executionInfo value.

Returns:

the executionInfo value

id

public String id()

Get the id value.

Returns:

the id value

jobSpecification

public JobSpecification jobSpecification()

Get the jobSpecification value.

Returns:

the jobSpecification value

lastModified

public 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

metadata

public List 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

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

previousStateTransitionTime

public DateTime previousStateTransitionTime()

Get this property is not present if the job schedule is in its initial active state.

Returns:

the previousStateTransitionTime value

schedule

public Schedule schedule()

Get the schedule value.

Returns:

the schedule value

state

public JobScheduleState state()

Get possible values include: 'active', 'completed', 'disabled', 'terminating', 'deleting'.

Returns:

the state value

stateTransitionTime

public DateTime stateTransitionTime()

Get the stateTransitionTime value.

Returns:

the stateTransitionTime value

stats

public JobScheduleStatistics stats()

Get the stats value.

Returns:

the stats value

url

public String url()

Get the url value.

Returns:

the url value

withCreationTime

public CloudJobSchedule withCreationTime(DateTime creationTime)

Set the creationTime value.

Parameters:

creationTime - the creationTime value to set

Returns:

the CloudJobSchedule object itself.

withDisplayName

public CloudJobSchedule withDisplayName(String displayName)

Set the displayName value.

Parameters:

displayName - the displayName value to set

Returns:

the CloudJobSchedule object itself.

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.

withExecutionInfo

public CloudJobSchedule withExecutionInfo(JobScheduleExecutionInformation executionInfo)

Set the executionInfo value.

Parameters:

executionInfo - the executionInfo value to set

Returns:

the CloudJobSchedule object itself.

withId

public CloudJobSchedule withId(String id)

Set the id value.

Parameters:

id - the id value to set

Returns:

the CloudJobSchedule object itself.

withJobSpecification

public CloudJobSchedule withJobSpecification(JobSpecification jobSpecification)

Set the jobSpecification value.

Parameters:

jobSpecification - the jobSpecification value to set

Returns:

the CloudJobSchedule object itself.

withLastModified

public CloudJobSchedule withLastModified(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.

withMetadata

public CloudJobSchedule withMetadata(List 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.

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.

withPreviousStateTransitionTime

public CloudJobSchedule withPreviousStateTransitionTime(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.

withSchedule

public CloudJobSchedule withSchedule(Schedule schedule)

Set the schedule value.

Parameters:

schedule - the schedule value to set

Returns:

the CloudJobSchedule object itself.

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.

withStateTransitionTime

public CloudJobSchedule withStateTransitionTime(DateTime stateTransitionTime)

Set the stateTransitionTime value.

Parameters:

stateTransitionTime - the stateTransitionTime 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.

withUrl

public CloudJobSchedule withUrl(String url)

Set the url value.

Parameters:

url - the url value to set

Returns:

the CloudJobSchedule object itself.