Class WorkbookPropertiesUpdateParameters


  • public final class WorkbookPropertiesUpdateParameters
    extends Object
    Properties that contain a workbook for PATCH operation.
    • Constructor Detail

      • WorkbookPropertiesUpdateParameters

        public WorkbookPropertiesUpdateParameters()
    • Method Detail

      • displayName

        public String displayName()
        Get the displayName property: The user-defined name (display name) of the workbook.
        Returns:
        the displayName value.
      • withDisplayName

        public WorkbookPropertiesUpdateParameters withDisplayName​(String displayName)
        Set the displayName property: The user-defined name (display name) of the workbook.
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the WorkbookPropertiesUpdateParameters object itself.
      • serializedData

        public String serializedData()
        Get the serializedData property: Configuration of this particular workbook. Configuration data is a string containing valid JSON.
        Returns:
        the serializedData value.
      • withSerializedData

        public WorkbookPropertiesUpdateParameters withSerializedData​(String serializedData)
        Set the serializedData property: Configuration of this particular workbook. Configuration data is a string containing valid JSON.
        Parameters:
        serializedData - the serializedData value to set.
        Returns:
        the WorkbookPropertiesUpdateParameters object itself.
      • category

        public String category()
        Get the category property: Workbook category, as defined by the user at creation time.
        Returns:
        the category value.
      • withCategory

        public WorkbookPropertiesUpdateParameters withCategory​(String category)
        Set the category property: Workbook category, as defined by the user at creation time.
        Parameters:
        category - the category value to set.
        Returns:
        the WorkbookPropertiesUpdateParameters object itself.
      • tags

        public List<String> tags()
        Get the tags property: A list of 0 or more tags that are associated with this workbook definition.
        Returns:
        the tags value.
      • withTags

        public WorkbookPropertiesUpdateParameters withTags​(List<String> tags)
        Set the tags property: A list of 0 or more tags that are associated with this workbook definition.
        Parameters:
        tags - the tags value to set.
        Returns:
        the WorkbookPropertiesUpdateParameters object itself.
      • description

        public String description()
        Get the description property: The description of the workbook.
        Returns:
        the description value.
      • withDescription

        public WorkbookPropertiesUpdateParameters withDescription​(String description)
        Set the description property: The description of the workbook.
        Parameters:
        description - the description value to set.
        Returns:
        the WorkbookPropertiesUpdateParameters object itself.
      • revision

        public String revision()
        Get the revision property: The unique revision id for this workbook definition.
        Returns:
        the revision value.
      • withRevision

        public WorkbookPropertiesUpdateParameters withRevision​(String revision)
        Set the revision property: The unique revision id for this workbook definition.
        Parameters:
        revision - the revision value to set.
        Returns:
        the WorkbookPropertiesUpdateParameters object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.