benchling_sdk.models package¶
- 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[benchling_api_client.v2.stable.models.aa_annotation.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, benchling_api_client.v2.stable.models.archive_record.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, benchling_api_client.v2.stable.models.user_summary.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, benchling_api_client.v2.stable.models.registration_origin.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, benchling_api_client.v2.stable.models.schema_summary.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 annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶
Array of annotation objects on the AA sequence.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.aa_sequence.T ¶
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- 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[benchling_api_client.v2.stable.models.aa_annotation.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 annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶
Annotations to create on the AA sequence.
- 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.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.aa_sequence_bulk_create.T ¶
- 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.
- 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[benchling_api_client.v2.stable.models.aa_annotation.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 annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶
Annotations to create on the AA sequence.
- property custom_fields: CustomFields¶
- 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[benchling_api_client.v2.stable.models.aa_annotation.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 annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶
Annotations to create on the AA sequence.
- 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.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.aa_sequence_create.T ¶
- 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.
- 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[benchling_api_client.v2.stable.models.aa_annotation.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 annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶
Annotations to create on the AA sequence.
- property custom_fields: CustomFields¶
- class AaSequenceWithEntityType¶
Bases:
object
- __init__(entity_type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.aa_sequence_with_entity_type_entity_type.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[benchling_api_client.v2.stable.models.aa_annotation.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, benchling_api_client.v2.stable.models.archive_record.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, benchling_api_client.v2.stable.models.user_summary.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, benchling_api_client.v2.stable.models.registration_origin.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, benchling_api_client.v2.stable.models.schema_summary.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 annotations: List[benchling_api_client.v2.stable.models.aa_annotation.AaAnnotation]¶
Array of annotation objects on the AA sequence.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property custom_fields: CustomFields¶
- property entity_type: benchling_api_client.v2.stable.models.aa_sequence_with_entity_type_entity_type.AaSequenceWithEntityTypeEntityType¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.aa_sequence_with_entity_type.T ¶
- property registration_origin: Optional[benchling_api_client.v2.stable.models.registration_origin.RegistrationOrigin]¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- 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.
- 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.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) 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.
- 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]¶
- 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]¶
- 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]¶
- 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.
- class AppConfigItemsBulkCreateRequest¶
Bases:
object
- __init__(app_configuration_items: List[Union[benchling_api_client.v2.stable.models.app_config_item_generic_create.AppConfigItemGenericCreate, benchling_api_client.v2.stable.models.app_config_item_boolean_create.AppConfigItemBooleanCreate, benchling_api_client.v2.stable.models.app_config_item_integer_create.AppConfigItemIntegerCreate, benchling_api_client.v2.stable.models.app_config_item_float_create.AppConfigItemFloatCreate, benchling_api_client.v2.stable.models.app_config_item_date_create.AppConfigItemDateCreate, benchling_api_client.v2.stable.models.app_config_item_datetime_create.AppConfigItemDatetimeCreate, benchling_api_client.v2.stable.models.app_config_item_json_create.AppConfigItemJsonCreate, benchling_api_client.v2.extensions.UnknownType]]) None ¶
Method generated by attrs for class AppConfigItemsBulkCreateRequest.
- property app_configuration_items: List[Union[benchling_api_client.v2.stable.models.app_config_item_generic_create.AppConfigItemGenericCreate, benchling_api_client.v2.stable.models.app_config_item_boolean_create.AppConfigItemBooleanCreate, benchling_api_client.v2.stable.models.app_config_item_integer_create.AppConfigItemIntegerCreate, benchling_api_client.v2.stable.models.app_config_item_float_create.AppConfigItemFloatCreate, benchling_api_client.v2.stable.models.app_config_item_date_create.AppConfigItemDateCreate, benchling_api_client.v2.stable.models.app_config_item_datetime_create.AppConfigItemDatetimeCreate, benchling_api_client.v2.stable.models.app_config_item_json_create.AppConfigItemJsonCreate, benchling_api_client.v2.extensions.UnknownType]]¶
- class AppConfigItemsBulkUpdateRequest¶
Bases:
object
- __init__(app_configuration_items: List[Union[benchling_api_client.v2.stable.models.app_config_item_generic_bulk_update.AppConfigItemGenericBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_boolean_bulk_update.AppConfigItemBooleanBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_integer_bulk_update.AppConfigItemIntegerBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_float_bulk_update.AppConfigItemFloatBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_date_bulk_update.AppConfigItemDateBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_datetime_bulk_update.AppConfigItemDatetimeBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_json_bulk_update.AppConfigItemJsonBulkUpdate, benchling_api_client.v2.extensions.UnknownType]]) None ¶
Method generated by attrs for class AppConfigItemsBulkUpdateRequest.
- property app_configuration_items: List[Union[benchling_api_client.v2.stable.models.app_config_item_generic_bulk_update.AppConfigItemGenericBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_boolean_bulk_update.AppConfigItemBooleanBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_integer_bulk_update.AppConfigItemIntegerBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_float_bulk_update.AppConfigItemFloatBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_date_bulk_update.AppConfigItemDateBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_datetime_bulk_update.AppConfigItemDatetimeBulkUpdate, benchling_api_client.v2.stable.models.app_config_item_json_bulk_update.AppConfigItemJsonBulkUpdate, benchling_api_client.v2.extensions.UnknownType]]¶
- class AppConfigurationPaginatedList¶
Bases:
object
- __init__(app_configuration_items: Union[benchling_api_client.v2.types.Unset, List[Union[ArrayElementAppConfigItem, DateAppConfigItem, DatetimeAppConfigItem, JsonAppConfigItem, EntitySchemaAppConfigItem, FieldAppConfigItem, BooleanAppConfigItem, IntegerAppConfigItem, FloatAppConfigItem, TextAppConfigItem, GenericApiIdentifiedAppConfigItem, SecureTextAppConfigItem, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_app_configuration_items'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class AppConfigurationPaginatedList.
- property app_configuration_items: List[Union[ArrayElementAppConfigItem, DateAppConfigItem, DatetimeAppConfigItem, JsonAppConfigItem, EntitySchemaAppConfigItem, FieldAppConfigItem, BooleanAppConfigItem, IntegerAppConfigItem, FloatAppConfigItem, TextAppConfigItem, GenericApiIdentifiedAppConfigItem, SecureTextAppConfigItem, benchling_api_client.v2.extensions.UnknownType]]¶
- class ArrayElementAppConfigItem¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, ArrayElementAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_value'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].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, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class ArrayElementAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.array_element_app_config_item.T ¶
- property path: List[str]¶
Array-based representation of config itemâs location in the tree in order from top to bottom.
- property type: ArrayElementAppConfigItemType¶
- class ArrayElementAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- ARRAY_ELEMENT = 'array_element'¶
- static of_unknown(val: str) ArrayElementAppConfigItemType ¶
- class AssayResult¶
Bases:
object
- __init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.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, benchling_api_client.v2.stable.models.user_summary.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, benchling_api_client.v2.stable.models.assay_result_field_validation.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, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].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, benchling_api_client.v2.stable.models.schema_summary.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 archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property field_validation: benchling_api_client.v2.stable.models.assay_result_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.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_result.T ¶
- property schema: benchling_api_client.v2.stable.models.schema_summary.SchemaSummary¶
- class AssayResultCreate¶
Bases:
object
- __init__(fields: Union[Fields, benchling_api_client.v2.stable.models.assay_fields_create.AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType], schema_id: str, field_validation: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.assay_result_create_field_validation.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 field_validation: benchling_api_client.v2.stable.models.assay_result_create_field_validation.AssayResultCreateFieldValidation¶
Dictionary mapping field names to UserValidation Resources.
- property fields: Union[Fields, benchling_api_client.v2.stable.models.assay_fields_create.AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType]¶
Dictionary of result fields
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_result_create.T ¶
- class AssayResultIdsRequest¶
Bases:
object
- __init__(assay_result_ids: List[str]) None ¶
Method generated by attrs for class AssayResultIdsRequest.
- 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.
- 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, benchling_api_client.v2.stable.models.assay_result_schema_type.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, benchling_api_client.v2.stable.models.base_assay_schema_organization.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, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.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 archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_result_schema.T ¶
- property organization: benchling_api_client.v2.stable.models.base_assay_schema_organization.BaseAssaySchemaOrganization¶
- property type: benchling_api_client.v2.stable.models.assay_result_schema_type.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 assay_result_schemas: List[AssayResultSchema]¶
- 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.
- class AssayResultsArchive¶
Bases:
object
- __init__(assay_result_ids: List[str], reason: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.assay_results_archive_reason.AssayResultsArchiveReason] = attr_dict['_reason'].default) None ¶
Method generated by attrs for class AssayResultsArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_results_archive.T ¶
- property reason: benchling_api_client.v2.stable.models.assay_results_archive_reason.AssayResultsArchiveReason¶
The reason for archiving the provided results. Accepted reasons may differ based on tenant configuration
- class AssayResultsBulkCreateRequest¶
Bases:
object
- __init__(assay_results: List[AssayResultCreate]) None ¶
Method generated by attrs for class AssayResultsBulkCreateRequest.
- property assay_results: List[AssayResultCreate]¶
- 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.
- 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 assay_results: List[AssayResult]¶
- 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, benchling_api_client.v2.stable.models.archive_record.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, benchling_api_client.v2.stable.models.user_summary.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, benchling_api_client.v2.stable.models.schema_summary.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, benchling_api_client.v2.stable.models.assay_run_validation_status.AssayRunValidationStatus] = attr_dict['_validation_status'].default) None ¶
Method generated by attrs for class AssayRun.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_run.T ¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- property validation_status: benchling_api_client.v2.stable.models.assay_run_validation_status.AssayRunValidationStatus¶
Must be either VALID or INVALID
- class AssayRunCreate¶
Bases:
object
- __init__(fields: Union[Fields, benchling_api_client.v2.stable.models.assay_fields_create.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, benchling_api_client.v2.stable.models.assay_run_validation_status.AssayRunValidationStatus] = attr_dict['_validation_status'].default) None ¶
Method generated by attrs for class AssayRunCreate.
- property fields: Union[Fields, benchling_api_client.v2.stable.models.assay_fields_create.AssayFieldsCreate, benchling_api_client.v2.extensions.UnknownType]¶
Object of assay run fields
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_run_create.T ¶
- 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 validation_status: benchling_api_client.v2.stable.models.assay_run_validation_status.AssayRunValidationStatus¶
Must be either VALID or INVALID
- class AssayRunSchema¶
Bases:
object
- __init__(automation_input_file_configs: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.assay_run_schema_automation_input_file_configs_item.AssayRunSchemaAutomationInputFileConfigsItem]] = attr_dict['_automation_input_file_configs'].default, automation_output_file_configs: Union[benchling_api_client.v2.types.Unset, List[benchling_api_client.v2.stable.models.assay_run_schema_automation_output_file_configs_item.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, benchling_api_client.v2.stable.models.assay_run_schema_type.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, benchling_api_client.v2.stable.models.base_assay_schema_organization.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, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.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 archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property automation_input_file_configs: List[benchling_api_client.v2.stable.models.assay_run_schema_automation_input_file_configs_item.AssayRunSchemaAutomationInputFileConfigsItem]¶
- property automation_output_file_configs: List[benchling_api_client.v2.stable.models.assay_run_schema_automation_output_file_configs_item.AssayRunSchemaAutomationOutputFileConfigsItem]¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.assay_run_schema.T ¶
- property organization: benchling_api_client.v2.stable.models.base_assay_schema_organization.BaseAssaySchemaOrganization¶
- property type: benchling_api_client.v2.stable.models.assay_run_schema_type.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 assay_run_schemas: List[AssayRunSchema]¶
- 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.
- 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.
- 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.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) 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.
- 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]¶
- 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.
- 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.
- class AssayRunsUnarchive¶
Bases:
object
The request body for unarchiving Assay Runs.
- class AsyncTask¶
Bases:
object
- __init__(status: AsyncTaskStatus, errors: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.async_task_errors.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, benchling_api_client.v2.stable.models.async_task_response.AsyncTaskResponse] = attr_dict['_response'].default) None ¶
Method generated by attrs for class AsyncTask.
- property errors: benchling_api_client.v2.stable.models.async_task_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], strict: bool = False) benchling_api_client.v2.stable.models.async_task.T ¶
- property response: benchling_api_client.v2.stable.models.async_task_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.
- 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.
- 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.
- class AutoAnnotateDnaSequences¶
Bases:
object
- __init__(dna_sequence_ids: List[str], feature_library_ids: List[str]) None ¶
Method generated by attrs for class AutoAnnotateDnaSequences.
- class AutofillSequences¶
Bases:
object
- __init__(dna_sequence_ids: List[str]) None ¶
Method generated by attrs for class AutofillSequences.
- 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 automation_input_generators: List[AutomationInputGenerator]¶
- 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, transforms: Union[benchling_api_client.v2.types.Unset, List[Optional[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, benchling_api_client.v2.stable.models.automation_file_automation_file_config.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, benchling_api_client.v2.stable.models.automation_file_status.AutomationFileStatus] = attr_dict['_status'].default) None ¶
Method generated by attrs for class AutomationInputGenerator.
- property automation_file_config: benchling_api_client.v2.stable.models.automation_file_automation_file_config.AutomationFileAutomationFileConfig¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.automation_input_generator.T ¶
- property status: benchling_api_client.v2.stable.models.automation_file_status.AutomationFileStatus¶
- property transforms: List[Optional[LabAutomationTransform]]¶
- 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.
- 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, None, benchling_api_client.v2.stable.models.archive_record.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, benchling_api_client.v2.stable.models.automation_progress_stats.AutomationProgressStats] = attr_dict['_progress_stats'].default, transforms: Union[benchling_api_client.v2.types.Unset, List[Optional[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, benchling_api_client.v2.stable.models.automation_file_automation_file_config.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, benchling_api_client.v2.stable.models.automation_file_status.AutomationFileStatus] = attr_dict['_status'].default) None ¶
Method generated by attrs for class AutomationOutputProcessor.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property automation_file_config: benchling_api_client.v2.stable.models.automation_file_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.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.automation_output_processor.T ¶
- property progress_stats: benchling_api_client.v2.stable.models.automation_progress_stats.AutomationProgressStats¶
Processing progress information.
- property status: benchling_api_client.v2.stable.models.automation_file_status.AutomationFileStatus¶
- property transforms: List[Optional[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.
- 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 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.
- class AutomationOutputProcessorUpdate¶
Bases:
object
- class AutomationOutputProcessorsArchive¶
Bases:
object
- __init__(automation_output_processor_ids: List[str], reason: Union[benchling_api_client.v2.types.Unset, AutomationOutputProcessorsArchiveReason] = attr_dict['_reason'].default) None ¶
Method generated by attrs for class AutomationOutputProcessorsArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.automation_output_processors_archive.T ¶
- property reason: AutomationOutputProcessorsArchiveReason¶
The reason that the output processors are being archived. Accepted reasons may differ based on tenant configuration.
- class AutomationOutputProcessorsArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- CONTAMINATED = 'Contaminated'¶
- EXPENDED = 'Expended'¶
- EXPIRED = 'Expired'¶
- MADE_IN_ERROR = 'Made in error'¶
- MISSING = 'Missing'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- SHIPPED = 'Shipped'¶
- static of_unknown(val: str) AutomationOutputProcessorsArchiveReason ¶
- class AutomationOutputProcessorsPaginatedList¶
Bases:
object
A paginated list of automation output processors which have an attached file.
- __init__(automation_output_processors: Union[benchling_api_client.v2.types.Unset, List[AutomationOutputProcessor]] = attr_dict['_automation_output_processors'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class AutomationOutputProcessorsPaginatedList.
- property automation_output_processors: List[AutomationOutputProcessor]¶
- class AutomationOutputProcessorsUnarchive¶
Bases:
object
- __init__(automation_output_processor_ids: List[str]) None ¶
Method generated by attrs for class AutomationOutputProcessorsUnarchive.
- class BadRequestError¶
Bases:
object
- __init__(error: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.bad_request_error_error.BadRequestErrorError] = attr_dict['_error'].default) None ¶
Method generated by attrs for class BadRequestError.
- property error: benchling_api_client.v2.stable.models.bad_request_error_error.BadRequestErrorError¶
- class BadRequestErrorBulk¶
Bases:
object
- __init__(error: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.bad_request_error_bulk_error.BadRequestErrorBulkError] = attr_dict['_error'].default) None ¶
Method generated by attrs for class BadRequestErrorBulk.
- property error: benchling_api_client.v2.stable.models.bad_request_error_bulk_error.BadRequestErrorBulkError¶
- class BarcodeValidationResult¶
Bases:
object
- __init__(barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].default, is_valid: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_is_valid'].default, message: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_message'].default) None ¶
Method generated by attrs for class BarcodeValidationResult.
- class BarcodesList¶
Bases:
object
- class BatchSchema¶
Bases:
object
- __init__(entity_schema_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_entity_schema_id'].default, modified_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_modified_at'].default, prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_prefix'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.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, type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_type'].default) None ¶
Method generated by attrs for class BatchSchema.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property field_definitions: List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]¶
- class BatchSchemasPaginatedList¶
Bases:
object
- __init__(next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default, batch_schemas: Union[benchling_api_client.v2.types.Unset, List[BatchSchema]] = attr_dict['_batch_schemas'].default) None ¶
Method generated by attrs for class BatchSchemasPaginatedList.
- property batch_schemas: List[BatchSchema]¶
- class BenchlingApp¶
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, benchling_api_client.v2.stable.models.archive_record.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, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].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, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class BenchlingApp.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- class BenchlingAppCreate¶
Bases:
object
- __init__(name: str, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default) None ¶
Method generated by attrs for class BenchlingAppCreate.
- class BenchlingAppUpdate¶
Bases:
object
- __init__(description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default) None ¶
Method generated by attrs for class BenchlingAppUpdate.
- class BenchlingAppsArchivalChange¶
Bases:
object
IDs of all items that were archived or unarchived, grouped by resource type. This includes the IDs of apps that were archived / unarchived.
- __init__(app_ids: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_app_ids'].default) None ¶
Method generated by attrs for class BenchlingAppsArchivalChange.
- class BenchlingAppsArchive¶
Bases:
object
- __init__(app_ids: List[str], reason: BenchlingAppsArchiveReason) None ¶
Method generated by attrs for class BenchlingAppsArchive.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.benchling_apps_archive.T ¶
- property reason: BenchlingAppsArchiveReason¶
Reason that apps are being archived. Actual reason enum varies by tenant.
- class BenchlingAppsArchiveReason¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- MADE_IN_ERROR = 'Made in error'¶
- OTHER = 'Other'¶
- RETIRED = 'Retired'¶
- static of_unknown(val: str) BenchlingAppsArchiveReason ¶
- class BenchlingAppsPaginatedList¶
Bases:
object
- __init__(apps: Union[benchling_api_client.v2.types.Unset, List[BenchlingApp]] = attr_dict['_apps'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class BenchlingAppsPaginatedList.
- property apps: List[BenchlingApp]¶
- class BenchlingAppsUnarchive¶
Bases:
object
- class Blob¶
Bases:
object
- __init__(id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_id'].default, mime_type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_mime_type'].default, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.blob_type.BlobType] = attr_dict['_type'].default, upload_status: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.blob_upload_status.BlobUploadStatus] = attr_dict['_upload_status'].default) None ¶
Method generated by attrs for class Blob.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.blob.T ¶
- property type: benchling_api_client.v2.stable.models.blob_type.BlobType¶
One of RAW_FILE or VISUALIZATION. If VISUALIZATION, the blob may be displayed as an image preview.
- property upload_status: benchling_api_client.v2.stable.models.blob_upload_status.BlobUploadStatus¶
- class BlobComplete¶
Bases:
object
- __init__(parts: Union[benchling_api_client.v2.types.Unset, List[BlobPart]] = attr_dict['_parts'].default) None ¶
Method generated by attrs for class BlobComplete.
- class BlobCreate¶
Bases:
object
- __init__(data64: str, md5: str, name: str, type: BlobCreateType, mime_type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_mime_type'].default) None ¶
Method generated by attrs for class BlobCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.blob_create.T ¶
- property md5: str¶
The MD5 hash of the blob part. Note: this should be the hash of the raw data of the blob part, not the hash of the base64 encoding.
- property type: BlobCreateType¶
One of RAW_FILE or VISUALIZATION. If VISUALIZATION, the blob may be displayed as an image preview.
- class BlobCreateType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- RAW_FILE = 'RAW_FILE'¶
- VISUALIZATION = 'VISUALIZATION'¶
- static of_unknown(val: str) BlobCreateType ¶
- class BlobMultipartCreate¶
Bases:
object
- __init__(name: str, type: BlobMultipartCreateType, mime_type: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_mime_type'].default) None ¶
Method generated by attrs for class BlobMultipartCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.blob_multipart_create.T ¶
- property type: BlobMultipartCreateType¶
One of RAW_FILE or VISUALIZATION. If VISUALIZATION, the blob may be displayed as an image preview.
- class BlobMultipartCreateType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- RAW_FILE = 'RAW_FILE'¶
- VISUALIZATION = 'VISUALIZATION'¶
- static of_unknown(val: str) BlobMultipartCreateType ¶
- class BlobPart¶
Bases:
object
- __init__(e_tag: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_e_tag'].default, part_number: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_part_number'].default) None ¶
Method generated by attrs for class BlobPart.
- class BlobPartCreate¶
Bases:
object
- __init__(data64: str, md5: str, part_number: int) None ¶
Method generated by attrs for class BlobPartCreate.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.blob_part_create.T ¶
- class BlobUrl¶
Bases:
object
- __init__(download_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_download_url'].default, expires_at: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_expires_at'].default) None ¶
Method generated by attrs for class BlobUrl.
- class BooleanAppConfigItem¶
Bases:
object
- __init__(type: Union[benchling_api_client.v2.types.Unset, BooleanAppConfigItemType] = attr_dict['_type'].default, value: Union[benchling_api_client.v2.types.Unset, None, bool] = attr_dict['_value'].default, description: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_description'].default, required_config: Union[benchling_api_client.v2.types.Unset, bool] = attr_dict['_required_config'].default, api_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_api_url'].default, app: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp] = attr_dict['_app'].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, path: Union[benchling_api_client.v2.types.Unset, List[str]] = attr_dict['_path'].default) None ¶
Method generated by attrs for class BooleanAppConfigItem.
- property app: benchling_api_client.v2.stable.models.app_config_item_api_mixin_app.AppConfigItemApiMixinApp¶
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.boolean_app_config_item.T ¶
- property path: List[str]¶
Array-based representation of config itemâs location in the tree in order from top to bottom.
- property type: BooleanAppConfigItemType¶
- class BooleanAppConfigItemType¶
Bases:
benchling_api_client.v2.extensions.Enums.KnownString
An enumeration.
- BOOLEAN = 'boolean'¶
- static of_unknown(val: str) BooleanAppConfigItemType ¶
- class Box¶
Bases:
object
- __init__(archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, barcode: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_barcode'].default, created_at: Union[benchling_api_client.v2.types.Unset, datetime] = attr_dict['_created_at'].default, creator: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.user_summary.UserSummary] = attr_dict['_creator'].default, empty_containers: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_empty_containers'].default, empty_positions: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_empty_positions'].default, fields: Union[benchling_api_client.v2.types.Unset, Fields] = attr_dict['_fields'].default, filled_positions: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_filled_positions'].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, name: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_name'].default, parent_storage_id: Union[benchling_api_client.v2.types.Unset, None, str] = attr_dict['_parent_storage_id'].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, benchling_api_client.v2.stable.models.schema_summary.SchemaSummary] = attr_dict['_schema'].default, size: Union[benchling_api_client.v2.types.Unset, int] = attr_dict['_size'].default, web_url: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_web_url'].default) None ¶
Method generated by attrs for class Box.
- property archive_record: Optional[benchling_api_client.v2.stable.models.archive_record.ArchiveRecord]¶
- property creator: benchling_api_client.v2.stable.models.user_summary.UserSummary¶
- property empty_positions: int¶
The number of empty positions for adding additional containers in the box.
- classmethod from_dict(src_dict: Dict[str, Any], strict: bool = False) benchling_api_client.v2.stable.models.box.T ¶
- property schema: Optional[benchling_api_client.v2.stable.models.schema_summary.SchemaSummary]¶
- class BoxContentsPaginatedList¶
Bases:
object
- __init__(containers: Union[benchling_api_client.v2.types.Unset, List[ContainerWithCoordinates]] = attr_dict['_containers'].default, next_token: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_next_token'].default) None ¶
Method generated by attrs for class BoxContentsPaginatedList.
- property containers: List[ContainerWithCoordinates]¶
- class BoxCreate¶
Bases:
object
- __init__(schema_id: str, barcode: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_barcode'].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, parent_storage_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_parent_storage_id'].default, project_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_project_id'].default) None ¶
Method generated by attrs for class BoxCreate.
- class BoxSchema¶
Bases:
object
- __init__(container_schema: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.box_schema_container_schema.BoxSchemaContainerSchema] = attr_dict['_container_schema'].default, height: Union[benchling_api_client.v2.types.Unset, float] = attr_dict['_height'].default, type: Union[benchling_api_client.v2.types.Unset, benchling_api_client.v2.stable.models.box_schema_type.BoxSchemaType] = attr_dict['_type'].default, width: Union[benchling_api_client.v2.types.Unset, float] = attr_dict['_width'].default, prefix: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_prefix'].default, registry_id: Union[benchling_api_client.v2.types.Unset, str] = attr_dict['_registry_id'].default, archive_record: Union[benchling_api_client.v2.types.Unset, None, benchling_api_client.v2.stable.models.archive_record.ArchiveRecord] = attr_dict['_archive_record'].default, field_definitions: Union[benchling_api_client.v2.types.Unset, List[Union[benchling_api_client.v2.stable.models.simple_field_definition.SimpleFieldDefinition, benchling_api_client.v2.stable.models.integer_field_definition.IntegerFieldDefinition, benchling_api_client.v2.stable.models.float_field_definition.FloatFieldDefinition, benchling_api_client.v2.stable.models.dropdown_field_definition.DropdownFieldDefinition, benchling_api_client.v2.stable.models.schema_link_field_definition.SchemaLinkFieldDefinition, benchling_api_client.v2.extensions.UnknownType]]] = attr_dict['_field_definitions'].default, id: