BatchJobSchedule Class

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Returns

Remove all items from D.

clear() -> None

copy() -> Model

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

items() -> ItemsView[str, Any]

Returns

keys() -> KeysView[str]

Returns

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.

popitem() -> tuple[str, Any]

Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values() -> ValuesView[Any]

Returns

The creation time of the Job Schedule. Required.

creation_time: datetime

The display name for the schedule.

display_name: str | None

The ETag of the Job Schedule. 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. Required.

etag: str

Information about Jobs that have been and will be run under this schedule. Required.

execution_info: _models.BatchJobScheduleExecutionInfo

A string that uniquely identifies the schedule within the Account. Required.

id: str

The lifetime resource usage statistics for the Job Schedule. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

job_schedule_statistics: _models.BatchJobScheduleStatistics | None

The details of the Jobs to be created on this schedule. Required.

job_specification: _models.BatchJobSpecification

The last modified time of the Job Schedule. 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. Required.

last_modified: datetime

A list of name-value pairs associated with the schedule as metadata. The Batch service does not assign any meaning to metadata; it is solely for the use of user code.

metadata: list['_models.BatchMetadataItem'] | None

The previous state of the Job Schedule. This property is not present if the Job Schedule is in its initial active state. Known values are: "active", "completed", "disabled", "terminating", and "deleting".

previous_state: str | _models.BatchJobScheduleState | None

The time at which the Job Schedule entered its previous state. This property is not present if the Job Schedule is in its initial active state.

previous_state_transition_time: datetime | None

The schedule according to which Jobs will be created. All times are fixed respective to UTC and are not impacted by daylight saving time.

schedule: _models.BatchJobScheduleConfiguration | None

"active", "completed", "disabled", "terminating", and "deleting".

state: str | _models.BatchJobScheduleState

The time at which the Job Schedule entered the current state. Required.

state_transition_time: datetime

The URL of the Job Schedule. Required.

url: str