Package com.oracle.bmc.loganalytics.model

Class LogAnalyticsFieldSummary

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public final class LogAnalyticsFieldSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A summary of a field.
    Note: Objects should always be created or deserialized using the LogAnalyticsFieldSummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the LogAnalyticsFieldSummary.Builder, which maintain a set of all explicitly set fields called LogAnalyticsFieldSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Constructor Detail

      • LogAnalyticsFieldSummary

        @Deprecated
@ConstructorProperties({"ceeAlias","dataType","regularExpression","description","displayName","editVersion","facetPriority","name","isFacetEligible","isHighCardinality","isLargeData","isMultiValued","isPrimary","isSystem","isSummarizable","mappedValue","isMetricKeyEligible","isMetricValueEligible","rangeFacetEligible","isTableEligible","unitType"})
public LogAnalyticsFieldSummary​(String ceeAlias,
                                String dataType,
                                String regularExpression,
                                String description,
                                String displayName,
                                Long editVersion,
                                Long facetPriority,
                                String name,
                                Boolean isFacetEligible,
                                Boolean isHighCardinality,
                                Boolean isLargeData,
                                Boolean isMultiValued,
                                Boolean isPrimary,
                                Boolean isSystem,
                                Boolean isSummarizable,
                                String mappedValue,
                                Boolean isMetricKeyEligible,
                                Boolean isMetricValueEligible,
                                Long rangeFacetEligible,
                                Boolean isTableEligible,
                                String unitType)
        Deprecated.

    • Method Detail

      • getCeeAlias

        public String getCeeAlias()
        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

        Returns:
        the value

      • getDataType

        public String getDataType()
        The field data type.
        Returns:
        the value

      • getRegularExpression

        public String getRegularExpression()
        The field default regular expression.
        Returns:
        the value

      • getDescription

        public String getDescription()
        The field description.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The field display name.
        Returns:
        the value

      • getEditVersion

        public Long getEditVersion()
        The field edit version.
        Returns:
        the value

      • getFacetPriority

        public Long getFacetPriority()
        The facet priority.
        Returns:
        the value

      • getName

        public String getName()
        The field internal name.
        Returns:
        the value

      • getIsFacetEligible

        public Boolean getIsFacetEligible()
        A flag inidcating whether or not the facet is elibigle for use.
        Returns:
        the value

      • getIsHighCardinality

        public Boolean getIsHighCardinality()
        A flag inidcating whether or not the cardinality of the field is high.
        Returns:
        the value

      • getIsLargeData

        public Boolean getIsLargeData()
        A flag inidcating whether or not the field is a large data field.
        Returns:
        the value

      • getIsMultiValued

        public Boolean getIsMultiValued()
        A flag indicating whether or not the field is multi-valued.
        Returns:
        the value

      • getIsPrimary

        public Boolean getIsPrimary()
        A flag inidcating whether or not this is a primary field.
        Returns:
        the value

      • getIsSystem

        public Boolean getIsSystem()
        The system flag.

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

        Returns:
        the value

      • getIsSummarizable

        public Boolean getIsSummarizable()
        A flag inidcating whether or not the field can be summarized.
        Returns:
        the value

      • getMappedValue

        public String getMappedValue()
        The mapped value.
        Returns:
        the value

      • getIsMetricKeyEligible

        public Boolean getIsMetricKeyEligible()
        A flag inidcating whether or not the field is metric key eligible.
        Returns:
        the value

      • getIsMetricValueEligible

        public Boolean getIsMetricValueEligible()
        A flag inidcating whether or not the field is metric value eligible.
        Returns:
        the value

      • getRangeFacetEligible

        public Long getRangeFacetEligible()
        A flag inidcating whether or not the field is range facet eligible.
        Returns:
        the value

      • getIsTableEligible

        public Boolean getIsTableEligible()
        A flag inidcating whether or not the field is table eligible.
        Returns:
        the value

      • getUnitType

        public String getUnitType()
        The field unit type.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel