benchling_sdk.models package

class AIGGenerateInputAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, AutomationInputGenerator] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class AIGGenerateInputAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property errors: AsyncTaskErrors

Present only when status is FAILED for a bulk task. Contains information about the individual errors in the bulk task.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aig_generate_input_async_task.T

get(key, default=None) → Optional[Any]

property message: str

Present only when status is FAILED. Contains information about the error.

property response: AutomationInputGenerator

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class AOPProcessOutputAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Union[benchling_api_client.v2.types.Unset, AutomationOutputProcessor] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class AOPProcessOutputAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property errors: AsyncTaskErrors

Present only when status is FAILED for a bulk task. Contains information about the individual errors in the bulk task.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aop_process_output_async_task.T

get(key, default=None) → Optional[Any]

property message: str

Present only when status is FAILED. Contains information about the error.

property response: AutomationOutputProcessor

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class AaAnnotation

Bases: object

__init__(color: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_color'].default, end: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_end'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, start: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_start'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) → None

Method generated by attrs for class AaAnnotation.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property color: str

property end: int

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_annotation.T

get(key, default=None) → Optional[Any]

property id: str

property name: str

property start: int

to_dict() → Dict[str, Any]

property type: str

class AaSequence

Bases: object

__init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) → None

Method generated by attrs for class AaSequence.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property aliases: List[str]

Array of aliases

property amino_acids: str

Amino acids of the AA sequence.

property annotations: List[AaAnnotation]

Array of annotation objects on the AA sequence.

property api_url: str

The canonical url of the AA Sequence in the API.

property archive_record: Optional[ArchiveRecord]

property created_at: datetime

DateTime the AA sequence was created.

property creator: UserSummary

property custom_fields: CustomFields

property entity_registry_id: Optional[str]

Registry ID of the AA sequence if registered.

property fields: Fields

property folder_id: Optional[str]

ID of the folder that contains the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequence.T

get(key, default=None) → Optional[Any]

property id: str

ID of the AA sequence.

property length: int

Number of amino acids in the AA sequence.

property modified_at: datetime

DateTime the AA sequence was last modified.

property name: str

Name of the AA sequence.

property registration_origin: Optional[RegistrationOrigin]

property registry_id: Optional[str]

Registry the AA sequence is registered in.

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property web_url: str

URL of the protein.

class AaSequenceBaseRequest

Bases: object

__init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) → None

Method generated by attrs for class AaSequenceBaseRequest.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property aliases: List[str]

Aliases to add to the AA sequence

property amino_acids: str

Amino acids for the AA sequence.

property annotations: List[AaAnnotation]

Annotations to create on the AA sequence.

property author_ids: List[str]

IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields

property fields: Fields

property folder_id: str

ID of the folder containing the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequence_base_request.T

get(key, default=None) → Optional[Any]

property name: str

Name of the AA sequence.

property schema_id: str

ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]

class AaSequenceBaseRequestForCreate

Bases: object

__init__(aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) → None

Method generated by attrs for class AaSequenceBaseRequestForCreate.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property aliases: List[str]

Aliases to add to the AA sequence

property amino_acids: str

Amino acids for the AA sequence.

property annotations: List[AaAnnotation]

Annotations to create on the AA sequence.

property author_ids: List[str]

IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields

property fields: Fields

property folder_id: str

ID of the folder containing the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequence_base_request_for_create.T

get(key, default=None) → Optional[Any]

property name: str

Name of the AA sequence.

property schema_id: str

ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]

class AaSequenceBulkCreate

Bases: object

__init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) → None

Method generated by attrs for class AaSequenceBulkCreate.

property aliases: List[str]

Aliases to add to the AA sequence

property amino_acids: str

Amino acids for the AA sequence.

property annotations: List[AaAnnotation]

Annotations to create on the AA sequence.

property author_ids: List[str]

IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields

property entity_registry_id: str

Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.

property fields: Fields

property folder_id: str

ID of the folder containing the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequence_bulk_create.T

property name: str

Name of the AA sequence.

property naming_strategy: NamingStrategy

Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template

property registry_id: str

Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)

Required in order for entities to be created directly in the registry.

property schema_id: str

ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]

class AaSequenceBulkUpdate

Bases: object

__init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) → None

Method generated by attrs for class AaSequenceBulkUpdate.

property aliases: List[str]

Aliases to add to the AA sequence

property amino_acids: str

Amino acids for the AA sequence.

property annotations: List[AaAnnotation]

Annotations to create on the AA sequence.

property author_ids: List[str]

IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields

property fields: Fields

property folder_id: str

ID of the folder containing the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequence_bulk_update.T

property id: str

property name: str

Name of the AA sequence.

property schema_id: str

ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]

class AaSequenceCreate

Bases: object

__init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, naming_strategy: Union[benchling_api_client.v2.types.Unset, NamingStrategy] = attr_dict['_naming_strategy'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) → None

Method generated by attrs for class AaSequenceCreate.

property aliases: List[str]

Aliases to add to the AA sequence

property amino_acids: str

Amino acids for the AA sequence.

property annotations: List[AaAnnotation]

Annotations to create on the AA sequence.

property author_ids: List[str]

IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields

property entity_registry_id: str

Entity registry ID to set for the registered entity. Cannot specify both entityRegistryId and namingStrategy at the same time.

property fields: Fields

property folder_id: str

ID of the folder containing the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequence_create.T

property name: str

Name of the AA sequence.

property naming_strategy: NamingStrategy

Specifies the behavior for automatically generated names when registering an entity. - NEW_IDS: Generate new registry IDs - IDS_FROM_NAMES: Generate registry IDs based on entity names - DELETE_NAMES: Generate new registry IDs and replace name with registry ID - SET_FROM_NAME_PARTS: Generate new registry IDs, rename according to name template, and keep old name as alias - REPLACE_NAMES_FROM_PARTS: Generate new registry IDs, and replace name according to name template - KEEP_NAMES: Keep existing entity names as registry IDs - REPLACE_ID_AND_NAME_FROM_PARTS: Generate registry IDs and names according to name template

property registry_id: str

Registry ID into which entity should be registered. this is the ID of the registry which was configured for a particular organization To get available registryIds, use the [/registries endpoint](#/Registry/listRegistries)

Required in order for entities to be created directly in the registry.

property schema_id: str

ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]

class AaSequenceRequestRegistryFields

Bases: object

__init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default) → None

Method generated by attrs for class AaSequenceRequestRegistryFields.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entity_registry_id: str

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequence_request_registry_fields.T

get(key, default=None) → Optional[Any]

to_dict() → Dict[str, Any]

class AaSequenceSummary

Bases: object

__init__(entity_type: Union[benchling_api_client.v2.types.Unset, AaSequenceSummaryEntityType] = attr_dict['_entity_type'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) → None

Method generated by attrs for class AaSequenceSummary.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property entity_type: AaSequenceSummaryEntityType

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequence_summary.T

get(key, default=None) → Optional[Any]

property id: str

to_dict() → Dict[str, Any]

property type: str

class AaSequenceSummaryEntityType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

AA_SEQUENCE = 'aa_sequence'

static of_unknown(val: str) → AaSequenceSummaryEntityType

class AaSequenceUpdate

Bases: object

__init__(entity_registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_registry_id'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, author_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_author_ids'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_folder_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_schema_id'].default) → None

Method generated by attrs for class AaSequenceUpdate.

property aliases: List[str]

Aliases to add to the AA sequence

property amino_acids: str

Amino acids for the AA sequence.

property annotations: List[AaAnnotation]

Annotations to create on the AA sequence.

property author_ids: List[str]

IDs of users to set as the AA sequence’s authors.

property custom_fields: CustomFields

property entity_registry_id: str

property fields: Fields

property folder_id: str

ID of the folder containing the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequence_update.T

property name: str

Name of the AA sequence.

property schema_id: str

ID of the AA sequence’s schema.

to_dict() → Dict[str, Any]

class AaSequenceWithEntityType

Bases: object

__init__(entity_type: Union[benchling_api_client.v2.types.Unset, AaSequenceWithEntityTypeEntityType] = attr_dict['_entity_type'].default, aliases: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aliases'].default, amino_acids: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_amino_acids'].default, annotations: Union[benchling_api_client.v2.types.Unset, List[AaAnnotation]] = attr_dict['_annotations'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, UserSummary] = attr_dict['_creator'].default, custom_fields: Union[benchling_api_client.v2.types.Unset, CustomFields] = attr_dict['_custom_fields'].default, entity_registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entity_registry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, folder_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_folder_id'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, length: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_length'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, registration_origin: Union[benchling_api_client.v2.types.Unset, None, RegistrationOrigin] = attr_dict['_registration_origin'].default, registry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_registry_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, SchemaSummary] = attr_dict['_schema'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) → None

Method generated by attrs for class AaSequenceWithEntityType.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property aliases: List[str]

Array of aliases

property amino_acids: str

Amino acids of the AA sequence.

property annotations: List[AaAnnotation]

Array of annotation objects on the AA sequence.

property api_url: str

The canonical url of the AA Sequence in the API.

property archive_record: Optional[ArchiveRecord]

property created_at: datetime

DateTime the AA sequence was created.

property creator: UserSummary

property custom_fields: CustomFields

property entity_registry_id: Optional[str]

Registry ID of the AA sequence if registered.

property entity_type: AaSequenceWithEntityTypeEntityType

property fields: Fields

property folder_id: Optional[str]

ID of the folder that contains the AA sequence.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequence_with_entity_type.T

get(key, default=None) → Optional[Any]

property id: str

ID of the AA sequence.

property length: int

Number of amino acids in the AA sequence.

property modified_at: datetime

DateTime the AA sequence was last modified.

property name: str

Name of the AA sequence.

property registration_origin: Optional[RegistrationOrigin]

property registry_id: Optional[str]

Registry the AA sequence is registered in.

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property web_url: str

URL of the protein.

class AaSequenceWithEntityTypeEntityType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

AA_SEQUENCE = 'aa_sequence'

static of_unknown(val: str) → AaSequenceWithEntityTypeEntityType

class AaSequencesArchivalChange

Bases: object

IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of AA sequences along with any IDs of batches that were archived / unarchived.

__init__(aa_sequence_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_aa_sequence_ids'].default, batch_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_batch_ids'].default) → None

Method generated by attrs for class AaSequencesArchivalChange.

property aa_sequence_ids: List[str]

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property batch_ids: List[str]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequences_archival_change.T

get(key, default=None) → Optional[Any]

to_dict() → Dict[str, Any]

class AaSequencesArchive

Bases: object

The request body for archiving AA sequences.

__init__(aa_sequence_ids: List[str], reason: EntityArchiveReason) → None

Method generated by attrs for class AaSequencesArchive.

property aa_sequence_ids: List[str]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequences_archive.T

property reason: EntityArchiveReason

The reason for archiving the provided entities. Accepted reasons may differ based on tenant configuration.

to_dict() → Dict[str, Any]

class AaSequencesBulkCreateRequest

Bases: object

__init__(aa_sequences: Union[benchling_api_client.v2.types.Unset, List[AaSequenceBulkCreate]] = attr_dict['_aa_sequences'].default) → None

Method generated by attrs for class AaSequencesBulkCreateRequest.

property aa_sequences: List[AaSequenceBulkCreate]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequences_bulk_create_request.T

to_dict() → Dict[str, Any]

class AaSequencesBulkGet

Bases: object

__init__(aa_sequences: Union[benchling_api_client.v2.types.Unset, List[AaSequence]] = attr_dict['_aa_sequences'].default) → None

Method generated by attrs for class AaSequencesBulkGet.

property aa_sequences: List[AaSequence]

property additional_keys: List[str]

additional_properties: Dict[str, Any]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequences_bulk_get.T

get(key, default=None) → Optional[Any]

to_dict() → Dict[str, Any]

class AaSequencesBulkUpdateRequest

Bases: object

__init__(aa_sequences: Union[benchling_api_client.v2.types.Unset, List[AaSequenceBulkUpdate]] = attr_dict['_aa_sequences'].default) → None

Method generated by attrs for class AaSequencesBulkUpdateRequest.

property aa_sequences: List[AaSequenceBulkUpdate]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequences_bulk_update_request.T

to_dict() → Dict[str, Any]

class AaSequencesPaginatedList

Bases: object

__init__(aa_sequences: Union[benchling_api_client.v2.types.Unset, List[AaSequence]] = attr_dict['_aa_sequences'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) → None

Method generated by attrs for class AaSequencesPaginatedList.

property aa_sequences: List[AaSequence]

property additional_keys: List[str]

additional_properties: Dict[str, Any]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequences_paginated_list.T

get(key, default=None) → Optional[Any]

property next_token: str

to_dict() → Dict[str, Any]

class AaSequencesUnarchive

Bases: object

The request body for unarchiving AA sequences.

__init__(aa_sequence_ids: List[str]) → None

Method generated by attrs for class AaSequencesUnarchive.

property aa_sequence_ids: List[str]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aa_sequences_unarchive.T

to_dict() → Dict[str, Any]

class AlignedSequence

Bases: object

__init__(bases: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_bases'].default, dna_sequence_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_dna_sequence_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, pairwise_identity: Union[benchling_api_client.v2.types.Unset, float] = attr_dict['_pairwise_identity'].default, trim_end: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_trim_end'].default, trim_start: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_trim_start'].default) → None

Method generated by attrs for class AlignedSequence.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property bases: str

property dna_sequence_id: Optional[str]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.aligned_sequence.T

get(key, default=None) → Optional[Any]

property name: str

property pairwise_identity: float

Fraction of bases between trimStart and trimEnd that match the template bases. Only present for Template Alignments; Will be empty for Consensus Alignments.

to_dict() → Dict[str, Any]

property trim_end: int

property trim_start: int

class ArchiveRecord

Bases: object

__init__(reason: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_reason'].default) → None

Method generated by attrs for class ArchiveRecord.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.archive_record.T

get(key, default=None) → Optional[Any]

property reason: str

to_dict() → Dict[str, Any]

class AssayFieldsCreate

Bases: object

__init__() → None

Method generated by attrs for class AssayFieldsCreate.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_fields_create.T

get(key, default=None) → Optional[Any]

to_dict() → Dict[str, Any]

class AssayResult

Bases: object

__init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, UserSummary] = attr_dict['_creator'].default, entry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entry_id'].default, field_validation: Union[benchling_api_client.v2.types.Unset, AssayResultFieldValidation] = attr_dict['_field_validation'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_reviewed: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_reviewed'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, schema: Union[benchling_api_client.v2.types.Unset, SchemaSummary] = attr_dict['_schema'].default, validation_comment: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_validation_comment'].default, validation_status: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_validation_status'].default) → None

Method generated by attrs for class AssayResult.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

property created_at: datetime

DateTime at which the the result was created

property creator: UserSummary

property entry_id: Optional[str]

ID of the entry that this result is attached to

property field_validation: AssayResultFieldValidation

Object mapping field names to a UserValidation Resource object for that field. To set validation for a result, you must use this object.

property fields: Fields

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_result.T

get(key, default=None) → Optional[Any]

property id: str

ID of the result

property is_reviewed: bool

Whether or not this result is attached to an accepted entry

property project_id: Optional[str]

ID of the project to insert the result into

property schema: SchemaSummary

to_dict() → Dict[str, Any]

property validation_comment: str

property validation_status: str

class AssayResultCreate

Bases: object

__init__(fields: Union[Fields, AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType], schema_id: str, field_validation: Union[benchling_api_client.v2.types.Unset, AssayResultCreateFieldValidation] = attr_dict['_field_validation'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default) → None

Method generated by attrs for class AssayResultCreate.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property field_validation: AssayResultCreateFieldValidation

Dictionary mapping field names to UserValidation Resources.

property fields: Union[Fields, AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType]

Dictionary of result fields

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_result_create.T

get(key, default=None) → Optional[Any]

property id: str

UUID

property project_id: Optional[str]

The project that the assay result should be uploaded to. Only users with read access to the project will be able to read the assay result. Leaving this empty will result in only the creator having read access.

property schema_id: str

ID of result schema under which to upload this result

to_dict() → Dict[str, Any]

class AssayResultCreateFieldValidation

Bases: object

Dictionary mapping field names to UserValidation Resources.

__init__() → None

Method generated by attrs for class AssayResultCreateFieldValidation.

property additional_keys: List[str]

additional_properties: Dict[str, UserValidation]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_result_create_field_validation.T

get(key, default=None) → Optional[UserValidation]

to_dict() → Dict[str, Any]

class AssayResultFieldValidation

Bases: object

Object mapping field names to a UserValidation Resource object for that field. To set validation for a result, you must use this object.

__init__() → None

Method generated by attrs for class AssayResultFieldValidation.

property additional_keys: List[str]

additional_properties: Dict[str, UserValidation]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_result_field_validation.T

get(key, default=None) → Optional[UserValidation]

to_dict() → Dict[str, Any]

class AssayResultIdsRequest

Bases: object

__init__(assay_result_ids: List[str]) → None

Method generated by attrs for class AssayResultIdsRequest.

property assay_result_ids: List[str]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_result_ids_request.T

to_dict() → Dict[str, Any]

class AssayResultIdsResponse

Bases: object

__init__(assay_result_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_assay_result_ids'].default) → None

Method generated by attrs for class AssayResultIdsResponse.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_result_ids: List[str]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_result_ids_response.T

get(key, default=None) → Optional[Any]

to_dict() → Dict[str, Any]

class AssayResultSchema

Bases: object

__init__(modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, type: Union[benchling_api_client.v2.types.Unset, AssayResultSchemaType] = attr_dict['_type'].default, derived_from: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_derived_from'].default, organization: Union[benchling_api_client.v2.types.Unset, BaseAssaySchemaOrganization] = attr_dict['_organization'].default, system_name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_system_name'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class AssayResultSchema.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

property derived_from: Optional[str]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_result_schema.T

get(key, default=None) → Optional[Any]

property id: str

property modified_at: datetime

DateTime the Assay Result Schema was last modified

property name: str

property organization: BaseAssaySchemaOrganization

property system_name: str

to_dict() → Dict[str, Any]

property type: AssayResultSchemaType

class AssayResultSchemaType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ASSAY_RESULT = 'assay_result'

static of_unknown(val: str) → AssayResultSchemaType

class AssayResultSchemasPaginatedList

Bases: object

__init__(assay_result_schemas: Union[benchling_api_client.v2.types.Unset, List[AssayResultSchema]] = attr_dict['_assay_result_schemas'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) → None

Method generated by attrs for class AssayResultSchemasPaginatedList.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_result_schemas: List[AssayResultSchema]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_result_schemas_paginated_list.T

get(key, default=None) → Optional[Any]

property next_token: str

to_dict() → Dict[str, Any]

class AssayResultTransactionCreateResponse

Bases: object

__init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default) → None

Method generated by attrs for class AssayResultTransactionCreateResponse.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_result_transaction_create_response.T

get(key, default=None) → Optional[Any]

property id: str

to_dict() → Dict[str, Any]

class AssayResultsArchive

Bases: object

__init__(assay_result_ids: List[str], reason: Union[benchling_api_client.v2.types.Unset, AssayResultsArchiveReason] = attr_dict['_reason'].default) → None

Method generated by attrs for class AssayResultsArchive.

property assay_result_ids: List[str]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_results_archive.T

property reason: AssayResultsArchiveReason

The reason for archiving the provided results. Accepted reasons may differ based on tenant configuration

to_dict() → Dict[str, Any]

class AssayResultsArchiveReason

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ARCHIVED = 'Archived'

MADE_IN_ERROR = 'Made in error'

OTHER = 'Other'

static of_unknown(val: str) → AssayResultsArchiveReason

class AssayResultsBulkCreateRequest

Bases: object

__init__(assay_results: List[AssayResultCreate]) → None

Method generated by attrs for class AssayResultsBulkCreateRequest.

property assay_results: List[AssayResultCreate]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_results_bulk_create_request.T

to_dict() → Dict[str, Any]

class AssayResultsBulkGet

Bases: object

__init__(assay_results: Union[benchling_api_client.v2.types.Unset, List[AssayResult]] = attr_dict['_assay_results'].default) → None

Method generated by attrs for class AssayResultsBulkGet.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_results: List[AssayResult]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_results_bulk_get.T

get(key, default=None) → Optional[Any]

to_dict() → Dict[str, Any]

class AssayResultsCreateResponse

Bases: object

__init__(assay_results: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_assay_results'].default) → None

Method generated by attrs for class AssayResultsCreateResponse.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_results: List[str]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_results_create_response.T

get(key, default=None) → Optional[Any]

to_dict() → Dict[str, Any]

class AssayResultsPaginatedList

Bases: object

__init__(assay_results: Union[benchling_api_client.v2.types.Unset, List[AssayResult]] = attr_dict['_assay_results'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) → None

Method generated by attrs for class AssayResultsPaginatedList.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_results: List[AssayResult]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_results_paginated_list.T

get(key, default=None) → Optional[Any]

property next_token: str

to_dict() → Dict[str, Any]

class AssayRun

Bases: object

__init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, created_at: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, UserSummary] = attr_dict['_creator'].default, entry_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_entry_id'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, is_reviewed: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_reviewed'].default, project_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_project_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, SchemaSummary] = attr_dict['_schema'].default, validation_comment: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_validation_comment'].default, validation_status: Union[benchling_api_client.v2.types.Unset, AssayRunValidationStatus] = attr_dict['_validation_status'].default) → None

Method generated by attrs for class AssayRun.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_url: str

The canonical url of the Run in the API.

property archive_record: Optional[ArchiveRecord]

property created_at: str

property creator: UserSummary

property entry_id: Optional[str]

property fields: Fields

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_run.T

get(key, default=None) → Optional[Any]

property id: str

property is_reviewed: bool

property project_id: Optional[str]

property schema: Optional[SchemaSummary]

to_dict() → Dict[str, Any]

property validation_comment: Optional[str]

property validation_status: AssayRunValidationStatus

Must be either VALID or INVALID

class AssayRunCreate

Bases: object

__init__(fields: Union[Fields, AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType], schema_id: str, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default, validation_comment: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_validation_comment'].default, validation_status: Union[benchling_api_client.v2.types.Unset, AssayRunValidationStatus] = attr_dict['_validation_status'].default) → None

Method generated by attrs for class AssayRunCreate.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property fields: Union[Fields, AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType]

Object of assay run fields

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_run_create.T

get(key, default=None) → Optional[Any]

property id: str

ID of assay run

property project_id: str

The project that the assay run should be uploaded to. Only users with read access to the project will be able to read the assay run. Leaving this empty will result in only the creator having read access.

property schema_id: str

ID of assay schema that assay run conforms to

to_dict() → Dict[str, Any]

property validation_comment: str

Additional information about the validation status

property validation_status: AssayRunValidationStatus

Must be either VALID or INVALID

class AssayRunCreatedEvent

Bases: object

__init__(assay_run: Union[benchling_api_client.v2.types.Unset, AssayRun] = attr_dict['_assay_run'].default, event_type: Union[benchling_api_client.v2.types.Unset, AssayRunCreatedEventEventType] = attr_dict['_event_type'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class AssayRunCreatedEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_run: AssayRun

property created_at: datetime

property deprecated: bool

property event_type: AssayRunCreatedEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_run_created_event.T

get(key, default=None) → Optional[Any]

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

class AssayRunCreatedEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_ASSAYRUNCREATED = 'v2.assayRun.created'

static of_unknown(val: str) → AssayRunCreatedEventEventType

class AssayRunNotePart

Bases: object

__init__(assay_run_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_assay_run_id'].default, assay_run_schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_assay_run_schema_id'].default, type: Union[benchling_api_client.v2.types.Unset, AssayRunNotePartType] = attr_dict['_type'].default, indentation: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_indentation'].default) → None

Method generated by attrs for class AssayRunNotePart.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_run_id: Optional[str]

property assay_run_schema_id: str

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_run_note_part.T

get(key, default=None) → Optional[Any]

property indentation: int

All notes have an indentation level - the default is 0 for no indent. For lists, indentation gives notes hierarchy - a bulleted list with children is modeled as one note part with indentation 1 followed by note parts with indentation 2, for example.

to_dict() → Dict[str, Any]

property type: AssayRunNotePartType

class AssayRunNotePartType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ASSAY_RUN = 'assay_run'

static of_unknown(val: str) → AssayRunNotePartType

class AssayRunSchema

Bases: object

__init__(automation_input_file_configs: Union[benchling_api_client.v2.types.Unset, List[AssayRunSchemaAutomationInputFileConfigsItem]] = attr_dict['_automation_input_file_configs'].default, automation_output_file_configs: Union[benchling_api_client.v2.types.Unset, List[AssayRunSchemaAutomationOutputFileConfigsItem]] = attr_dict['_automation_output_file_configs'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, type: Union[benchling_api_client.v2.types.Unset, AssayRunSchemaType] = attr_dict['_type'].default, derived_from: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_derived_from'].default, organization: Union[benchling_api_client.v2.types.Unset, BaseAssaySchemaOrganization] = attr_dict['_organization'].default, system_name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_system_name'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class AssayRunSchema.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property archive_record: Optional[ArchiveRecord]

property automation_input_file_configs: List[AssayRunSchemaAutomationInputFileConfigsItem]

property automation_output_file_configs: List[AssayRunSchemaAutomationOutputFileConfigsItem]

property derived_from: Optional[str]

property field_definitions: List[Union[SimpleFieldDefinition, IntegerFieldDefinition, FloatFieldDefinition, DropdownFieldDefinition, SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_run_schema.T

get(key, default=None) → Optional[Any]

property id: str

property modified_at: datetime

DateTime the Assay Run Schema was last modified

property name: str

property organization: BaseAssaySchemaOrganization

property system_name: str

to_dict() → Dict[str, Any]

property type: AssayRunSchemaType

class AssayRunSchemaAutomationInputFileConfigsItem

Bases: object

__init__(name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class AssayRunSchemaAutomationInputFileConfigsItem.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_run_schema_automation_input_file_configs_item.T

get(key, default=None) → Optional[Any]

property name: str

to_dict() → Dict[str, Any]

class AssayRunSchemaAutomationOutputFileConfigsItem

Bases: object

__init__(name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class AssayRunSchemaAutomationOutputFileConfigsItem.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_run_schema_automation_output_file_configs_item.T

get(key, default=None) → Optional[Any]

property name: str

to_dict() → Dict[str, Any]

class AssayRunSchemaType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ASSAY_RUN = 'assay_run'

static of_unknown(val: str) → AssayRunSchemaType

class AssayRunSchemasPaginatedList

Bases: object

__init__(assay_run_schemas: Union[benchling_api_client.v2.types.Unset, List[AssayRunSchema]] = attr_dict['_assay_run_schemas'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) → None

Method generated by attrs for class AssayRunSchemasPaginatedList.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_run_schemas: List[AssayRunSchema]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_run_schemas_paginated_list.T

get(key, default=None) → Optional[Any]

property next_token: str

to_dict() → Dict[str, Any]

class AssayRunUpdate

Bases: object

__init__(fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default) → None

Method generated by attrs for class AssayRunUpdate.

property fields: Fields

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_run_update.T

to_dict() → Dict[str, Any]

class AssayRunUpdatedFieldsEvent

Bases: object

__init__(assay_run: Union[benchling_api_client.v2.types.Unset, AssayRun] = attr_dict['_assay_run'].default, event_type: Union[benchling_api_client.v2.types.Unset, AssayRunUpdatedFieldsEventEventType] = attr_dict['_event_type'].default, updates: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_updates'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class AssayRunUpdatedFieldsEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_run: AssayRun

property created_at: datetime

property deprecated: bool

property event_type: AssayRunUpdatedFieldsEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_run_updated_fields_event.T

get(key, default=None) → Optional[Any]

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

property updates: List[str]

These properties have been updated, causing this message

class AssayRunUpdatedFieldsEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_ASSAYRUNUPDATEDFIELDS = 'v2.assayRun.updated.fields'

static of_unknown(val: str) → AssayRunUpdatedFieldsEventEventType

class AssayRunValidationStatus

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

INVALID = 'INVALID'

VALID = 'VALID'

static of_unknown(val: str) → AssayRunValidationStatus

class AssayRunsArchivalChange

Bases: object

IDs of all Assay Runs that were archived / unarchived.

__init__(assay_run_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_assay_run_ids'].default) → None

Method generated by attrs for class AssayRunsArchivalChange.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_run_ids: List[str]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_runs_archival_change.T

get(key, default=None) → Optional[Any]

to_dict() → Dict[str, Any]

class AssayRunsArchive

Bases: object

The request body for archiving Assay Runs.

__init__(assay_run_ids: List[str], reason: AssayRunsArchiveReason) → None

Method generated by attrs for class AssayRunsArchive.

property assay_run_ids: List[str]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_runs_archive.T

property reason: AssayRunsArchiveReason

The reason for archiving the provided Assay Runs. Accepted reasons may differ based on tenant configuration.

to_dict() → Dict[str, Any]

class AssayRunsArchiveReason

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

ARCHIVED = 'Archived'

MADE_IN_ERROR = 'Made in error'

OTHER = 'Other'

static of_unknown(val: str) → AssayRunsArchiveReason

class AssayRunsBulkCreateRequest

Bases: object

__init__(assay_runs: List[AssayRunCreate]) → None

Method generated by attrs for class AssayRunsBulkCreateRequest.

property assay_runs: List[AssayRunCreate]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_runs_bulk_create_request.T

to_dict() → Dict[str, Any]

class AssayRunsBulkCreateResponse

Bases: object

__init__(assay_runs: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_assay_runs'].default) → None

Method generated by attrs for class AssayRunsBulkCreateResponse.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_runs: List[str]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_runs_bulk_create_response.T

get(key, default=None) → Optional[Any]

to_dict() → Dict[str, Any]

class AssayRunsBulkGet

Bases: object

__init__(assay_runs: Union[benchling_api_client.v2.types.Unset, List[AssayRun]] = attr_dict['_assay_runs'].default) → None

Method generated by attrs for class AssayRunsBulkGet.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_runs: List[AssayRun]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_runs_bulk_get.T

get(key, default=None) → Optional[Any]

to_dict() → Dict[str, Any]

class AssayRunsPaginatedList

Bases: object

__init__(assay_runs: Union[benchling_api_client.v2.types.Unset, List[AssayRun]] = attr_dict['_assay_runs'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) → None

Method generated by attrs for class AssayRunsPaginatedList.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_runs: List[AssayRun]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_runs_paginated_list.T

get(key, default=None) → Optional[Any]

property next_token: str

to_dict() → Dict[str, Any]

class AssayRunsUnarchive

Bases: object

The request body for unarchiving Assay Runs.

__init__(assay_run_ids: List[str]) → None

Method generated by attrs for class AssayRunsUnarchive.

property assay_run_ids: List[str]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.assay_runs_unarchive.T

to_dict() → Dict[str, Any]

class AsyncTask

Bases: object

__init__(status: AsyncTaskStatus, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default, response: Union[benchling_api_client.v2.types.Unset, AsyncTaskResponse] = attr_dict['_response'].default) → None

Method generated by attrs for class AsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property errors: AsyncTaskErrors

Present only when status is FAILED for a bulk task. Contains information about the individual errors in the bulk task.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.async_task.T

get(key, default=None) → Optional[Any]

property message: str

Present only when status is FAILED. Contains information about the error.

property response: AsyncTaskResponse

Present only when status is SUCCEEDED. response can be empty if there is no data to be returned.

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class AsyncTaskErrors

Bases: object

Present only when status is FAILED for a bulk task. Contains information about the individual errors in the bulk task.

__init__() → None

Method generated by attrs for class AsyncTaskErrors.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.async_task_errors.T

get(key, default=None) → Optional[Any]

to_dict() → Dict[str, Any]

class AsyncTaskLink

Bases: object

__init__(task_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_task_id'].default) → None

Method generated by attrs for class AsyncTaskLink.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.async_task_link.T

get(key, default=None) → Optional[Any]

property task_id: str

to_dict() → Dict[str, Any]

class AsyncTaskResponse

Bases: object

Present only when status is SUCCEEDED. response can be empty if there is no data to be returned.

__init__() → None

Method generated by attrs for class AsyncTaskResponse.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.async_task_response.T

get(key, default=None) → Optional[Any]

to_dict() → Dict[str, Any]

class AsyncTaskStatus

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

FAILED = 'FAILED'

RUNNING = 'RUNNING'

SUCCEEDED = 'SUCCEEDED'

static of_unknown(val: str) → AsyncTaskStatus

class AutoAnnotateAaSequences

Bases: object

__init__(aa_sequence_ids: List[str], feature_library_ids: List[str]) → None

Method generated by attrs for class AutoAnnotateAaSequences.

property aa_sequence_ids: List[str]

Array of AA sequence IDs.

property feature_library_ids: List[str]

Array of feature library IDs.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.auto_annotate_aa_sequences.T

to_dict() → Dict[str, Any]

class AutoAnnotateDnaSequences

Bases: object

__init__(dna_sequence_ids: List[str], feature_library_ids: List[str]) → None

Method generated by attrs for class AutoAnnotateDnaSequences.

property dna_sequence_ids: List[str]

Array of DNA sequence IDs.

property feature_library_ids: List[str]

Array of feature library IDs.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.auto_annotate_dna_sequences.T

to_dict() → Dict[str, Any]

class AutoAnnotateRnaSequences

Bases: object

__init__(feature_library_ids: List[str], rna_sequence_ids: List[str]) → None

Method generated by attrs for class AutoAnnotateRnaSequences.

property feature_library_ids: List[str]

Array of feature library IDs.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.auto_annotate_rna_sequences.T

property rna_sequence_ids: List[str]

Array of RNA sequence IDs.

to_dict() → Dict[str, Any]

class AutofillPartsAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Optional[benchling_api_client.v2.types.Unset] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class AutofillPartsAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property errors: AsyncTaskErrors

Present only when status is FAILED for a bulk task. Contains information about the individual errors in the bulk task.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.autofill_parts_async_task.T

get(key, default=None) → Optional[Any]

property message: str

Present only when status is FAILED. Contains information about the error.

property response: None

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class AutofillRnaSequences

Bases: object

__init__(rna_sequence_ids: List[str]) → None

Method generated by attrs for class AutofillRnaSequences.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.autofill_rna_sequences.T

property rna_sequence_ids: List[str]

Array of RNA sequence IDs.

to_dict() → Dict[str, Any]

class AutofillSequences

Bases: object

__init__(dna_sequence_ids: List[str]) → None

Method generated by attrs for class AutofillSequences.

property dna_sequence_ids: List[str]

Array of DNA sequence IDs.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.autofill_sequences.T

to_dict() → Dict[str, Any]

class AutofillTranslationsAsyncTask

Bases: object

__init__(status: AsyncTaskStatus, response: Optional[benchling_api_client.v2.types.Unset] = attr_dict['_response'].default, errors: Union[benchling_api_client.v2.types.Unset, AsyncTaskErrors] = attr_dict['_errors'].default, message: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_message'].default) → None

Method generated by attrs for class AutofillTranslationsAsyncTask.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property errors: AsyncTaskErrors

Present only when status is FAILED for a bulk task. Contains information about the individual errors in the bulk task.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.autofill_translations_async_task.T

get(key, default=None) → Optional[Any]

property message: str

Present only when status is FAILED. Contains information about the error.

property response: None

property status: AsyncTaskStatus

The current state of the task.

to_dict() → Dict[str, Any]

class AutomationFile

Bases: object

__init__(assay_run_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_assay_run_id'].default, automation_file_config: Union[benchling_api_client.v2.types.Unset, AutomationFileAutomationFileConfig] = attr_dict['_automation_file_config'].default, file: Union[benchling_api_client.v2.types.Unset, None, Blob] = attr_dict['_file'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, status: Union[benchling_api_client.v2.types.Unset, AutomationFileStatus] = attr_dict['_status'].default) → None

Method generated by attrs for class AutomationFile.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property assay_run_id: str

property automation_file_config: AutomationFileAutomationFileConfig

property file: Optional[Blob]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.automation_file.T

get(key, default=None) → Optional[Any]

property id: str

property status: AutomationFileStatus

to_dict() → Dict[str, Any]

class AutomationFileAutomationFileConfig

Bases: object

__init__(name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) → None

Method generated by attrs for class AutomationFileAutomationFileConfig.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.automation_file_automation_file_config.T

get(key, default=None) → Optional[Any]

property name: str

to_dict() → Dict[str, Any]

class AutomationFileInputsPaginatedList

Bases: object

__init__(automation_input_generators: Union[benchling_api_client.v2.types.Unset, List[AutomationInputGenerator]] = attr_dict['_automation_input_generators'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) → None

Method generated by attrs for class AutomationFileInputsPaginatedList.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property automation_input_generators: List[AutomationInputGenerator]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.automation_file_inputs_paginated_list.T

get(key, default=None) → Optional[Any]

property next_token: str

to_dict() → Dict[str, Any]

class AutomationFileStatus

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

FAILED = 'FAILED'

NOT_STARTED = 'NOT_STARTED'

RUNNING = 'RUNNING'

SUCCEEDED = 'SUCCEEDED'

static of_unknown(val: str) → AutomationFileStatus

class AutomationInputGenerator

Bases: object

__init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, assay_run_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_assay_run_id'].default, automation_file_config: Union[benchling_api_client.v2.types.Unset, AutomationFileAutomationFileConfig] = attr_dict['_automation_file_config'].default, file: Union[benchling_api_client.v2.types.Unset, None, Blob] = attr_dict['_file'].default, status: Union[benchling_api_client.v2.types.Unset, AutomationFileStatus] = attr_dict['_status'].default) → None

Method generated by attrs for class AutomationInputGenerator.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_url: str

The canonical url of the Automation Input Generator in the API.

property assay_run_id: str

property automation_file_config: AutomationFileAutomationFileConfig

property created_at: datetime

DateTime the Automation Input Generator was last modified

property file: Optional[Blob]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.automation_input_generator.T

get(key, default=None) → Optional[Any]

property id: str

property modified_at: datetime

DateTime the Automation Input Generator was last modified

property status: AutomationFileStatus

to_dict() → Dict[str, Any]

class AutomationInputGeneratorCompletedV2BetaEvent

Bases: object

__init__(automation_input_generator: Union[benchling_api_client.v2.types.Unset, AutomationFile] = attr_dict['_automation_input_generator'].default, event_type: Union[benchling_api_client.v2.types.Unset, AutomationInputGeneratorCompletedV2BetaEventEventType] = attr_dict['_event_type'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class AutomationInputGeneratorCompletedV2BetaEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property automation_input_generator: AutomationFile

property created_at: datetime

property deprecated: bool

property event_type: AutomationInputGeneratorCompletedV2BetaEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.automation_input_generator_completed_v2_beta_event.T

get(key, default=None) → Optional[Any]

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

class AutomationInputGeneratorCompletedV2BetaEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_BETAAUTOMATIONINPUTGENERATORCOMPLETED = 'v2-beta.automationInputGenerator.completed'

static of_unknown(val: str) → AutomationInputGeneratorCompletedV2BetaEventEventType

class AutomationInputGeneratorUpdate

Bases: object

__init__(file_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_file_id'].default) → None

Method generated by attrs for class AutomationInputGeneratorUpdate.

property file_id: Optional[str]

The ID of the file (blob) associated with the input generator. Set to null to remove an existing file from the generator.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.automation_input_generator_update.T

to_dict() → Dict[str, Any]

class AutomationOutputProcessor

Bases: object

__init__(api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, archive_record: Union[benchling_api_client.v2.types.Unset, ArchiveRecord] = attr_dict['_archive_record'].default, complete_with_errors: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_complete_with_errors'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, error_file: Union[benchling_api_client.v2.types.Unset, None, Blob] = attr_dict['_error_file'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, progress_stats: Union[benchling_api_client.v2.types.Unset, AutomationProgressStats] = attr_dict['_progress_stats'].default, transforms: Union[benchling_api_client.v2.types.Unset, List[LabAutomationTransform]] = attr_dict['_transforms'].default, assay_run_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_assay_run_id'].default, automation_file_config: Union[benchling_api_client.v2.types.Unset, AutomationFileAutomationFileConfig] = attr_dict['_automation_file_config'].default, file: Union[benchling_api_client.v2.types.Unset, None, Blob] = attr_dict['_file'].default, status: Union[benchling_api_client.v2.types.Unset, AutomationFileStatus] = attr_dict['_status'].default) → None

Method generated by attrs for class AutomationOutputProcessor.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property api_url: str

The canonical url of the Automation Output Processor in the API.

property archive_record: ArchiveRecord

property assay_run_id: str

property automation_file_config: AutomationFileAutomationFileConfig

property complete_with_errors: bool

Specifies whether file processing should complete with errors. False means any error in output file processing will result in no actions being committed. True means that if row-level errors occur, then failing rows and their errors will be saved to errorFile, and actions from successful rows will be committed.

property created_at: datetime

DateTime the Automation Output Processor was created

property error_file: Optional[Blob]

property file: Optional[Blob]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.automation_output_processor.T

get(key, default=None) → Optional[Any]

property id: str

property modified_at: datetime

DateTime the Automation Output Processor was last modified

property progress_stats: AutomationProgressStats

Processing progress information.

property status: AutomationFileStatus

to_dict() → Dict[str, Any]

property transforms: List[LabAutomationTransform]

class AutomationOutputProcessorArchivalChange

Bases: object

IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of any linked Results that were archived / unarchived.

__init__(automation_output_processor_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_automation_output_processor_ids'].default, result_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_result_ids'].default) → None

Method generated by attrs for class AutomationOutputProcessorArchivalChange.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property automation_output_processor_ids: List[str]

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.automation_output_processor_archival_change.T

get(key, default=None) → Optional[Any]

property result_ids: List[str]

to_dict() → Dict[str, Any]

class AutomationOutputProcessorCompletedV2BetaEvent

Bases: object

__init__(automation_output_processor: Union[benchling_api_client.v2.types.Unset, AutomationFile] = attr_dict['_automation_output_processor'].default, event_type: Union[benchling_api_client.v2.types.Unset, AutomationOutputProcessorCompletedV2BetaEventEventType] = attr_dict['_event_type'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class AutomationOutputProcessorCompletedV2BetaEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property automation_output_processor: AutomationFile

property created_at: datetime

property deprecated: bool

property event_type: AutomationOutputProcessorCompletedV2BetaEventEventType

property excluded_properties: List[str]

These properties have been dropped from the payload due to size.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.automation_output_processor_completed_v2_beta_event.T

get(key, default=None) → Optional[Any]

property id: str

property schema: Optional[EventBaseSchema]

to_dict() → Dict[str, Any]

class AutomationOutputProcessorCompletedV2BetaEventEventType

Bases: benchling_api_client.v2.extensions.Enums.KnownString

An enumeration.

V2_BETAAUTOMATIONOUTPUTPROCESSORCOMPLETED = 'v2-beta.automationOutputProcessor.completed'

static of_unknown(val: str) → AutomationOutputProcessorCompletedV2BetaEventEventType

class AutomationOutputProcessorCreate

Bases: object

__init__(assay_run_id: str, automation_file_config_name: str, file_id: str, complete_with_errors: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_complete_with_errors'].default) → None

Method generated by attrs for class AutomationOutputProcessorCreate.

property assay_run_id: str

property automation_file_config_name: str

property complete_with_errors: bool

Specifies whether file processing should complete with errors. False means any error in output file processing will result in no actions being committed. True means that if row-level errors occur, then failing rows and their errors will be saved to errorFile, and actions from successful rows will be committed.

property file_id: str

The ID of a blob link to process.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.automation_output_processor_create.T

to_dict() → Dict[str, Any]

class AutomationOutputProcessorUpdate

Bases: object

__init__(file_id: str) → None

Method generated by attrs for class AutomationOutputProcessorUpdate.

property file_id: str

The ID of a blob link to process.

classmethod from_dict(src_dict: Dict[str, Any]) → benchling_api_client.v2.stable.models.automation_output_processor_update.T

to_dict() → Dict[str, Any]

class AutomationOutputProcessorUploadedV2BetaEvent

Bases: object

__init__(automation_output_processor: Union[benchling_api_client.v2.types.Unset, AutomationFile] = attr_dict['_automation_output_processor'].default, event_type: Union[benchling_api_client.v2.types.Unset, AutomationOutputProcessorUploadedV2BetaEventEventType] = attr_dict['_event_type'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, deprecated: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_deprecated'].default, excluded_properties: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_excluded_properties'].default, id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, schema: Union[benchling_api_client.v2.types.Unset, None, EventBaseSchema] = attr_dict['_schema'].default) → None

Method generated by attrs for class AutomationOutputProcessorUploadedV2BetaEvent.

property additional_keys: List[str]

additional_properties: Dict[str, Any]

property automation_output_processor: AutomationFile

property created_at: datetime

property