Interface Workbook


  • public interface Workbook
    An immutable client-side representation of Workbook.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String category()
      Gets the category property: Workbook category, as defined by the user at creation time.
      String description()
      Gets the description property: The description of the workbook.
      String displayName()
      Gets the displayName property: The user-defined name (display name) of the workbook.
      String etag()
      Gets the etag property: Resource etag.
      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      WorkbookResourceIdentity identity()
      Gets the identity property: Identity used for BYOS.
      WorkbookInner innerModel()
      Gets the inner com.azure.resourcemanager.applicationinsights.fluent.models.WorkbookInner object.
      Kind kind()
      Gets the kind property: The kind of workbook.
      String location()
      Gets the location property: The geo-location where the resource lives.
      String name()
      Gets the name property: The name of the resource.
      Workbook refresh()
      Refreshes the resource to sync with Azure.
      Workbook refresh​(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      com.azure.core.management.Region region()
      Gets the region of the resource.
      String regionName()
      Gets the name of the resource region.
      String revision()
      Gets the revision property: The unique revision id for this workbook definition.
      String serializedData()
      Gets the serializedData property: Configuration of this particular workbook.
      String sourceId()
      Gets the sourceId property: ResourceId for a source resource.
      String storageUri()
      Gets the storageUri property: The resourceId to the storage account when bring your own storage is used.
      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
      Map<String,​String> tags()
      Gets the tags property: Resource tags.
      List<String> tagsPropertiesTags()
      Gets the tagsPropertiesTags property: Being deprecated, please use the other tags field.
      OffsetDateTime timeModified()
      Gets the timeModified property: Date and time in UTC of the last modification that was made to this workbook definition.
      String type()
      Gets the type property: The type of the resource.
      Workbook.Update update()
      Begins update for the Workbook resource.
      String userId()
      Gets the userId property: Unique user id of the specific user that owns this workbook.
      String version()
      Gets the version property: Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData.
    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.
      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.
      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.
      • location

        String location()
        Gets the location property: The geo-location where the resource lives.
        Returns:
        the location value.
      • tags

        Map<String,​String> tags()
        Gets the tags property: Resource tags.
        Returns:
        the tags value.
      • identity

        WorkbookResourceIdentity identity()
        Gets the identity property: Identity used for BYOS.
        Returns:
        the identity value.
      • kind

        Kind kind()
        Gets the kind property: The kind of workbook. Only valid value is shared.
        Returns:
        the kind value.
      • etag

        String etag()
        Gets the etag property: Resource etag.
        Returns:
        the etag value.
      • systemData

        com.azure.core.management.SystemData systemData()
        Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
        Returns:
        the systemData value.
      • displayName

        String displayName()
        Gets the displayName property: The user-defined name (display name) of the workbook.
        Returns:
        the displayName value.
      • serializedData

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

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

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

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

        List<String> tagsPropertiesTags()
        Gets the tagsPropertiesTags property: Being deprecated, please use the other tags field.
        Returns:
        the tagsPropertiesTags value.
      • userId

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

        String sourceId()
        Gets the sourceId property: ResourceId for a source resource.
        Returns:
        the sourceId value.
      • storageUri

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

        String description()
        Gets the description property: The description of the workbook.
        Returns:
        the description value.
      • revision

        String revision()
        Gets the revision property: The unique revision id for this workbook definition.
        Returns:
        the revision value.
      • region

        com.azure.core.management.Region region()
        Gets the region of the resource.
        Returns:
        the region of the resource.
      • regionName

        String regionName()
        Gets the name of the resource region.
        Returns:
        the name of the resource region.
      • innerModel

        WorkbookInner innerModel()
        Gets the inner com.azure.resourcemanager.applicationinsights.fluent.models.WorkbookInner object.
        Returns:
        the inner object.
      • update

        Workbook.Update update()
        Begins update for the Workbook resource.
        Returns:
        the stage of resource update.
      • refresh

        Workbook refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.
      • refresh

        Workbook refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.