Class AnnotationOutputV1

java.lang.Object
com.seeq.model.AnnotationOutputV1

public class AnnotationOutputV1 extends Object
The list of items requested
  • Constructor Details

    • AnnotationOutputV1

      public AnnotationOutputV1()
  • Method Details

    • assetSelectionIds

      public AnnotationOutputV1 assetSelectionIds(List<String> assetSelectionIds)
    • addAssetSelectionIdsItem

      public AnnotationOutputV1 addAssetSelectionIdsItem(String assetSelectionIdsItem)
    • getAssetSelectionIds

      public List<String> getAssetSelectionIds()
      The IDs of Asset Selections included in this Report. Ignored for Journals
      Returns:
      assetSelectionIds
    • setAssetSelectionIds

      public void setAssetSelectionIds(List<String> assetSelectionIds)
    • background

      public AnnotationOutputV1 background(Boolean background)
    • getBackground

      public Boolean getBackground()
      Whether the Report, if scheduled, should continue to update if there are no subscribers (i.e. in the background). Ignored for Journals
      Returns:
      background
    • setBackground

      public void setBackground(Boolean background)
    • backups

      public AnnotationOutputV1 backups(List<DocumentBackupOutputV1> backups)
    • addBackupsItem

      public AnnotationOutputV1 addBackupsItem(DocumentBackupOutputV1 backupsItem)
    • getBackups

      public List<DocumentBackupOutputV1> getBackups()
      The list of backups for this Annotation's Document property
      Returns:
      backups
    • setBackups

      public void setBackups(List<DocumentBackupOutputV1> backups)
    • ckEnabled

      public AnnotationOutputV1 ckEnabled(Boolean ckEnabled)
    • getCkEnabled

      public Boolean getCkEnabled()
      Whether the Report/Journal is using CKEditor
      Returns:
      ckEnabled
    • setCkEnabled

      public void setCkEnabled(Boolean ckEnabled)
    • contentIds

      public AnnotationOutputV1 contentIds(List<String> contentIds)
    • addContentIdsItem

      public AnnotationOutputV1 addContentIdsItem(String contentIdsItem)
    • getContentIds

      public List<String> getContentIds()
      The IDs of Content included in this Report. Ignored for Journals
      Returns:
      contentIds
    • setContentIds

      public void setContentIds(List<String> contentIds)
    • createdAt

      public AnnotationOutputV1 createdAt(String createdAt)
    • getCreatedAt

      public String getCreatedAt()
      The ISO 8601 date of when the annotation was created (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)
      Returns:
      createdAt
    • setCreatedAt

      public void setCreatedAt(String createdAt)
    • createdBy

      public AnnotationOutputV1 createdBy(ItemPreviewV1 createdBy)
    • getCreatedBy

      public ItemPreviewV1 getCreatedBy()
      Get createdBy
      Returns:
      createdBy
    • setCreatedBy

      public void setCreatedBy(ItemPreviewV1 createdBy)
    • cronSchedule

      public AnnotationOutputV1 cronSchedule(List<String> cronSchedule)
    • addCronScheduleItem

      public AnnotationOutputV1 addCronScheduleItem(String cronScheduleItem)
    • getCronSchedule

      public List<String> getCronSchedule()
      Report update period. Ignored for Journals
      Returns:
      cronSchedule
    • setCronSchedule

      public void setCronSchedule(List<String> cronSchedule)
    • dateRangeIds

      public AnnotationOutputV1 dateRangeIds(List<String> dateRangeIds)
    • addDateRangeIdsItem

      public AnnotationOutputV1 addDateRangeIdsItem(String dateRangeIdsItem)
    • getDateRangeIds

      public List<String> getDateRangeIds()
      The IDs of Date Ranges included in this Report. Ignored for Journals
      Returns:
      dateRangeIds
    • setDateRangeIds

      public void setDateRangeIds(List<String> dateRangeIds)
    • description

      public AnnotationOutputV1 description(String description)
    • getDescription

      public String getDescription()
      Clarifying information or other plain language description of this item
      Returns:
      description
    • setDescription

      public void setDescription(String description)
    • discoverable

      public AnnotationOutputV1 discoverable(Boolean discoverable)
    • getDiscoverable

      public Boolean getDiscoverable()
      Flag indicating whether this annotation is discoverable
      Returns:
      discoverable
    • setDiscoverable

      public void setDiscoverable(Boolean discoverable)
    • document

      public AnnotationOutputV1 document(String document)
    • getDocument

      public String getDocument()
      This annotation's document.
      Returns:
      document
    • setDocument

      public void setDocument(String document)
    • effectivePermissions

      public AnnotationOutputV1 effectivePermissions(PermissionsV1 effectivePermissions)
    • getEffectivePermissions

      public PermissionsV1 getEffectivePermissions()
      Get effectivePermissions
      Returns:
      effectivePermissions
    • setEffectivePermissions

      public void setEffectivePermissions(PermissionsV1 effectivePermissions)
    • enabled

      public AnnotationOutputV1 enabled(Boolean enabled)
    • getEnabled

      public Boolean getEnabled()
      Whether the Report is enabled to run jobs. Ignored for Journals
      Returns:
      enabled
    • setEnabled

      public void setEnabled(Boolean enabled)
    • fixedWidth

      public AnnotationOutputV1 fixedWidth(Boolean fixedWidth)
    • getFixedWidth

      public Boolean getFixedWidth()
      Whether the Report has a fixed width. Ignored for Journals
      Returns:
      fixedWidth
    • setFixedWidth

      public void setFixedWidth(Boolean fixedWidth)
    • id

      public AnnotationOutputV1 id(String id)
    • getId

      public String getId()
      The ID that can be used to interact with the item
      Returns:
      id
    • setId

      public void setId(String id)
    • interests

      public AnnotationOutputV1 interests(List<AnnotationInterestOutputV1> interests)
    • addInterestsItem

      public AnnotationOutputV1 addInterestsItem(AnnotationInterestOutputV1 interestsItem)
    • getInterests

      public List<AnnotationInterestOutputV1> getInterests()
      The list of the annotation's items of interest
      Returns:
      interests
    • setInterests

      public void setInterests(List<AnnotationInterestOutputV1> interests)
    • isArchived

      public AnnotationOutputV1 isArchived(Boolean isArchived)
    • getIsArchived

      public Boolean getIsArchived()
      Whether item is archived
      Returns:
      isArchived
    • setIsArchived

      public void setIsArchived(Boolean isArchived)
    • isRedacted

      public AnnotationOutputV1 isRedacted(Boolean isRedacted)
    • getIsRedacted

      public Boolean getIsRedacted()
      Whether item is redacted
      Returns:
      isRedacted
    • setIsRedacted

      public void setIsRedacted(Boolean isRedacted)
    • name

      public AnnotationOutputV1 name(String name)
    • getName

      public String getName()
      The human readable name
      Returns:
      name
    • setName

      public void setName(String name)
    • nextRunTime

      public AnnotationOutputV1 nextRunTime(String nextRunTime)
    • getNextRunTime

      public String getNextRunTime()
      The next scheduled runtime for this Report, based on its Date Ranges. Ignored for Journals
      Returns:
      nextRunTime
    • setNextRunTime

      public void setNextRunTime(String nextRunTime)
    • publishedAt

      public AnnotationOutputV1 publishedAt(String publishedAt)
    • getPublishedAt

      public String getPublishedAt()
      The ISO 8601 date of when the report was published (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)
      Returns:
      publishedAt
    • setPublishedAt

      public void setPublishedAt(String publishedAt)
    • replies

      public AnnotationOutputV1 replies(List<AnnotationOutputV1> replies)
    • addRepliesItem

      public AnnotationOutputV1 addRepliesItem(AnnotationOutputV1 repliesItem)
    • getReplies

      public List<AnnotationOutputV1> getReplies()
      The list of Annotations that are replies to this one
      Returns:
      replies
    • setReplies

      public void setReplies(List<AnnotationOutputV1> replies)
    • repliesTo

      public AnnotationOutputV1 repliesTo(String repliesTo)
    • getRepliesTo

      public String getRepliesTo()
      ID of the Annotation to which this is a reply
      Returns:
      repliesTo
    • setRepliesTo

      public void setRepliesTo(String repliesTo)
    • reportsOn

      public AnnotationOutputV1 reportsOn(String reportsOn)
    • getReportsOn

      public String getReportsOn()
      The ID of the Worksheet that the Report is associated to
      Returns:
      reportsOn
    • setReportsOn

      public void setReportsOn(String reportsOn)
    • statusMessage

      public AnnotationOutputV1 statusMessage(String statusMessage)
    • getStatusMessage

      public String getStatusMessage()
      A plain language status message with information about any issues that may have been encountered during an operation
      Returns:
      statusMessage
    • setStatusMessage

      public void setStatusMessage(String statusMessage)
    • timezone

      public AnnotationOutputV1 timezone(String timezone)
    • getTimezone

      public String getTimezone()
      The IANA string name of the time zone of the report. Ignored for Journals
      Returns:
      timezone
    • setTimezone

      public void setTimezone(String timezone)
    • translationKey

      public AnnotationOutputV1 translationKey(String translationKey)
    • getTranslationKey

      public String getTranslationKey()
      The item's translation key, if any
      Returns:
      translationKey
    • setTranslationKey

      public void setTranslationKey(String translationKey)
    • type

      public AnnotationOutputV1 type(String type)
    • getType

      public String getType()
      The type of the item
      Returns:
      type
    • setType

      public void setType(String type)
    • updatedAt

      public AnnotationOutputV1 updatedAt(String updatedAt)
    • getUpdatedAt

      public String getUpdatedAt()
      The ISO 8601 date of when the annotation was updated (YYYY-MM-DDThh:mm:ss.sssssssss±hh:mm)
      Returns:
      updatedAt
    • setUpdatedAt

      public void setUpdatedAt(String updatedAt)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object