JobScheduleAddParameter Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.JobScheduleAddParameter

public class JobScheduleAddParameter

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
String displayName()

Get the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
String id()

Get the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).
JobSpecification jobSpecification()

Get the jobSpecification value.
List<MetadataItem> metadata()

Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code.
Schedule schedule()

Get the schedule value.
JobScheduleAddParameter withDisplayName(String displayName)

Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
JobScheduleAddParameter withId(String id)

Set the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).
JobScheduleAddParameter withJobSpecification(JobSpecification jobSpecification)

Set the jobSpecification value.
JobScheduleAddParameter withMetadata(List<MetadataItem> metadata)

Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code.
JobScheduleAddParameter withSchedule(Schedule schedule)

Set the schedule value.

Method Details

displayName

public String displayName()

Get the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

Returns:

the displayName value

id

public String id()

Get the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).

Returns:

the id value

jobSpecification

public JobSpecification jobSpecification()

Get the jobSpecification value.

Returns:

the jobSpecification 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

schedule

public Schedule schedule()

Get the schedule value.

Returns:

the schedule value

withDisplayName

public JobScheduleAddParameter withDisplayName(String displayName)

Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.

Parameters:

displayName - the displayName value to set

Returns:

the JobScheduleAddParameter object itself.

withId

public JobScheduleAddParameter withId(String id)

Set the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).

Parameters:

id - the id value to set

Returns:

the JobScheduleAddParameter object itself.

withJobSpecification

public JobScheduleAddParameter withJobSpecification(JobSpecification jobSpecification)

Set the jobSpecification value.

Parameters:

jobSpecification - the jobSpecification value to set

Returns:

the JobScheduleAddParameter object itself.

withMetadata

public JobScheduleAddParameter 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 JobScheduleAddParameter object itself.

withSchedule

public JobScheduleAddParameter withSchedule(Schedule schedule)

Set the schedule value.

Parameters:

schedule - the schedule value to set

Returns:

the JobScheduleAddParameter object itself.

Applies to