Skip to content

flywheel.models.batch

Batch

Bases: BatchMixin

config property writable

Gets the config of this Batch.

Returns:

Type Description
dict(str, object)

The config of this Batch

created property writable

Gets the created of this Batch.

Creation time (automatically set)

Returns:

Type Description
datetime

The created of this Batch

gear_id property writable

Gets the gear_id of this Batch.

Returns:

Type Description
str

The gear_id of this Batch

id property writable

Gets the id of this Batch.

Unique database ID

Returns:

Type Description
str

The id of this Batch

jobs property writable

Gets the jobs of this Batch.

Returns:

Type Description
list[str]

The jobs of this Batch

modified property writable

Gets the modified of this Batch.

Last modification time (automatically updated)

Returns:

Type Description
datetime

The modified of this Batch

origin property writable

Gets the origin of this Batch.

Returns:

Type Description
Origin

The origin of this Batch

state property writable

Gets the state of this Batch.

Returns:

Type Description
JobState

The state of this Batch

__contains__(key)

Checks if the given value is a key in this object

__eq__(other)

Returns true if both objects are equal

__getitem__(key)

Returns the value of key

__init__(id=None, gear_id=None, state=None, origin=None, config=None, jobs=None, created=None, modified=None)

Batch - a model defined in Swagger

Parameters:

Name Type Description Default
id (str, optional)

Unique database ID, defaults to None

None
gear_id (str, optional)

, defaults to None

None
state (JobState, optional)

, defaults to None

None
origin (Origin, optional)

, defaults to None

None
config (dict(str, object), optional)

, defaults to None

None
jobs (list[str], optional)

, defaults to None

None
created (datetime, optional)

Creation time (automatically set), defaults to None

None
modified (datetime, optional)

Last modification time (automatically updated), defaults to None

None

__ne__(other)

Returns true if both objects are not equal

__repr__()

For print and pprint

__setitem__(key, value)

Sets the value of key

get(key, default=None)

Get the value of the provided json property, or default

items()

Returns the list of json property to value mapping

keys()

Returns the list of json properties in the object

positional_to_model(value) staticmethod

Converts a positional argument to a model value

return_value()

Unwraps return value from model

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

values()

Returns the list of values in the object