Class: SDKItem
sdkApi/interfaces/entities/iItem.SDKItem
Represents an item instance within the SDK.
Implements
Implements
Table of contents
Constructors
Properties
- annotated
- annotations
- createdAt
- creator
- dataset
- datasetId
- description
- dir
- executions
- filename
- id
- metadata
- name
- stream
- thumbnail
- type
- url
Constructors
constructor
• new SDKItem(item)
Creates an instance of SDKItem.
Parameters
| Name | Type | Description |
|---|---|---|
item |
Partial<SDKItem> |
The item properties. |
Properties
annotated
• annotated: boolean | "discarded"
Indicates whether the item has been annotated or discarded.
Implementation of
annotations
• annotations: string
The URL of the Item's annotations.
Implementation of
createdAt
• createdAt: Date
The date and time the item was created.
Implementation of
creator
• creator: string
The creator of the item.
Implementation of
dataset
• dataset: string
The url of the dataset the item belongs to.
datasetId
• datasetId: string
The ID of the dataset the item belongs to.
Implementation of
description
• Optional description: string
Item description.
dir
• dir: string
The directory the item is located in.
Implementation of
executions
• Optional executions: SDKFunctionExecution[]
The list of function executions associated with the item.
filename
• filename: string
The filename of the item.
Implementation of
id
• id: string
The unique ID of the item.
Implementation of
metadata
• metadata: any
The metadata associated with the item.
Implementation of
name
• name: string
The name of the item.
Implementation of
stream
• stream: string
The URL of the Item's stream.
Implementation of
thumbnail
• thumbnail: string
The URL of the item's thumbnail image.
Implementation of
type
• type: "file" | "dir"
The type of the item, either 'file' or 'dir'.
Implementation of
url
• url: string
The URL of the item.