ask_smapi_model.v1.catalog.upload package

Submodules

Note

Canonical imports have been added in the __init__.py of the package. This helps in importing the class directly from the package, than through the module.

For eg: if package a has module b with class C, you can do from a import C instead of from a.b import C.

ask_smapi_model.v1.catalog.upload.catalog_upload_base module

class ask_smapi_model.v1.catalog.upload.catalog_upload_base.CatalogUploadBase

Bases: object

attribute_map = {}

deserialized_types = {}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.content_upload_file_summary module

class ask_smapi_model.v1.catalog.upload.content_upload_file_summary.ContentUploadFileSummary(download_url=None, expires_at=None, status=None)

Bases: object

Parameters:

• download_url ((optional) str) – If the file is available for download, downloadUrl can be used to download the file.
• expires_at ((optional) datetime) –
• status ((optional) ask_smapi_model.v1.catalog.upload.file_upload_status.FileUploadStatus) –

attribute_map = {'download_url': 'downloadUrl', 'expires_at': 'expiresAt', 'status': 'status'}

deserialized_types = {'download_url': 'str', 'expires_at': 'datetime', 'status': 'ask_smapi_model.v1.catalog.upload.file_upload_status.FileUploadStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.file_upload_status module

class ask_smapi_model.v1.catalog.upload.file_upload_status.FileUploadStatus

Bases: enum.Enum

Value of status depends on if file is available for download or not.

Allowed enum values: [PENDING, AVAILABLE, PURGED, UNAVAILABLE]

AVAILABLE = 'AVAILABLE'

PENDING = 'PENDING'

PURGED = 'PURGED'

UNAVAILABLE = 'UNAVAILABLE'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.get_content_upload_response module

class ask_smapi_model.v1.catalog.upload.get_content_upload_response.GetContentUploadResponse(id=None, catalog_id=None, status=None, created_date=None, last_updated_date=None, file=None, ingestion_steps=None)

Bases: object

Parameters:

• id ((optional) str) – Unique identifier of the upload
• catalog_id ((optional) str) – Unique identifier of the added catalog object
• status ((optional) ask_smapi_model.v1.catalog.upload.upload_status.UploadStatus) –
• created_date ((optional) datetime) –
• last_updated_date ((optional) datetime) –
• file ((optional) ask_smapi_model.v1.catalog.upload.content_upload_file_summary.ContentUploadFileSummary) –
• ingestion_steps ((optional) list[ask_smapi_model.v1.catalog.upload.upload_ingestion_step.UploadIngestionStep]) – List of different steps performed on the upload.

attribute_map = {'catalog_id': 'catalogId', 'created_date': 'createdDate', 'file': 'file', 'id': 'id', 'ingestion_steps': 'ingestionSteps', 'last_updated_date': 'lastUpdatedDate', 'status': 'status'}

deserialized_types = {'catalog_id': 'str', 'created_date': 'datetime', 'file': 'ask_smapi_model.v1.catalog.upload.content_upload_file_summary.ContentUploadFileSummary', 'id': 'str', 'ingestion_steps': 'list[ask_smapi_model.v1.catalog.upload.upload_ingestion_step.UploadIngestionStep]', 'last_updated_date': 'datetime', 'status': 'ask_smapi_model.v1.catalog.upload.upload_status.UploadStatus'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.ingestion_status module

class ask_smapi_model.v1.catalog.upload.ingestion_status.IngestionStatus

Bases: enum.Enum

Allowed enum values: [PENDING, IN_PROGRESS, FAILED, SUCCEEDED, CANCELLED]

CANCELLED = 'CANCELLED'

FAILED = 'FAILED'

IN_PROGRESS = 'IN_PROGRESS'

PENDING = 'PENDING'

SUCCEEDED = 'SUCCEEDED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.ingestion_step_name module

class ask_smapi_model.v1.catalog.upload.ingestion_step_name.IngestionStepName

Bases: enum.Enum

Allowed enum values: [UPLOAD, SCHEMA_VALIDATION]

SCHEMA_VALIDATION = 'SCHEMA_VALIDATION'

UPLOAD = 'UPLOAD'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.location module

class ask_smapi_model.v1.catalog.upload.location.Location(location=None)

Bases: ask_smapi_model.v1.catalog.upload.catalog_upload_base.CatalogUploadBase

Request body for self-hosted catalog uploads

Parameters:location ((optional) str) – self hosted url location.

attribute_map = {'location': 'location'}

deserialized_types = {'location': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.pre_signed_url module

class ask_smapi_model.v1.catalog.upload.pre_signed_url.PreSignedUrl(url_id=None, part_e_tags=None)

Bases: ask_smapi_model.v1.catalog.upload.catalog_upload_base.CatalogUploadBase

Request body for self-hosted catalog uploads

Parameters:

• url_id ((optional) str) – Unique identifier for urls
• part_e_tags ((optional) list[ask_smapi_model.v1.catalog.upload.pre_signed_url_item.PreSignedUrlItem]) – List of (eTag, part number) pairs for each part of the file uploaded

attribute_map = {'part_e_tags': 'partETags', 'url_id': 'urlId'}

deserialized_types = {'part_e_tags': 'list[ask_smapi_model.v1.catalog.upload.pre_signed_url_item.PreSignedUrlItem]', 'url_id': 'str'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.pre_signed_url_item module

class ask_smapi_model.v1.catalog.upload.pre_signed_url_item.PreSignedUrlItem(e_tag=None, part_number=None)

Bases: object

Parameters:

• e_tag ((optional) str) –
• part_number ((optional) int) –

attribute_map = {'e_tag': 'eTag', 'part_number': 'partNumber'}

deserialized_types = {'e_tag': 'str', 'part_number': 'int'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.upload_ingestion_step module

class ask_smapi_model.v1.catalog.upload.upload_ingestion_step.UploadIngestionStep(name=None, status=None, log_url=None, violations=None)

Bases: object

Represents a single step in the multi-step ingestion process of a new upload.

Parameters:

• name ((optional) ask_smapi_model.v1.catalog.upload.ingestion_step_name.IngestionStepName) –
• status ((optional) ask_smapi_model.v1.catalog.upload.ingestion_status.IngestionStatus) –
• log_url ((optional) str) – Url for the file containing logs of ingestion step.
• violations ((optional) list[ask_smapi_model.v1.error.Error]) – This array will contain the violations occurred during the execution of step. Will be empty, if execution succeeded.

attribute_map = {'log_url': 'logUrl', 'name': 'name', 'status': 'status', 'violations': 'violations'}

deserialized_types = {'log_url': 'str', 'name': 'ask_smapi_model.v1.catalog.upload.ingestion_step_name.IngestionStepName', 'status': 'ask_smapi_model.v1.catalog.upload.ingestion_status.IngestionStatus', 'violations': 'list[ask_smapi_model.v1.error.Error]'}

supports_multiple_types = False

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

ask_smapi_model.v1.catalog.upload.upload_status module

class ask_smapi_model.v1.catalog.upload.upload_status.UploadStatus

Bases: enum.Enum

Status of the entire upload.

Allowed enum values: [PENDING, IN_PROGRESS, FAILED, SUCCEEDED]

FAILED = 'FAILED'

IN_PROGRESS = 'IN_PROGRESS'

PENDING = 'PENDING'

SUCCEEDED = 'SUCCEEDED'

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model