Class LogAnalyticsField.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • ceeAlias

        public LogAnalyticsField.Builder ceeAlias​(String ceeAlias)
        The name this field is given in the common event expression standard from mitre.org.

        This is used for reference when exporting content conforming to CEE standard

        Parameters:
        ceeAlias - the value to set
        Returns:
        this builder
      • dataType

        public LogAnalyticsField.Builder dataType​(String dataType)
        The field data type.
        Parameters:
        dataType - the value to set
        Returns:
        this builder
      • regularExpression

        public LogAnalyticsField.Builder regularExpression​(String regularExpression)
        The field default regular expression.
        Parameters:
        regularExpression - the value to set
        Returns:
        this builder
      • description

        public LogAnalyticsField.Builder description​(String description)
        The field description.
        Parameters:
        description - the value to set
        Returns:
        this builder
      • displayName

        public LogAnalyticsField.Builder displayName​(String displayName)
        The field display name.
        Parameters:
        displayName - the value to set
        Returns:
        this builder
      • editVersion

        public LogAnalyticsField.Builder editVersion​(Long editVersion)
        The field edit version.
        Parameters:
        editVersion - the value to set
        Returns:
        this builder
      • facetPriority

        public LogAnalyticsField.Builder facetPriority​(Long facetPriority)
        The facet priority.
        Parameters:
        facetPriority - the value to set
        Returns:
        this builder
      • isFacetEligible

        public LogAnalyticsField.Builder isFacetEligible​(Boolean isFacetEligible)
        A flag inidcating whether or not the facet is elibigle for use.
        Parameters:
        isFacetEligible - the value to set
        Returns:
        this builder
      • isHighCardinality

        public LogAnalyticsField.Builder isHighCardinality​(Boolean isHighCardinality)
        A flag inidcating whether or not the cardinality of the field is high.
        Parameters:
        isHighCardinality - the value to set
        Returns:
        this builder
      • isLargeData

        public LogAnalyticsField.Builder isLargeData​(Boolean isLargeData)
        A flag inidcating whether or not the field is a large data field.
        Parameters:
        isLargeData - the value to set
        Returns:
        this builder
      • isMultiValued

        public LogAnalyticsField.Builder isMultiValued​(Boolean isMultiValued)
        A flag indicating whether or not the field is multi-valued.
        Parameters:
        isMultiValued - the value to set
        Returns:
        this builder
      • isPrimary

        public LogAnalyticsField.Builder isPrimary​(Boolean isPrimary)
        A flag inidcating whether or not this is a primary field.
        Parameters:
        isPrimary - the value to set
        Returns:
        this builder
      • isSystem

        public LogAnalyticsField.Builder isSystem​(Boolean isSystem)
        The system flag.

        A value of false denotes a custom, or user defined object. A value of true denotes a built in object.

        Parameters:
        isSystem - the value to set
        Returns:
        this builder
      • isSummarizable

        public LogAnalyticsField.Builder isSummarizable​(Boolean isSummarizable)
        A flag inidcating whether or not the field can be summarized.
        Parameters:
        isSummarizable - the value to set
        Returns:
        this builder
      • mappedValue

        public LogAnalyticsField.Builder mappedValue​(String mappedValue)
        The mapped value.
        Parameters:
        mappedValue - the value to set
        Returns:
        this builder
      • isMetricKeyEligible

        public LogAnalyticsField.Builder isMetricKeyEligible​(Boolean isMetricKeyEligible)
        A flag inidcating whether or not the field is metric key eligible.
        Parameters:
        isMetricKeyEligible - the value to set
        Returns:
        this builder
      • isMetricValueEligible

        public LogAnalyticsField.Builder isMetricValueEligible​(Boolean isMetricValueEligible)
        A flag inidcating whether or not the field is metric value eligible.
        Parameters:
        isMetricValueEligible - the value to set
        Returns:
        this builder
      • rangeFacetEligible

        public LogAnalyticsField.Builder rangeFacetEligible​(Long rangeFacetEligible)
        A flag inidcating whether or not the field is range facet eligible.
        Parameters:
        rangeFacetEligible - the value to set
        Returns:
        this builder
      • isTableEligible

        public LogAnalyticsField.Builder isTableEligible​(Boolean isTableEligible)
        A flag inidcating whether or not the field is table eligible.
        Parameters:
        isTableEligible - the value to set
        Returns:
        this builder
      • unitType

        public LogAnalyticsField.Builder unitType​(String unitType)
        The field unit type.
        Parameters:
        unitType - the value to set
        Returns:
        this builder