Class WorkbookInputV1

java.lang.Object
com.seeq.model.WorkbookInputV1

public class WorkbookInputV1 extends Object
WorkbookInputV1
  • Constructor Details

    • WorkbookInputV1

      public WorkbookInputV1()
  • Method Details

    • branchFrom

      public WorkbookInputV1 branchFrom(String branchFrom)
    • getBranchFrom

      public String getBranchFrom()
      Create a new workbook by duplicating the contents and history of the workbook with the specified ID. When null, no branching will occur; resulting workbook will be empty.
      Returns:
      branchFrom
    • setBranchFrom

      public void setBranchFrom(String branchFrom)
    • description

      public WorkbookInputV1 description(String description)
    • getDescription

      public String getDescription()
      Clarifying information or other plain language description of this item. An input of just whitespaces is equivalent to a null input.
      Returns:
      description
    • setDescription

      public void setDescription(String description)
    • folderId

      public WorkbookInputV1 folderId(String folderId)
    • getFolderId

      public String getFolderId()
      The id of the folder to place the new workbook into. Special values of 'mine' or 'corporate' to place the item in the authenticated user's home folder or the corporate folder, respectively. If null, the workbook will be created in the authenticated user's home folder.
      Returns:
      folderId
    • setFolderId

      public void setFolderId(String folderId)
    • name

      public WorkbookInputV1 name(String name)
    • getName

      public String getName()
      Human readable name. Required during creation. An input of just whitespaces is equivalent to a null input.
      Returns:
      name
    • setName

      public void setName(String name)
    • ownerId

      public WorkbookInputV1 ownerId(String ownerId)
    • getOwnerId

      public String getOwnerId()
      The ID of the User that owns this workbook. If omitted when creating a new Workbook, the authenticated user is used by default. Only administrators may set this value.
      Returns:
      ownerId
    • setOwnerId

      public void setOwnerId(String ownerId)
    • type

      public WorkbookInputV1 type(String type)
    • getType

      public String getType()
      The type of workbook, either 'Analysis' or 'Topic'. Defaults to 'Analysis'.
      Returns:
      type
    • setType

      public void setType(String type)
    • 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