The Instance Entity
catalytic.sdk.entities.Instance
Common Properties
These are the most commonly used properties of an Instance
.
Name | Return Type | Description |
---|---|---|
getId | UUID | The unique ID of the Instance |
getWorkflowId | UUID | The unique ID of the Workflow the Instance was started from |
getName | String | The descriptive name of the Instance |
getDescription | String | A description of the Instance |
getCategory | String | A descriptive grouping for your Instance |
getStatus | String | Running , Completed or Cancelled |
getStartDate | OffsetDateTime | The timestamp that the Instance was started |
getEndDate | OffsetDateTime | The timestamp that the Instance was ended |
getFields | List< Field> | The fields containing the data for the Instance |
getSteps | List< InstanceStep> | The steps of the Instance |
Permission and Visibility Properties
These are the properties that determine how users can find, or update an Instance
.
Name | Return Type | Description |
---|---|---|
getFieldVisibility | FieldVisibility | The default visiblity level of fields for the InstancePublic , Internal , Confidential or HighlyConfidential |
getVisibility | InstanceVisibility | The visbility level of the InstanceOpen or Restricted |
getVisibleToUsers | List<String> | The users or groups who who may view this Instance Users will be represented by their Email ,groups by their group name (starting with g_ ). |
Other Properties
These are less commonly used properties, or properties that are often used only with specific interfaces.
Name | Type | Description |
---|---|---|
getIinstanceId | UUID | Read-only alias for Id . |
getReferenceName | String | Read-only alias for Id , represented as a string |
getCreatedBy | String | The email address of the user who started the Instance |
getOwner | String | The email address of the user who is the primary admin for the Instance. |
Constructors
Instance()
Instance(UUID id, UUID workflowId, String name, String teamName, String description, String category, String owner, String createdBy, List<InstanceStep> steps, List<Field> fields, String status, OffsetDateTime startDate, OffsetDateTime endDate, FieldVisibility fieldVisibility, InstanceVisibility instanceVisibility, List<String> visibleToUsers)
Creates a new instance of the Instance
class. Note that this does not create a new, running Instance
on the platform. For that, you must instead call Instances.start
.
Updated almost 3 years ago