HclsWorkflowRun¶
- pydantic model openapi_client.models.hcls_workflow_run.HclsWorkflowRun¶
Request body to start an Omics workflow run. WorkflowRunName and WorkflowRunLogLevel are required by the backend (not enforced by API Gateway).
- Fields:
- field workflow_run_name: Optional[StrictStr] = None (alias 'WorkflowRunName')¶
Run name. Required by the backend. Pattern ^[w-]{1,128}$.
- field storage_capacity: Optional[Annotated[int, Field(le=20000, strict=True, ge=1)]] = None (alias 'StorageCapacity')¶
Optional run storage capacity in GB (1-20000).
- field workflow_run_log_level: Optional[StrictStr] = None (alias 'WorkflowRunLogLevel')¶
Logging level for the run. Required by the backend. The backend compares this value case-insensitively, so lowercase equivalents are also accepted.
- field workflow_run_params: Optional[Dict[str, Any]] = None (alias 'WorkflowRunParams')¶
Optional workflow input parameters object.
- 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 HclsWorkflowRun 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 HclsWorkflowRun from a dict
- Return type:
Optional[Self]