utils.rcclient.entities.artifact
Module Contents
Classes
Attributes
- utils.rcclient.entities.artifact.logger
- class utils.rcclient.entities.artifact.SignedUrlResult
- signedUrl: str
- headers: Dict[str:str]
- classmethod from_(res_dto: utils.rcclient.dtos.response_dtos.UploadSignedUrlResponseDto) SignedUrlResult
- class utils.rcclient.entities.artifact.Artifact
- name: str
- files: List[str]
- artifact_service: ClassVar[utils.rcclient.services.artifact_service.ArtifactService]
- classmethod from_(res_dto: utils.rcclient.dtos.response_dtos.ArtifactResponseDto) Artifact
- classmethod get(name: str) Artifact
Get details of the artifact by name
- Parameters:
name (str) – name of the artifact
- Returns:
Artifact
- classmethod get_all() List[str]
Get all the artifacts that belong to the tenant
- Returns:
list of all the artifact names
- Return type:
List[str]
- classmethod add_file(name: str, file_path: str) None
Add a file from your local file system to the artifact
- Parameters:
name (str) – name of the artifact
file_path (str) – path of the file in your local file system
- classmethod delete_file(name: str, file_name: str) None
Delete a file from the artifact
- Parameters:
name (str) – name of the artifact
file_name (str) – name of the file to be deleted
- classmethod delete(name: str) None
Delete the whole artifact
- Parameters:
name (str) – name of the artifact
- classmethod download_file(name: str, file_name: str, folder: str = None) None
Download a file from artifact to your local file system
- Parameters:
name (str) – name of the artifact
file_name (str) – name of the file in artifact file system
folder (str) – folder path to download, if None, takes current folder
- classmethod download_artifact(name: str, folder: str = None) None
Download all the files in artifact to specified folder :param name: name of the artifact :param folder: folder path to download, if None, takes current folder
Returns:
- classmethod download_for_local(artifact_name: str, tenant_id: str)
Download an artifact for local use. This class method allows the user to download an artifact specified by its name for local use. The artifact will be associated with the specified tenant ID. :param artifact_name: The name of the artifact to be downloaded. :type artifact_name: str :param tenant_id: The ID of the tenant associated with the downloaded artifact. :type tenant_id: str
- Returns:
None