Package com.azure.resourcemanager.securityinsights.fluent.models

Class WatchlistProperties

  • public final class WatchlistProperties
extends Object
    Describes watchlist properties.

    • Constructor Detail

      • WatchlistProperties

        public WatchlistProperties()

    • Method Detail

      • watchlistId

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

      • withWatchlistId

        public WatchlistProperties withWatchlistId​(String watchlistId)
        Set the watchlistId property: The id (a Guid) of the watchlist.
        Parameters:
        watchlistId - the watchlistId value to set.
        Returns:
        the WatchlistProperties object itself.

      • displayName

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

      • withDisplayName

        public WatchlistProperties withDisplayName​(String displayName)
        Set the displayName property: The display name of the watchlist.
        Parameters:
        displayName - the displayName value to set.
        Returns:
        the WatchlistProperties object itself.

      • provider

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

      • withProvider

        public WatchlistProperties withProvider​(String provider)
        Set the provider property: The provider of the watchlist.
        Parameters:
        provider - the provider value to set.
        Returns:
        the WatchlistProperties object itself.

      • source

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

      • withSource

        public WatchlistProperties withSource​(String source)
        Set the source property: The filename of the watchlist, called 'source'.
        Parameters:
        source - the source value to set.
        Returns:
        the WatchlistProperties object itself.

      • sourceType

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

      • withSourceType

        public WatchlistProperties withSourceType​(SourceType sourceType)
        Set the sourceType property: The sourceType of the watchlist.
        Parameters:
        sourceType - the sourceType value to set.
        Returns:
        the WatchlistProperties object itself.

      • created

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

      • withCreated

        public WatchlistProperties withCreated​(OffsetDateTime created)
        Set the created property: The time the watchlist was created.
        Parameters:
        created - the created value to set.
        Returns:
        the WatchlistProperties object itself.

      • updated

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

      • withUpdated

        public WatchlistProperties withUpdated​(OffsetDateTime updated)
        Set the updated property: The last time the watchlist was updated.
        Parameters:
        updated - the updated value to set.
        Returns:
        the WatchlistProperties object itself.

      • createdBy

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

      • withCreatedBy

        public WatchlistProperties withCreatedBy​(UserInfo createdBy)
        Set the createdBy property: Describes a user that created the watchlist.
        Parameters:
        createdBy - the createdBy value to set.
        Returns:
        the WatchlistProperties object itself.

      • updatedBy

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

      • withUpdatedBy

        public WatchlistProperties withUpdatedBy​(UserInfo updatedBy)
        Set the updatedBy property: Describes a user that updated the watchlist.
        Parameters:
        updatedBy - the updatedBy value to set.
        Returns:
        the WatchlistProperties object itself.

      • description

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

      • withDescription

        public WatchlistProperties withDescription​(String description)
        Set the description property: A description of the watchlist.
        Parameters:
        description - the description value to set.
        Returns:
        the WatchlistProperties object itself.

      • watchlistType

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

      • withWatchlistType

        public WatchlistProperties withWatchlistType​(String watchlistType)
        Set the watchlistType property: The type of the watchlist.
        Parameters:
        watchlistType - the watchlistType value to set.
        Returns:
        the WatchlistProperties object itself.

      • watchlistAlias

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

      • withWatchlistAlias

        public WatchlistProperties withWatchlistAlias​(String watchlistAlias)
        Set the watchlistAlias property: The alias of the watchlist.
        Parameters:
        watchlistAlias - the watchlistAlias value to set.
        Returns:
        the WatchlistProperties object itself.

      • isDeleted

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

      • withIsDeleted

        public WatchlistProperties withIsDeleted​(Boolean isDeleted)
        Set the isDeleted property: A flag that indicates if the watchlist is deleted or not.
        Parameters:
        isDeleted - the isDeleted value to set.
        Returns:
        the WatchlistProperties object itself.

      • labels

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

      • withLabels

        public WatchlistProperties withLabels​(List<String> labels)
        Set the labels property: List of labels relevant to this watchlist.
        Parameters:
        labels - the labels value to set.
        Returns:
        the WatchlistProperties object itself.

      • defaultDuration

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

      • withDefaultDuration

        public WatchlistProperties withDefaultDuration​(Duration defaultDuration)
        Set the defaultDuration property: The default duration of a watchlist (in ISO 8601 duration format).
        Parameters:
        defaultDuration - the defaultDuration value to set.
        Returns:
        the WatchlistProperties object itself.

      • tenantId

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

      • withTenantId

        public WatchlistProperties withTenantId​(String tenantId)
        Set the tenantId property: The tenantId where the watchlist belongs to.
        Parameters:
        tenantId - the tenantId value to set.
        Returns:
        the WatchlistProperties object itself.

      • numberOfLinesToSkip

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

      • withNumberOfLinesToSkip

        public WatchlistProperties withNumberOfLinesToSkip​(Integer numberOfLinesToSkip)
        Set the numberOfLinesToSkip property: The number of lines in a csv/tsv content to skip before the header.
        Parameters:
        numberOfLinesToSkip - the numberOfLinesToSkip value to set.
        Returns:
        the WatchlistProperties object itself.

      • rawContent

        public String rawContent()
        Get 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.

      • withRawContent

        public WatchlistProperties withRawContent​(String rawContent)
        Set 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.
        Parameters:
        rawContent - the rawContent value to set.
        Returns:
        the WatchlistProperties object itself.

      • sasUri

        public String sasUri()
        Get 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.

      • withSasUri

        public WatchlistProperties withSasUri​(String sasUri)
        Set 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.
        Parameters:
        sasUri - the sasUri value to set.
        Returns:
        the WatchlistProperties object itself.

      • itemsSearchKey

        public String itemsSearchKey()
        Get 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.

      • withItemsSearchKey

        public WatchlistProperties withItemsSearchKey​(String itemsSearchKey)
        Set 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.
        Parameters:
        itemsSearchKey - the itemsSearchKey value to set.
        Returns:
        the WatchlistProperties object itself.

      • contentType

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

      • withContentType

        public WatchlistProperties withContentType​(String contentType)
        Set the contentType property: The content type of the raw content. Example : text/csv or text/tsv.
        Parameters:
        contentType - the contentType value to set.
        Returns:
        the WatchlistProperties object itself.

      • uploadStatus

        public String uploadStatus()
        Get 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.

      • withUploadStatus

        public WatchlistProperties withUploadStatus​(String uploadStatus)
        Set 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.
        Parameters:
        uploadStatus - the uploadStatus value to set.
        Returns:
        the WatchlistProperties object itself.

      • provisioningState

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

      • validate

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