HclsJobs¶
- pydantic model openapi_client.models.hcls_jobs.HclsJobs¶
Request body to start an HCLS data import job. DatasetId and JobName are required by the backend for all store types (not enforced by API Gateway). ImportJobConfig is required by the backend for omics-storage imports.
- Fields:
- field job_name: Optional[StrictStr] = None (alias 'JobName')¶
Name of the import job. Required by the backend. For health-imaging must match ^[A-Za-z0-9_#.-]{1,64}$.
- field description: Optional[StrictStr] = None (alias 'Description')¶
Optional job description.
- field dataset_id: Optional[StrictStr] = None (alias 'DatasetId')¶
Source dataset id. Required by the backend. HealthLake requires completed .ndjson files; health-imaging requires completed .dcm files; omics-storage has filetype/dataset constraints based on store type.
- field import_job_config: Optional[HclsJobsImportJobConfig] = None (alias 'ImportJobConfig')¶
- field schedule_name: Optional[StrictStr] = None (alias 'ScheduleName')¶
Schedule name when the job is triggered by a schedule.
- field schedule_id: Optional[StrictStr] = None (alias 'ScheduleId')¶
Schedule id when the job is triggered by a schedule.
- field trigger_type: Optional[StrictStr] = None (alias 'TriggerType')¶
Trigger source indicator (e.g. schedule).
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- classmethod from_json(json_str)¶
Create an instance of HclsJobs from a JSON string
- Return type:
Optional[Self]
- to_dict()¶
Return the dictionary representation of the model using alias.
This has the following differences from calling pydantic’s self.model_dump(by_alias=True):
None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.
- Return type:
Dict[str,Any]
- classmethod from_dict(obj)¶
Create an instance of HclsJobs from a dict
- Return type:
Optional[Self]