CandidateMetadata Class

Candidate metadata returned by GET /candidates/{id}.

Constructor

CandidateMetadata(*args: Any, **kwargs: Any)

Variables

Name	Description
candidate_id	str Server-assigned candidate identifier. Required.
job_id	str Owning optimization job id. Required.
candidate_name	str Display name of the candidate. Required.
status	str Candidate lifecycle status. Required.
score	float Candidate's aggregate score.
has_results	bool Whether detailed results are available for this candidate. Required.
created_at	datetime Timestamp when the candidate was created, represented in Unix time. Required.
updated_at	datetime Timestamp when the candidate was last updated, represented in Unix time. Required.
promotion	PromotionInfo Promotion metadata. Null if not promoted.
files	list[CandidateFileInfo] Files in the candidate's blob directory. Required.

Methods

as_dict	Return a dict that can be turned into json using json.dump.
clear	Remove all items from D.
copy
get	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
items
keys
pop	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.
popitem	Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
setdefault	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
update	Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
values

as_dict

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

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

Keyword-Only Parameters

Name	Description
exclude_readonly	bool Whether to remove the readonly properties. Default value: False

Returns

Type	Description
dict	A dict JSON compatible object

clear

Remove all items from D.

clear() -> None

copy

copy() -> Model

get

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

Name	Description
key Required
default	Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type	Description
ItemsView	set-like object providing a view on D's items

keys

keys() -> KeysView[str]

Returns

Type	Description
KeysView	a set-like object providing a view on D's keys

pop

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

Name	Description
key Required
default

popitem

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

popitem() -> tuple[str, Any]

setdefault

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

Name	Description
key Required
default

update

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

values() -> ValuesView[Any]

Returns

Type	Description
ValuesView	an object providing a view on D's values

Attributes

candidate_id

Server-assigned candidate identifier. Required.

candidate_id: str

candidate_name

Display name of the candidate. Required.

candidate_name: str

created_at

Timestamp when the candidate was created, represented in Unix time. Required.

created_at: datetime

files

Files in the candidate's blob directory. Required.

files: list['_models.CandidateFileInfo']

has_results

Whether detailed results are available for this candidate. Required.

has_results: bool

job_id

Owning optimization job id. Required.

job_id: str

promotion

Promotion metadata. Null if not promoted.

promotion: _models.PromotionInfo | None

score

Candidate's aggregate score.

score: float | None

status

Candidate lifecycle status. Required.

status: str

updated_at

Timestamp when the candidate was last updated, represented in Unix time. Required.

updated_at: datetime