Models¶

pydantic model aind_watchdog_service.models.manifest_config.ManifestConfig[source]¶

Bases: BaseModel

Job configs for data transfer to VAST and executing a custom script

Show JSON schema

{
   "title": "ManifestConfig",
   "description": "Job configs for data transfer to VAST and executing a custom script",
   "type": "object",
   "properties": {
      "name": {
         "description": "Unique name for session data assets",
         "title": "Unique name",
         "type": "string"
      },
      "processor_full_name": {
         "description": "User who processed the data",
         "title": "Processor name",
         "type": "string"
      },
      "subject_id": {
         "description": "Subject ID",
         "title": "Subject ID",
         "type": "integer"
      },
      "acquisition_datetime": {
         "description": "Acquisition datetime",
         "format": "date-time",
         "title": "Acquisition datetime",
         "type": "string"
      },
      "schedule_time": {
         "anyOf": [
            {
               "format": "time",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Transfer time to schedule copy and upload. If None defaults to trigger the transfer immediately",
         "title": "APScheduler transfer time"
      },
      "force_cloud_sync": {
         "default": false,
         "description": "Overwrite data in AWS",
         "title": "Force cloud sync",
         "type": "boolean"
      },
      "transfer_endpoint": {
         "default": "http://aind-data-transfer-service/api/v1/submit_jobs",
         "description": "Transfer endpoint for data transfer",
         "title": "Transfer endpoint",
         "type": "string"
      },
      "platform": {
         "description": "Platform type",
         "enum": [
            "confocal",
            "exaSPIM",
            "ISI",
            "MRI",
            "MERFISH",
            "single-plane-ophys",
            "multiplane-ophys",
            "SmartSPIM",
            "SLAP2",
            "FIP",
            "ecephys",
            "mesoSPIM",
            "behavior",
            "HCR",
            "motor-observatory",
            "HSFP"
         ],
         "title": "Platform type",
         "type": "string"
      },
      "capsule_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Capsule ID of pipeline to run",
         "title": "Capsule"
      },
      "mount": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Mount point for pipeline run",
         "title": "Mount point"
      },
      "s3_bucket": {
         "allOf": [
            {
               "$ref": "#/$defs/BucketType"
            }
         ],
         "default": "private",
         "description": "s3 endpoint",
         "title": "S3 endpoint"
      },
      "project_name": {
         "description": "Project name",
         "title": "Project name",
         "type": "string"
      },
      "destination": {
         "description": "Remote directory on VAST where to copy the data to.",
         "examples": [
            "\\\\allen\\aind\\scratch\\test"
         ],
         "title": "Destination directory",
         "type": "string"
      },
      "modalities": {
         "additionalProperties": {
            "items": {
               "type": "string"
            },
            "type": "array"
         },
         "default": {},
         "description": "list of ModalityFile objects containing modality names and associated files or directories",
         "title": "modality files",
         "type": "object"
      },
      "schemas": {
         "default": [],
         "description": "Where schema files to be uploaded are saved",
         "items": {
            "type": "string"
         },
         "title": "Schema directory",
         "type": "array"
      },
      "script": {
         "additionalProperties": {
            "items": {
               "type": "string"
            },
            "type": "array"
         },
         "default": {},
         "description": "Set of commands to run in subprocess.",
         "title": "Commands",
         "type": "object"
      }
   },
   "$defs": {
      "BucketType": {
         "description": "Types of s3 bucket users can write to through service",
         "enum": [
            "private",
            "open",
            "scratch"
         ],
         "title": "BucketType",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "processor_full_name",
      "subject_id",
      "acquisition_datetime",
      "platform",
      "project_name",
      "destination"
   ]
}

Config:

extra: str = forbid

Fields:

acquisition_datetime (datetime.datetime)
capsule_id (str | None)
destination (str)
force_cloud_sync (bool)
modalities (Dict[Literal['confocal', 'ISI', 'icephys', 'MRI', 'pophys', 'fMOST', 'behavior-videos', 'ecephys', 'slap', 'SPIM', 'fib', 'EMG', 'behavior', 'merfish'], List[str]])
mount (str | None)
name (str)
platform (Literal['confocal', 'exaSPIM', 'ISI', 'MRI', 'MERFISH', 'single-plane-ophys', 'multiplane-ophys', 'SmartSPIM', 'SLAP2', 'FIP', 'ecephys', 'mesoSPIM', 'behavior', 'HCR', 'motor-observatory', 'HSFP'])
processor_full_name (str)
project_name (str)
s3_bucket (aind_data_transfer_models.core.BucketType)
schedule_time (datetime.time | None)
schemas (List[str])
script (Dict[str, List[str]])
subject_id (int)
transfer_endpoint (str)

Validators:

normalize_modalities » modalities
normalize_platform » platform
normalized_scheduled_time » schedule_time
validate_capsule » all fields
validate_destination_path » destination
validate_modality_paths » modalities
validate_schema_paths » schemas

field acquisition_datetime: datetime [Required][source]¶

Acquisition datetime

Validated by:

validate_capsule

field capsule_id: str | None = None[source]¶

Capsule ID of pipeline to run

Validated by:

validate_capsule

field destination: str [Required][source]¶

Remote directory on VAST where to copy the data to.

Validated by:

validate_capsule
validate_destination_path

field force_cloud_sync: bool = False[source]¶

Overwrite data in AWS

Validated by:

validate_capsule

field modalities: List[str]] = {}[source]¶

