Class WorkbookUpdateParameters


  • public final class WorkbookUpdateParameters
    extends Object
    The parameters that can be provided when updating workbook properties properties.
    • Constructor Detail

      • WorkbookUpdateParameters

        public WorkbookUpdateParameters()
    • Method Detail

      • kind

        public SharedTypeKind kind()
        Get the kind property: The kind of workbook. Only valid value is shared.
        Returns:
        the kind value.
      • withKind

        public WorkbookUpdateParameters withKind​(SharedTypeKind kind)
        Set the kind property: The kind of workbook. Only valid value is shared.
        Parameters:
        kind - the kind value to set.
        Returns:
        the WorkbookUpdateParameters object itself.
      • tags

        public Map<String,​String> tags()
        Get the tags property: Resource tags.
        Returns:
        the tags value.
      • withTags

        public WorkbookUpdateParameters withTags​(Map<String,​String> tags)
        Set the tags property: Resource tags.
        Parameters:
        tags - the tags value to set.
        Returns:
        the WorkbookUpdateParameters object itself.
      • displayName

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

        public WorkbookUpdateParameters 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 WorkbookUpdateParameters 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 WorkbookUpdateParameters 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 WorkbookUpdateParameters 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 WorkbookUpdateParameters 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 WorkbookUpdateParameters object itself.
      • tagsPropertiesTags

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

        public WorkbookUpdateParameters withTagsPropertiesTags​(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 WorkbookUpdateParameters object itself.
      • description

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

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

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

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

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