FileAddDelete

pydantic model openapi_client.models.file_add_delete.FileAddDelete

Request body for delete_dataset_files (PUT /datasets/{id}/files). Operation selects the manage action; grant/revoke require query action=tag_files.

Fields:

• file_copy_type (str | None)

• file_level_tags (List[openapi_client.models.file_add_delete_file_level_tags_inner.FileAddDeleteFileLevelTagsInner] | None)

• file_search_tags (List[str] | None)

• files (List[str])

• is_domain_access_requested (bool | None)

• operation (str)

• restore_exp_days (int | None)

• restore_from_storage (str | None)

• retrieval_option (str | None)

• tags (List[str] | None)

• truncate_dataset (bool | None)

field operation: StrictStr [Required] (alias 'Operation')

File operation to perform

Constraints:

• strict = True

field files: Annotated[List[StrictStr], Field(max_length=300)] [Required] (alias 'Files')

File names/keys to operate on. Max 100 for delete/permanent_delete (non-truncate) and grant/revoke; max 300 for restore_from_archive. May be empty for truncate or grant/revoke-all-files.

Constraints:

• max_length = 300

field file_search_tags: Optional[List[StrictStr]] = None (alias 'FileSearchTags')

Simple string tags for search/classification (update_tags)

field file_level_tags: Optional[List[FileAddDeleteFileLevelTagsInner]] = None (alias 'FileLevelTags')

File-level tags applied for grant/revoke (TagKey#TagValue)

field truncate_dataset: Optional[StrictBool] = None (alias 'TruncateDataset')

For delete/permanent_delete, send explicitly (false when not truncating). true only with permanent_delete to truncate all files asynchronously

field is_domain_access_requested: Optional[StrictBool] = None (alias 'IsDomainAccessRequested')

When granting file tags, also request domain access for missing read-only tags

field tags: Optional[List[StrictStr]] = None (alias 'Tags')

Legacy optional string tags; prefer FileLevelTags or FileSearchTags

field restore_from_storage: Optional[StrictStr] = None (alias 'RestoreFromStorage')

Archived storage class to restore from (required for restore_from_archive)

field file_copy_type: Optional[StrictStr] = None (alias 'FileCopyType')

Restore copy type for archive restoration (required for restore_from_archive)

field restore_exp_days: Optional[StrictInt] = None (alias 'RestoreExpDays')

Days temporary restored copy remains available (required when FileCopyType is temporary; default 7)

field retrieval_option: Optional[StrictStr] = None (alias 'RetrievalOption')

Archive retrieval tier; Expedited only valid for GLACIER (required for restore_from_archive)

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 FileAddDelete 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 FileAddDelete from a dict

Return type:

Optional[Self]