Package com.oracle.bmc.loganalytics.model

Class LogAnalyticsObjectCollectionRule.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • name

        public LogAnalyticsObjectCollectionRule.Builder name​(String name)
        A unique name to the rule.

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

        Parameters:
        name - the value to set
        Returns:
        this builder

      • description

        public LogAnalyticsObjectCollectionRule.Builder description​(String description)
        A string that describes the details of the rule.

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

        Parameters:
        description - the value to set
        Returns:
        this builder

      • pollSince

        public LogAnalyticsObjectCollectionRule.Builder pollSince​(String pollSince)
        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.

        Parameters:
        pollSince - the value to set
        Returns:
        this builder

      • pollTill

        public LogAnalyticsObjectCollectionRule.Builder pollTill​(String pollTill)
        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.

        Parameters:
        pollTill - the value to set
        Returns:
        this builder

      • logGroupId

        public LogAnalyticsObjectCollectionRule.Builder logGroupId​(String logGroupId)
        Logging Analytics Log group OCID to associate the processed logs with.
        Parameters:
        logGroupId - the value to set
        Returns:
        this builder

      • logSourceName

        public LogAnalyticsObjectCollectionRule.Builder logSourceName​(String logSourceName)
        Name of the Logging Analytics Source to use for the processing.
        Parameters:
        logSourceName - the value to set
        Returns:
        this builder

      • charEncoding

        public LogAnalyticsObjectCollectionRule.Builder charEncoding​(String charEncoding)
        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.

        Parameters:
        charEncoding - the value to set
        Returns:
        this builder

      • timezone

        public LogAnalyticsObjectCollectionRule.Builder timezone​(String timezone)
        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.

        Parameters:
        timezone - the value to set
        Returns:
        this builder

      • logSet

        public LogAnalyticsObjectCollectionRule.Builder logSet​(String logSet)
        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.

        Parameters:
        logSet - the value to set
        Returns:
        this builder

      • logSetKey

        public LogAnalyticsObjectCollectionRule.Builder logSetKey​(LogSetKeyTypes logSetKey)
        An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex.

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

        Parameters:
        logSetKey - the value to set
        Returns:
        this builder

      • logSetExtRegex

        public LogAnalyticsObjectCollectionRule.Builder logSetExtRegex​(String logSetExtRegex)
        The regex to be applied against given logSetKey.

        Regex has to be in string escaped format.

        Parameters:
        logSetExtRegex - the value to set
        Returns:
        this builder

      • overrides

        public LogAnalyticsObjectCollectionRule.Builder overrides​(Map<String,​List<PropertyOverride>> overrides)
        Use this to override some property values which are defined at bucket level to the scope of object.

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

        Parameters:
        overrides - the value to set
        Returns:
        this builder

      • timeCreated

        public LogAnalyticsObjectCollectionRule.Builder timeCreated​(Date timeCreated)
        The time when this rule was created.

        An RFC3339 formatted datetime string.

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

        public LogAnalyticsObjectCollectionRule.Builder timeUpdated​(Date timeUpdated)
        The time when this rule was last updated.

        An RFC3339 formatted datetime string.

        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • objectNameFilters

        public LogAnalyticsObjectCollectionRule.Builder objectNameFilters​(List<String> objectNameFilters)
        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.

        Parameters:
        objectNameFilters - the value to set
        Returns:
        this builder

      • isForceHistoricCollection

        public LogAnalyticsObjectCollectionRule.Builder isForceHistoricCollection​(Boolean isForceHistoricCollection)
        Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
        Parameters:
        isForceHistoricCollection - the value to set
        Returns:
        this builder

      • streamId

        public LogAnalyticsObjectCollectionRule.Builder streamId​(String streamId)
        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.
        Parameters:
        streamId - the value to set
        Returns:
        this builder

      • streamCursorType

        public LogAnalyticsObjectCollectionRule.Builder streamCursorType​(StreamCursorTypes streamCursorType)
        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.

        Parameters:
        streamCursorType - the value to set
        Returns:
        this builder

      • streamCursorTime

        public LogAnalyticsObjectCollectionRule.Builder streamCursorTime​(Date streamCursorTime)
        The time from which to consume the objects, if streamCursorType is AT_TIME.
        Parameters:
        streamCursorTime - the value to set
        Returns:
        this builder

      • lastCollectedObject

        public LogAnalyticsObjectCollectionRule.Builder lastCollectedObject​(String lastCollectedObject)
        Last Collected Object for the rule
        Parameters:
        lastCollectedObject - the value to set
        Returns:
        this builder

      • definedTags

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

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

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • freeformTags

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

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

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder