nisystemlink
0.1
  • Getting Started
  • API Reference
    • nisystemlink.clients.core
    • nisystemlink.clients.alarm
    • nisystemlink.clients.tag
    • nisystemlink.clients.product
    • nisystemlink.clients.testmonitor
    • nisystemlink.clients.dataframe
    • nisystemlink.clients.spec
    • nisystemlink.clients.file
    • nisystemlink.clients.notebook
    • nisystemlink.clients.feeds
    • nisystemlink.clients.assetmanagement
    • nisystemlink.clients.systems
    • nisystemlink.clients.work_item
    • nisystemlink.clients.test_plan
    • nisystemlink.clients.artifact
      • ArtifactClient
        • ArtifactClient.__init__()
        • ArtifactClient.upload_artifact()
        • ArtifactClient.download_artifact()
        • ArtifactClient.delete_artifact()
      • UploadArtifactResponse
        • UploadArtifactResponse.id
    • nisystemlink.clients.notification
    • Indices and tables
nisystemlink
  • API Reference
  • nisystemlink.clients.artifact
  • View page source

nisystemlink.clients.artifact

class nisystemlink.clients.artifact.ArtifactClient(configuration=None)[source]
__init__(configuration=None)[source]

Initialize an instance.

Parameters

configuration (Optional[nisystemlink.clients.core.HttpConfiguration]) – Defines the web server to connect to and information about how to connect. If not provided, the HttpConfigurationManager is used to obtain the configuration.

Raises

ApiException – if unable to communicate with the Notebook execution Service.

upload_artifact(workspace, artifact)[source]

Uploads an artifact.

Parameters
  • workspace (str) – The workspace containing the artifact.

  • artifact (BinaryIO) – The artifact to upload.

Returns

The response containing the artifact ID.

Return type

UploadArtifactResponse

download_artifact(id)[source]

Downloads an artifact.

Parameters

id (uplink.arguments.Path) – The ID of the artifact to download.

Return type

nisystemlink.clients.core.helpers.IteratorFileLike

Returns

A file-like object for reading the artifact content.

delete_artifact(id)[source]

Deletes an artifact.

Parameters

id (str) – The ID of the artifact to delete.

Return type

None

pydantic model nisystemlink.clients.artifact.models.UploadArtifactResponse[source]

Response for an artifact upload request.

Show JSON schema
{
   "title": "UploadArtifactResponse",
   "description": "Response for an artifact upload request.",
   "type": "object",
   "properties": {
      "id": {
         "title": "Id",
         "type": "string"
      }
   },
   "required": [
      "id"
   ]
}

Fields
  • id

field id: str [Required]

Information about the uploaded artifact.

Previous Next

© Copyright 2020, National Instruments.

Built with Sphinx using a theme provided by Read the Docs.