list of ModalityFile objects containing modality names and associated files or directories

Validated by:

normalize_modalities
validate_capsule
validate_modality_paths

field mount: str | None = None[source]¶

Mount point for pipeline run

Validated by:

validate_capsule

field name: str [Required][source]¶

Unique name for session data assets

Validated by:

validate_capsule

field platform: Literal['confocal', 'exaSPIM', 'ISI', 'MRI', 'MERFISH', 'single-plane-ophys', 'multiplane-ophys', 'SmartSPIM', 'SLAP2', 'FIP', 'ecephys', 'mesoSPIM', 'behavior', 'HCR', 'motor-observatory', 'HSFP'] [Required][source]¶

Platform type

Validated by:

normalize_platform
validate_capsule

field processor_full_name: str [Required][source]¶

User who processed the data

Validated by:

validate_capsule

field project_name: str [Required][source]¶

Project name

Validated by:

validate_capsule

field s3_bucket: BucketType = BucketType.PRIVATE[source]¶

s3 endpoint

Validated by:

validate_capsule

field schedule_time: time | None = None[source]¶

Transfer time to schedule copy and upload. If None defaults to trigger the transfer immediately

Validated by:

normalized_scheduled_time
validate_capsule

field schemas: List[str] = [][source]¶

Where schema files to be uploaded are saved

Validated by:

validate_capsule
validate_schema_paths

field script: Dict[str, List[str]] = {}[source]¶

Set of commands to run in subprocess.

Validated by:

validate_capsule

field subject_id: int [Required][source]¶

Subject ID

Validated by:

validate_capsule

field transfer_endpoint: str = 'http://aind-data-transfer-service/api/v1/submit_jobs'[source]¶

Transfer endpoint for data transfer

Validated by:

validate_capsule

validator normalize_modalities » modalities[source]¶: Normalize modalities

validator normalize_platform » platform[source]¶: Normalize modalities

validator normalized_scheduled_time » schedule_time[source]¶: Normalize scheduled time

validator validate_capsule » all fields[source]¶: Validate capsule and mount

validator validate_destination_path » destination[source]¶

validator validate_modality_paths » modalities[source]¶

validator validate_schema_paths » schemas[source]¶

pydantic model aind_watchdog_service.models.watch_config.WatchConfig[source]¶

Bases: BaseModel

Configuration for rig

Show JSON schema

{
   "title": "WatchConfig",
   "description": "Configuration for rig",
   "type": "object",
   "properties": {
      "flag_dir": {
         "description": "Directory for watchdog to poll",
         "title": "Poll directory",
         "type": "string"
      },
      "manifest_complete": {
         "description": "Manifest directory for triggered data",
         "title": "Manifest complete directory",
         "type": "string"
      },
      "webhook_url": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Teams webhook url for user notification",
         "title": "Teams webhook url"
      }
   },
   "required": [
      "flag_dir",
      "manifest_complete"
   ]
}

Fields:

flag_dir (str)
manifest_complete (str)
webhook_url (str | None)

field flag_dir: str [Required][source]¶: Directory for watchdog to poll

field manifest_complete: str [Required][source]¶: Manifest directory for triggered data

field webhook_url: str | None = None[source]¶: Teams webhook url for user notification