pyslurmutils.client.rest.api.v0_0_39.JobInfo

class pyslurmutils.client.rest.api.v0_0_39.JobInfo(**data)

Bases: BaseModel

Parameters:

data (Any)

account: Optional[str]

accrue_time: Optional[int]

admin_comment: Optional[str]

allocating_node: Optional[str]

array_job_id: Optional[Uint32NoVal]

array_max_tasks: Optional[Uint32NoVal]

array_task_id: Optional[Uint32NoVal]

array_task_string: Optional[str]

association_id: Optional[int]

batch_features: Optional[str]

batch_flag: Optional[bool]

batch_host: Optional[str]

billable_tres: Optional[Float64NoVal]

burst_buffer: Optional[str]

burst_buffer_state: Optional[str]

cluster: Optional[str]

cluster_features: Optional[str]

command: Optional[str]

comment: Optional[str]

classmethod construct(_fields_set=None, **values)

container: Optional[str]

container_id: Optional[str]

contiguous: Optional[bool]

copy(*, include=None, exclude=None, update=None, deep=False)

Returns a copy of the model.

!!! warning “Deprecated”

This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`python {test="skip" lint="skip"} data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Args:

include: Optional set or mapping specifying which fields to include in the copied model. exclude: Optional set or mapping specifying which fields to exclude in the copied model. update: Optional dictionary of field-value pairs to override field values in the copied model. deep: If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

Parameters:

• include (AbstractSetIntStr | MappingIntStrAny | None)

• exclude (AbstractSetIntStr | MappingIntStrAny | None)

• update (Dict[str, Any] | None)

• deep (bool)

Return type:

Self

core_spec: Optional[int]

cores_per_socket: Optional[Uint16NoVal]

cpu_frequency_governor: Optional[Uint32NoVal]

cpu_frequency_maximum: Optional[Uint32NoVal]

cpu_frequency_minimum: Optional[Uint32NoVal]

cpus: Optional[Uint32NoVal]

cpus_per_task: Optional[Uint16NoVal]

cpus_per_tres: Optional[str]

cron: Optional[str]

current_working_directory: Optional[str]

deadline: Optional[int]

delay_boot: Optional[Uint32NoVal]

dependency: Optional[str]

derived_exit_code: Optional[Uint32NoVal]

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)

eligible_time: Optional[int]

end_time: Optional[int]

excluded_nodes: Optional[str]

exclusive: Optional[List[str]]

exit_code: Optional[Uint32NoVal]

extra: Optional[str]

failed_node: Optional[str]

features: Optional[str]

federation_origin: Optional[str]

federation_siblings_active: Optional[str]

federation_siblings_viable: Optional[str]

flags: Optional[List[str]]

classmethod from_orm(obj)

Parameters:

obj (Any)

Return type:

Self

gres_detail: Optional[List[str]]

group_id: Optional[int]

group_name: Optional[str]

het_job_id: Optional[Uint32NoVal]

het_job_id_set: Optional[str]

het_job_offset: Optional[Uint32NoVal]

hold: Optional[bool]

job_id: Optional[int]

job_resources: Optional[JobRes]

job_size_str: Optional[List[str]]

job_state: Optional[str]

json(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False, encoder=PydanticUndefined, models_as_dict=PydanticUndefined, **dumps_kwargs)

last_sched_evaluation: Optional[int]

licenses: Optional[str]

mail_type: Optional[List[str]]

mail_user: Optional[str]

max_cpus: Optional[Uint32NoVal]

max_nodes: Optional[Uint32NoVal]

maximum_switch_wait_time: Optional[int]

mcs_label: Optional[str]

memory_per_cpu: Optional[Uint64NoVal]

memory_per_node: Optional[Uint64NoVal]

memory_per_tres: Optional[str]

minimum_cpus_per_node: Optional[Uint16NoVal]

minimum_switches: Optional[int]

minimum_tmp_disk_per_node: Optional[Uint32NoVal]

model_computed_fields = {}

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note

model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Args:

_fields_set: A set of field names that were originally explicitly set during instantiation. If provided,

this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.

values: Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

model_copy(*, update=None, deep=False)

!!! abstract “Usage Documentation”

[model_copy](../concepts/models.md#model-copy)

Returns a copy of the model.

!!! note

The underlying instance’s [__dict__][object.__dict__] attribute is copied. This might have unexpected side effects if you store anything in it, on top of the model fields (e.g. the value of [cached properties][functools.cached_property]).

Args:

update: Values to change/add in the new model. Note: the data is not validated

before creating the new model. You should trust this data.

deep: Set to True to make a deep copy of the model.

Returns:

New model instance.

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, exclude_computed_fields=False, round_trip=False, warnings=True, fallback=None, serialize_as_any=False)

!!! abstract “Usage Documentation”

[model_dump](../concepts/serialization.md#python-mode)

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Args:

mode: The mode in which to_python should run.

If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.

include: A set of fields to include in the output. exclude: A set of fields to exclude from the output. context: Additional context to pass to the serializer. by_alias: Whether to use the field’s alias in the dictionary key if defined. exclude_unset: Whether to exclude fields that have not been explicitly set. exclude_defaults: Whether to exclude fields that are set to their default value. exclude_none: Whether to exclude fields that have a value of None. exclude_computed_fields: Whether to exclude computed fields.

While this can be useful for round-tripping, it is usually recommended tu use the dedicated round_trip parameter instead.

round_trip: If True, dumped values should be valid as input for non-idempotent types such as Json[T]. warnings: How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,

“error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].

fallback: A function to call when an unknown value is encountered. If not provided,

a [PydanticSerializationError][pydantic_core.PydanticSerializationError] error is raised.

serialize_as_any: Whether to serialize fields with duck-typing serialization behavior.

Returns:

A dictionary representation of the model.

model_dump_json(*, indent=None, ensure_ascii=False, include=None, exclude=None, context=None, by_alias=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, exclude_computed_fields=False, round_trip=False, warnings=True, fallback=None, serialize_as_any=False)

!!! abstract “Usage Documentation”

[model_dump_json](../concepts/serialization.md#json-mode)

Generates a JSON representation of the model using Pydantic’s to_json method.

Args:

indent: Indentation to use in the JSON output. If None is passed, the output will be compact. ensure_ascii: If True, the output is guaranteed to have all incoming non-ASCII characters escaped.

If False (the default), these characters will be output as-is.

include: Field(s) to include in the JSON output. exclude: Field(s) to exclude from the JSON output. context: Additional context to pass to the serializer. by_alias: Whether to serialize using field aliases. exclude_unset: Whether to exclude fields that have not been explicitly set. exclude_defaults: Whether to exclude fields that are set to their default value. exclude_none: Whether to exclude fields that have a value of None. exclude_computed_fields: Whether to exclude computed fields.

While this can be useful for round-tripping, it is usually recommended to use the dedicated round_trip parameter instead.

round_trip: If True, dumped values should be valid as input for non-idempotent types such as Json[T]. warnings: How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors,

“error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].

fallback: A function to call when an unknown value is encountered. If not provided,

a [PydanticSerializationError][pydantic_core.PydanticSerializationError] error is raised.

serialize_as_any: Whether to serialize fields with duck-typing serialization behavior.

Returns:

A JSON string representation of the model.

property model_extra

Get extra fields set during validation.

Returns:

A dictionary of extra fields, or None if config.extra is not set to “allow”.

model_fields = {'account': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Account'), 'accrue_time': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Accrue Time'), 'admin_comment': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Admin Comment'), 'allocating_node': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Allocating Node'), 'array_job_id': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'array_max_tasks': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'array_task_id': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'array_task_string': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Array Task String'), 'association_id': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Association Id'), 'batch_features': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Batch Features'), 'batch_flag': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, title='Batch Flag'), 'batch_host': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Batch Host'), 'billable_tres': FieldInfo(annotation=Union[Float64NoVal, NoneType], required=False, default=None, title='64 bit floating point number with flags'), 'burst_buffer': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Burst Buffer'), 'burst_buffer_state': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Burst Buffer State'), 'cluster': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Cluster'), 'cluster_features': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Cluster Features'), 'command': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Command'), 'comment': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Comment'), 'container': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Container'), 'container_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Container Id'), 'contiguous': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, title='Contiguous'), 'core_spec': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Core Spec'), 'cores_per_socket': FieldInfo(annotation=Union[Uint16NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'cpu_frequency_governor': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'cpu_frequency_maximum': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'cpu_frequency_minimum': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'cpus': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'cpus_per_task': FieldInfo(annotation=Union[Uint16NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'cpus_per_tres': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Cpus Per Tres'), 'cron': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Cron'), 'current_working_directory': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Current Working Directory'), 'deadline': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Deadline'), 'delay_boot': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'dependency': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Dependency'), 'derived_exit_code': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'eligible_time': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Eligible Time'), 'end_time': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='End Time'), 'excluded_nodes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Excluded Nodes'), 'exclusive': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None, title='Exclusive'), 'exit_code': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'extra': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Extra'), 'failed_node': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Failed Node'), 'features': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Features'), 'federation_origin': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Federation Origin'), 'federation_siblings_active': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Federation Siblings Active'), 'federation_siblings_viable': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Federation Siblings Viable'), 'flags': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None, title='Flags'), 'gres_detail': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None, title='Gres Detail'), 'group_id': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Group Id'), 'group_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Group Name'), 'het_job_id': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'het_job_id_set': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Het Job Id Set'), 'het_job_offset': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'hold': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, title='Hold (true) or release (false) job'), 'job_id': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Job Id'), 'job_resources': FieldInfo(annotation=Union[JobRes, NoneType], required=False, default=None, title='Job res'), 'job_size_str': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None, title='Job Size Str'), 'job_state': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Job State'), 'last_sched_evaluation': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Last Sched Evaluation'), 'licenses': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Licenses'), 'mail_type': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None, title='Mail Type'), 'mail_user': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Mail User'), 'max_cpus': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'max_nodes': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'maximum_switch_wait_time': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Maximum Switch Wait Time'), 'mcs_label': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Mcs Label'), 'memory_per_cpu': FieldInfo(annotation=Union[Uint64NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'memory_per_node': FieldInfo(annotation=Union[Uint64NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'memory_per_tres': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Memory Per Tres'), 'minimum_cpus_per_node': FieldInfo(annotation=Union[Uint16NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'minimum_switches': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Minimum Switches'), 'minimum_tmp_disk_per_node': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Name'), 'network': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Network'), 'nice': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Nice'), 'node_count': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'nodes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Nodes'), 'oversubscribe': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, title='Oversubscribe'), 'partition': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Partition'), 'power': FieldInfo(annotation=Union[JobInfoPower, NoneType], required=False, default=None, title='Job info power'), 'pre_sus_time': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Pre Sus Time'), 'preempt_time': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Preempt Time'), 'preemptable_time': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Preemptable Time'), 'prefer': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Prefer'), 'priority': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Request specific job priority'), 'profile': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None, title='Profile'), 'qos': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Qos'), 'reboot': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, title='Reboot'), 'requeue': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, title='Requeue'), 'required_nodes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Required Nodes'), 'resize_time': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Resize Time'), 'restart_cnt': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Restart Cnt'), 'resv_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Resv Name'), 'scheduled_nodes': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Scheduled Nodes'), 'selinux_context': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Selinux Context'), 'shared': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None, title='Shared'), 'show_flags': FieldInfo(annotation=Union[List[str], NoneType], required=False, default=None, title='Show Flags'), 'sockets_per_board': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Sockets Per Board'), 'sockets_per_node': FieldInfo(annotation=Union[Uint16NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'standard_error': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Standard Error'), 'standard_input': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Standard Input'), 'standard_output': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Standard Output'), 'start_time': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Start Time'), 'state_description': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='State Description'), 'state_reason': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='State Reason'), 'submit_time': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Submit Time'), 'suspend_time': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Suspend Time'), 'system_comment': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='System Comment'), 'tasks': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'tasks_per_board': FieldInfo(annotation=Union[Uint16NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'tasks_per_core': FieldInfo(annotation=Union[Uint16NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'tasks_per_node': FieldInfo(annotation=Union[Uint16NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'tasks_per_socket': FieldInfo(annotation=Union[Uint16NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'tasks_per_tres': FieldInfo(annotation=Union[Uint16NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'thread_spec': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='Thread Spec'), 'threads_per_core': FieldInfo(annotation=Union[Uint16NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'time_limit': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'time_minimum': FieldInfo(annotation=Union[Uint32NoVal, NoneType], required=False, default=None, title='Integer number with flags'), 'tres_alloc_str': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Tres Alloc Str'), 'tres_bind': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Tres Bind'), 'tres_freq': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Tres Freq'), 'tres_per_job': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Tres Per Job'), 'tres_per_node': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Tres Per Node'), 'tres_per_socket': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Tres Per Socket'), 'tres_per_task': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Tres Per Task'), 'tres_req_str': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Tres Req Str'), 'user_id': FieldInfo(annotation=Union[int, NoneType], required=False, default=None, title='User Id'), 'user_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='User Name'), 'wckey': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, title='Wckey')}

property model_fields_set: set[str]

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,

i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation', *, union_format='any_of')

Generates a JSON schema for a model class.

Args:

by_alias: Whether to use attribute aliases or not. ref_template: The reference template. union_format: The format to use when combining schemas from unions together. Can be one of:

• ‘any_of’: Use the [anyOf](https://json-schema.org/understanding-json-schema/reference/combining#anyOf)

keyword to combine schemas (the default). - ‘primitive_type_array’: Use the [type](https://json-schema.org/understanding-json-schema/reference/type) keyword as an array of strings, containing each type of the combination. If any of the schemas is not a primitive type (string, boolean, null, integer or number) or contains constraints/metadata, falls back to any_of.

schema_generator: To override the logic used to generate the JSON schema, as a subclass of

GenerateJsonSchema with your desired modifications

mode: The mode in which to generate the schema.

Returns:

The JSON schema for the given model class.

Parameters:

• by_alias (bool)

• ref_template (str)

• schema_generator (type[GenerateJsonSchema])

• mode (Literal['validation', 'serialization'])

• union_format (Literal['any_of', 'primitive_type_array'])

Return type:

dict[str, Any]

classmethod model_parametrized_name(params)

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Args:

params: Tuple of types of the class. Given a generic class

Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.

Returns:

String representing the new class where params are passed to cls as type variables.

Raises:

TypeError: Raised when trying to generate concrete names for non-generic models.

Parameters:

params (tuple[type[Any], ...])

Return type:

str

model_post_init(context, /)

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

Parameters:

context (Any)

Return type:

None

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)

Try to rebuild the pydantic-core schema for the model.

This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.

Args:

force: Whether to force the rebuilding of the model schema, defaults to False. raise_errors: Whether to raise errors, defaults to True. _parent_namespace_depth: The depth level of the parent namespace, defaults to 2. _types_namespace: The types namespace, defaults to None.

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

classmethod model_validate(obj, *, strict=None, extra=None, from_attributes=None, context=None, by_alias=None, by_name=None)

Validate a pydantic model instance.

Args:

obj: The object to validate. strict: Whether to enforce types strictly. extra: Whether to ignore, allow, or forbid extra data during model validation.

See the [extra configuration value][pydantic.ConfigDict.extra] for details.

from_attributes: Whether to extract data from object attributes. context: Additional context to pass to the validator. by_alias: Whether to use the field’s alias when validating against the provided input data. by_name: Whether to use the field’s name when validating against the provided input data.

Raises:

ValidationError: If the object could not be validated.

Returns:

The validated model instance.

classmethod model_validate_json(json_data, *, strict=None, extra=None, context=None, by_alias=None, by_name=None)

!!! abstract “Usage Documentation”

[JSON Parsing](../concepts/json.md#json-parsing)

Validate the given JSON data against the Pydantic model.

Args:

json_data: The JSON data to validate. strict: Whether to enforce types strictly. extra: Whether to ignore, allow, or forbid extra data during model validation.

See the [extra configuration value][pydantic.ConfigDict.extra] for details.

context: Extra variables to pass to the validator. by_alias: Whether to use the field’s alias when validating against the provided input data. by_name: Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

Raises:

ValidationError: If json_data is not a JSON string or the object could not be validated.

classmethod model_validate_strings(obj, *, strict=None, extra=None, context=None, by_alias=None, by_name=None)

Validate the given object with string data against the Pydantic model.

Args:

obj: The object containing string data to validate. strict: Whether to enforce types strictly. extra: Whether to ignore, allow, or forbid extra data during model validation.

See the [extra configuration value][pydantic.ConfigDict.extra] for details.

context: Extra variables to pass to the validator. by_alias: Whether to use the field’s alias when validating against the provided input data. by_name: Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

name: Optional[str]

network: Optional[str]

nice: Optional[int]

node_count: Optional[Uint32NoVal]

nodes: Optional[str]

oversubscribe: Optional[bool]

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)

classmethod parse_obj(obj)

Parameters:

obj (Any)

Return type:

Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)

partition: Optional[str]

power: Optional[JobInfoPower]

pre_sus_time: Optional[int]

preempt_time: Optional[int]

preemptable_time: Optional[int]

prefer: Optional[str]

priority: Optional[Uint32NoVal]

profile: Optional[List[str]]

qos: Optional[str]

reboot: Optional[bool]

requeue: Optional[bool]

required_nodes: Optional[str]

resize_time: Optional[int]

restart_cnt: Optional[int]

resv_name: Optional[str]

scheduled_nodes: Optional[str]

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')

Parameters:

• by_alias (bool)

• ref_template (str)

Return type:

Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)

Parameters:

• by_alias (bool)

• ref_template (str)

• dumps_kwargs (Any)

Return type:

str

selinux_context: Optional[str]

shared: Optional[List[str]]

show_flags: Optional[List[str]]

sockets_per_board: Optional[int]

sockets_per_node: Optional[Uint16NoVal]

standard_error: Optional[str]

standard_input: Optional[str]

standard_output: Optional[str]

start_time: Optional[int]

state_description: Optional[str]

state_reason: Optional[str]

submit_time: Optional[int]

suspend_time: Optional[int]

system_comment: Optional[str]

tasks: Optional[Uint32NoVal]

tasks_per_board: Optional[Uint16NoVal]

tasks_per_core: Optional[Uint16NoVal]

tasks_per_node: Optional[Uint16NoVal]

tasks_per_socket: Optional[Uint16NoVal]

tasks_per_tres: Optional[Uint16NoVal]

thread_spec: Optional[int]

threads_per_core: Optional[Uint16NoVal]

time_limit: Optional[Uint32NoVal]

time_minimum: Optional[Uint32NoVal]

tres_alloc_str: Optional[str]

tres_bind: Optional[str]

tres_freq: Optional[str]

tres_per_job: Optional[str]

tres_per_node: Optional[str]

tres_per_socket: Optional[str]

tres_per_task: Optional[str]

tres_req_str: Optional[str]

classmethod update_forward_refs(**localns)

Parameters:

localns (Any)

Return type:

None

user_id: Optional[int]

user_name: Optional[str]

classmethod validate(value)

Parameters:

value (Any)

Return type:

Self

wckey: Optional[str]