Package com.seeq.model
Class ItemFinderOutputV1
java.lang.Object
com.seeq.model.ItemFinderOutputV1
ItemFinderOutputV1
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddCronScheduleItem
(String cronScheduleItem) addFinderConfigurationsItem
(ItemFinderConfigurationV1 finderConfigurationsItem) addLastRunWarningsItem
(String lastRunWarningsItem) cronSchedule
(List<String> cronSchedule) description
(String description) effectivePermissions
(PermissionsV1 effectivePermissions) boolean
executorId
(String executorId) finderConfigurations
(List<ItemFinderConfigurationV1> finderConfigurations) The item finder's check interval(s) as a list of cron expressions (see https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html)Clarifying information or other plain language description of this itemGet effectivePermissionsWhether this item finder is enabled or notThe ID of the user that runs the job of finding the items.The list of configurations for finding itemsgetId()
The ID that can be used to interact with the itemWhether item is archivedWhether item is redactedThe most recent list of warnings or errors that resulted from evaluating any of the finder configurations, such as items that failed to swapgetName()
The human readable nameA plain language status message with information about any issues that may have been encountered during an operationThe item's translation key, if anygetType()
The type of the itemint
hashCode()
isArchived
(Boolean isArchived) isRedacted
(Boolean isRedacted) lastRunWarnings
(List<String> lastRunWarnings) void
setCronSchedule
(List<String> cronSchedule) void
setDescription
(String description) void
setEffectivePermissions
(PermissionsV1 effectivePermissions) void
setEnabled
(Boolean enabled) void
setExecutorId
(String executorId) void
setFinderConfigurations
(List<ItemFinderConfigurationV1> finderConfigurations) void
void
setIsArchived
(Boolean isArchived) void
setIsRedacted
(Boolean isRedacted) void
setLastRunWarnings
(List<String> lastRunWarnings) void
void
setStatusMessage
(String statusMessage) void
setTranslationKey
(String translationKey) void
statusMessage
(String statusMessage) toString()
translationKey
(String translationKey)
-
Constructor Details
-
ItemFinderOutputV1
public ItemFinderOutputV1()
-
-
Method Details
-
cronSchedule
-
addCronScheduleItem
-
getCronSchedule
The item finder's check interval(s) as a list of cron expressions (see https://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html)- Returns:
- cronSchedule
-
setCronSchedule
-
description
-
getDescription
Clarifying information or other plain language description of this item- Returns:
- description
-
setDescription
-
effectivePermissions
-
getEffectivePermissions
Get effectivePermissions- Returns:
- effectivePermissions
-
setEffectivePermissions
-
enabled
-
getEnabled
Whether this item finder is enabled or not- Returns:
- enabled
-
setEnabled
-
executorId
-
getExecutorId
The ID of the user that runs the job of finding the items. The permissions of this user will be used to determine what items can be read.- Returns:
- executorId
-
setExecutorId
-
finderConfigurations
public ItemFinderOutputV1 finderConfigurations(List<ItemFinderConfigurationV1> finderConfigurations) -
addFinderConfigurationsItem
public ItemFinderOutputV1 addFinderConfigurationsItem(ItemFinderConfigurationV1 finderConfigurationsItem) -
getFinderConfigurations
The list of configurations for finding items- Returns:
- finderConfigurations
-
setFinderConfigurations
-
id
-
getId
The ID that can be used to interact with the item- Returns:
- id
-
setId
-
isArchived
-
getIsArchived
Whether item is archived- Returns:
- isArchived
-
setIsArchived
-
isRedacted
-
getIsRedacted
Whether item is redacted- Returns:
- isRedacted
-
setIsRedacted
-
lastRunWarnings
-
addLastRunWarningsItem
-
getLastRunWarnings
The most recent list of warnings or errors that resulted from evaluating any of the finder configurations, such as items that failed to swap- Returns:
- lastRunWarnings
-
setLastRunWarnings
-
name
-
getName
The human readable name- Returns:
- name
-
setName
-
statusMessage
-
getStatusMessage
A plain language status message with information about any issues that may have been encountered during an operation- Returns:
- statusMessage
-
setStatusMessage
-
translationKey
-
getTranslationKey
The item's translation key, if any- Returns:
- translationKey
-
setTranslationKey
-
type
-
getType
The type of the item- Returns:
- type
-
setType
-
equals
-
hashCode
public int hashCode() -
toString
-