Package com.oracle.bmc.loganalytics.model

Class CreateLogAnalyticsObjectCollectionRuleDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public final class CreateLogAnalyticsObjectCollectionRuleDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The configuration details of collection rule to enable automatic log collection from an object storage bucket.
    Note: Objects should always be created or deserialized using the CreateLogAnalyticsObjectCollectionRuleDetails.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 CreateLogAnalyticsObjectCollectionRuleDetails.Builder, which maintain a set of all explicitly set fields called CreateLogAnalyticsObjectCollectionRuleDetails.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).

    • Method Detail

      • getName

        public String getName()
        A unique name given to the rule.

        The name must be unique within the tenancy, and cannot be modified.

        Returns:
        the value

      • getDescription

        public String getDescription()
        A string that describes the details of the rule.

        It does not have to be unique, and can be changed. Avoid entering confidential information.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment to which this rule belongs.
        Returns:
        the value

      • getOsNamespace

        public String getOsNamespace()
        Object Storage namespace.
        Returns:
        the value

      • getOsBucketName

        public String getOsBucketName()
        Name of the Object Storage bucket.
        Returns:
        the value

      • getPollSince

        public String getPollSince()
        The oldest time of the file in the bucket to consider for collection.

        Accepted values are: BEGINNING or CURRENT_TIME or RFC3339 formatted datetime string. Use this for HISTORIC or HISTORIC_LIVE collection types. When collectionType is LIVE, specifying pollSince value other than CURRENT_TIME will result in error.

        Returns:
        the value

      • getPollTill

        public String getPollTill()
        The newest time of the file in the bucket to consider for collection.

        Accepted values are: CURRENT_TIME or RFC3339 formatted datetime string. Use this for HISTORIC collection type. When collectionType is LIVE or HISTORIC_LIVE, specifying pollTill will result in error.

        Returns:
        the value

      • getLogGroupId

        public String getLogGroupId()
        Logging Analytics Log group OCID to associate the processed logs with.
        Returns:
        the value

      • getLogSourceName

        public String getLogSourceName()
        Name of the Logging Analytics Source to use for the processing.
        Returns:
        the value

      • getEntityId

        public String getEntityId()
        Logging Analytics entity OCID.

        Associates the processed logs with the given entity (optional).

        Returns:
        the value

      • getCharEncoding

        public String getCharEncoding()
        An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing.

        It is recommended to set this value as ISO_8859_1 when configuring content of the objects having more numeric characters, and very few alphabets. For e.g. this applies when configuring VCN Flow Logs.

        Returns:
        the value

      • getIsEnabled

        public Boolean getIsEnabled()
        Whether or not this rule is currently enabled.
        Returns:
        the value

      • getTimezone

        public String getTimezone()
        Timezone to be used when processing log entries whose timestamps do not include an explicit timezone.

        When this property is not specified, the timezone of the entity specified is used. If the entity is also not specified or do not have a valid timezone then UTC is used.

        Returns:
        the value

      • getLogSet

        public String getLogSet()
        The logSet to be associated with the processed logs.

        The logSet feature can be used by customers with high volume of data and this feature has to be enabled for a given tenancy prior to its usage. When logSetExtRegex value is provided, it will take precedence over this logSet value and logSet will be computed dynamically using logSetKey and logSetExtRegex.

        Returns:
        the value

      • getLogSetKey

        public LogSetKeyTypes getLogSetKey()
        An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex.

        Default value is OBJECT_PATH (e.g. /n//b//o/).

        Returns:
        the value

      • getLogSetExtRegex

        public String getLogSetExtRegex()
        The regex to be applied against given logSetKey.

        Regex has to be in string escaped format.

        Returns:
        the value

      • getOverrides

        public Map<String,​List<PropertyOverride>> getOverrides()
        The override is used to modify some important configuration properties for objects matching a specific pattern inside the bucket.

        Supported propeties for override are: logSourceName, charEncoding, entityId. Supported matchType for override are “contains”.

        Returns:
        the value

      • getObjectNameFilters

        public List<String> getObjectNameFilters()
        When the filters are provided, only the objects matching the filters are picked up for processing.

        The matchType supported is exact match and accommodates wildcard “*”. For more information on filters, see Event Filters.

        Returns:
        the value

      • getLogType

        public LogTypes getLogType()
        Type of files/objects in this object collection rule.
        Returns:
        the value

      • getIsForceHistoricCollection

        public Boolean getIsForceHistoricCollection()
        Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
        Returns:
        the value

      • getStreamId

        public String getStreamId()
        A Stream OCID is required for Object Collection rules of type LIVE or HISTORIC_LIVE, which will be used by Logging Analytics while creating Event Rule and consume the event notifications created by the Object Storage.
        Returns:
        the value

      • getStreamCursorType

        public StreamCursorTypes getStreamCursorType()
        Cursor type used to fetch messages from stream.

        When the streamCursorType is set to DEFAULT, the existing cursor position will be used if already set by any previous objection collection rule(s) using the same stream. Otherwise, the behaviour is to consume from the oldest available message in the stream. When the streamCursorType is set to TRIM_HORIZON, the behaviour is to start consuming from the oldest available message in the stream. When the streamCursorType is set to LATEST, the behavior is to start consuming messages that were published after the creation of this rule. When the streamCursorType is set to AT_TIME, the behavior is to start consuming from a given time. For more information on cursor types, see Stream Consumer Groups.

        Returns:
        the value

      • getStreamCursorTime

        public Date getStreamCursorTime()
        The time from which to consume the objects, if streamCursorType is AT_TIME.
        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Simple key-value pair that is applied without any predefined name, type or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

        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