Class WorkbookProperties


  • public final class WorkbookProperties
    extends Object
    Properties that contain a workbook.
    • Constructor Detail

      • WorkbookProperties

        public WorkbookProperties()
    • 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 WorkbookProperties 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 WorkbookProperties 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 WorkbookProperties 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 WorkbookProperties object itself.
      • version

        public String version()
        Get the version property: Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData.
        Returns:
        the version value.
      • withVersion

        public WorkbookProperties withVersion​(String version)
        Set the version property: Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData.
        Parameters:
        version - the version value to set.
        Returns:
        the WorkbookProperties object itself.
      • timeModified

        public OffsetDateTime timeModified()
        Get the timeModified property: Date and time in UTC of the last modification that was made to this workbook definition.
        Returns:
        the timeModified value.
      • category

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

        public WorkbookProperties 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 WorkbookProperties object itself.
      • tags

        public List<String> tags()
        Get the tags property: Being deprecated, please use the other tags field.
        Returns:
        the tags value.
      • withTags

        public WorkbookProperties withTags​(List<String> tags)
        Set the tags property: Being deprecated, please use the other tags field.
        Parameters:
        tags - the tags value to set.
        Returns:
        the WorkbookProperties object itself.
      • userId

        public String userId()
        Get the userId property: Unique user id of the specific user that owns this workbook.
        Returns:
        the userId value.
      • sourceId

        public String sourceId()
        Get the sourceId property: ResourceId for a source resource.
        Returns:
        the sourceId value.
      • withSourceId

        public WorkbookProperties withSourceId​(String sourceId)
        Set the sourceId property: ResourceId for a source resource.
        Parameters:
        sourceId - the sourceId value to set.
        Returns:
        the WorkbookProperties object itself.
      • storageUri

        public String storageUri()
        Get the storageUri property: The resourceId to the storage account when bring your own storage is used.
        Returns:
        the storageUri value.
      • withStorageUri

        public WorkbookProperties withStorageUri​(String storageUri)
        Set the storageUri property: The resourceId to the storage account when bring your own storage is used.
        Parameters:
        storageUri - the storageUri value to set.
        Returns:
        the WorkbookProperties object itself.
      • description

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

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

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

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