Package com.azure.resourcemanager.securityinsights.models

Interface Watchlist

  • public interface Watchlist
    An immutable client-side representation of Watchlist.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String contentType()
      Gets the contentType property: The content type of the raw content.
      OffsetDateTime created()
      Gets the created property: The time the watchlist was created.
      UserInfo createdBy()
      Gets the createdBy property: Describes a user that created the watchlist.
      Duration defaultDuration()
      Gets the defaultDuration property: The default duration of a watchlist (in ISO 8601 duration format).
      String description()
      Gets the description property: A description of the watchlist.
      String displayName()
      Gets the displayName property: The display name of the watchlist.
      String etag()
      Gets the etag property: Etag of the azure resource.
      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      WatchlistInner innerModel()
      Gets the inner com.azure.resourcemanager.securityinsights.fluent.models.WatchlistInner object.
      Boolean isDeleted()
      Gets the isDeleted property: A flag that indicates if the watchlist is deleted or not.
      String itemsSearchKey()
      Gets the itemsSearchKey property: The search key is used to optimize query performance when using watchlists for joins with other data.
      List<String> labels()
      Gets the labels property: List of labels relevant to this watchlist.
      String name()
      Gets the name property: The name of the resource.
      Integer numberOfLinesToSkip()
      Gets the numberOfLinesToSkip property: The number of lines in a csv/tsv content to skip before the header.
      String provider()
      Gets the provider property: The provider of the watchlist.
      ProvisioningState provisioningState()
      Gets the provisioningState property: The provisioning state of the watchlist resource.
      String rawContent()
      Gets the rawContent property: The raw content that represents to watchlist items to create.
      Watchlist refresh()
      Refreshes the resource to sync with Azure.
      Watchlist refresh​(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      String resourceGroupName()
      Gets the name of the resource group.
      String sasUri()
      Gets the sasUri property: The Shared Access Signature (SAS) URI under which the large csv watchlist file is located and from which the watchlist and its items will be created.
      String source()
      Gets the source property: The filename of the watchlist, called 'source'.
      SourceType sourceType()
      Gets the sourceType property: The sourceType of the watchlist.
      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      String tenantId()
      Gets the tenantId property: The tenantId where the watchlist belongs to.
      String type()
      Gets the type property: The type of the resource.
      Watchlist.Update update()
      Begins update for the Watchlist resource.
      OffsetDateTime updated()
      Gets the updated property: The last time the watchlist was updated.
      UserInfo updatedBy()
      Gets the updatedBy property: Describes a user that updated the watchlist.
      String uploadStatus()
      Gets the uploadStatus property: The status of the Watchlist upload : New, InProgress or Complete.
      String watchlistAlias()
      Gets the watchlistAlias property: The alias of the watchlist.
      String watchlistId()
      Gets the watchlistId property: The id (a Guid) of the watchlist.
      String watchlistType()
      Gets the watchlistType property: The type of the watchlist.

    • 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.

      • etag

        String etag()
        Gets the etag property: Etag of the azure resource.
        Returns:
        the etag value.

      • systemData

        com.azure.core.management.SystemData systemData()
        Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
        Returns:
        the systemData value.

      • watchlistId

        String watchlistId()
        Gets the watchlistId property: The id (a Guid) of the watchlist.
        Returns:
        the watchlistId value.

      • displayName

        String displayName()
        Gets the displayName property: The display name of the watchlist.
        Returns:
        the displayName value.

      • provider

        String provider()
        Gets the provider property: The provider of the watchlist.
        Returns:
        the provider value.

      • source

        String source()
        Gets the source property: The filename of the watchlist, called 'source'.
        Returns:
        the source value.

      • sourceType

        SourceType sourceType()
        Gets the sourceType property: The sourceType of the watchlist.
        Returns:
        the sourceType value.

      • created

        OffsetDateTime created()
        Gets the created property: The time the watchlist was created.
        Returns:
        the created value.

      • updated

        OffsetDateTime updated()
        Gets the updated property: The last time the watchlist was updated.
        Returns:
        the updated value.

      • createdBy

        UserInfo createdBy()
        Gets the createdBy property: Describes a user that created the watchlist.
        Returns:
        the createdBy value.

      • updatedBy

        UserInfo updatedBy()
        Gets the updatedBy property: Describes a user that updated the watchlist.
        Returns:
        the updatedBy value.

      • description

        String description()
        Gets the description property: A description of the watchlist.
        Returns:
        the description value.

      • watchlistType

        String watchlistType()
        Gets the watchlistType property: The type of the watchlist.
        Returns:
        the watchlistType value.

      • watchlistAlias

        String watchlistAlias()
        Gets the watchlistAlias property: The alias of the watchlist.
        Returns:
        the watchlistAlias value.

      • isDeleted

        Boolean isDeleted()
        Gets the isDeleted property: A flag that indicates if the watchlist is deleted or not.
        Returns:
        the isDeleted value.

      • labels

        List<String> labels()
        Gets the labels property: List of labels relevant to this watchlist.
        Returns:
        the labels value.

      • defaultDuration

        Duration defaultDuration()
        Gets the defaultDuration property: The default duration of a watchlist (in ISO 8601 duration format).
        Returns:
        the defaultDuration value.

      • tenantId

        String tenantId()
        Gets the tenantId property: The tenantId where the watchlist belongs to.
        Returns:
        the tenantId value.

      • numberOfLinesToSkip

        Integer numberOfLinesToSkip()
        Gets the numberOfLinesToSkip property: The number of lines in a csv/tsv content to skip before the header.
        Returns:
        the numberOfLinesToSkip value.

      • rawContent

        String rawContent()
        Gets the rawContent property: The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint.
        Returns:
        the rawContent value.

      • sasUri

        String sasUri()
        Gets the sasUri property: The Shared Access Signature (SAS) URI under which the large csv watchlist file is located and from which the watchlist and its items will be created.
        Returns:
        the sasUri value.

      • itemsSearchKey

        String itemsSearchKey()
        Gets the itemsSearchKey property: The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address.
        Returns:
        the itemsSearchKey value.

      • contentType

        String contentType()
        Gets the contentType property: The content type of the raw content. Example : text/csv or text/tsv.
        Returns:
        the contentType value.

      • uploadStatus

        String uploadStatus()
        Gets the uploadStatus property: The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted.
        Returns:
        the uploadStatus value.

      • provisioningState

        ProvisioningState provisioningState()
        Gets the provisioningState property: The provisioning state of the watchlist resource.
        Returns:
        the provisioningState value.

      • resourceGroupName

        String resourceGroupName()
        Gets the name of the resource group.
        Returns:
        the name of the resource group.

      • innerModel

        WatchlistInner innerModel()
        Gets the inner com.azure.resourcemanager.securityinsights.fluent.models.WatchlistInner object.
        Returns:
        the inner object.

      • update

        Watchlist.Update update()
        Begins update for the Watchlist resource.
        Returns:
        the stage of resource update.

      • refresh

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

      • refresh

        Watchlist 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.