java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.loganalytics.model.LogAnalyticsObjectCollectionRule

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class LogAnalyticsObjectCollectionRule.Builder

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor	Description
LogAnalyticsObjectCollectionRule(String id, String name, String description, String compartmentId, String osNamespace, String osBucketName, ObjectCollectionRuleCollectionTypes collectionType, String pollSince, String pollTill, String logGroupId, String logSourceName, String entityId, String charEncoding, String timezone, String logSet, LogSetKeyTypes logSetKey, String logSetExtRegex, Map<String,List<PropertyOverride>> overrides, ObjectCollectionRuleLifecycleStates lifecycleState, String lifecycleDetails, Date timeCreated, Date timeUpdated, Boolean isEnabled, List<String> objectNameFilters, LogTypes logType, Boolean isForceHistoricCollection, Map<String,Map<String,Object>> definedTags, Map<String,String> freeformTags)	Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static LogAnalyticsObjectCollectionRule.Builder`	`builder()`	Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getCharEncoding()`	An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing.
`ObjectCollectionRuleCollectionTypes`	`getCollectionType()`	The type of log collection.
`String`	`getCompartmentId()`	The OCID of the compartment to which this rule belongs.
`Map<String,Map<String,Object>>`	`getDefinedTags()`	Defined tags for this resource.
`String`	`getDescription()`	A string that describes the details of the rule.
`String`	`getEntityId()`	Logging Analytics entity OCID to associate the processed logs with.
`Map<String,String>`	`getFreeformTags()`	Simple key-value pair that is applied without any predefined name, type or scope.
`String`	`getId()`	The OCID of this rule.
`Boolean`	`getIsEnabled()`	Whether or not this rule is currently enabled.
`Boolean`	`getIsForceHistoricCollection()`	Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
`String`	`getLifecycleDetails()`	A detailed status of the life cycle state.
`ObjectCollectionRuleLifecycleStates`	`getLifecycleState()`	The current state of the rule.
`String`	`getLogGroupId()`	Logging Analytics Log group OCID to associate the processed logs with.
`String`	`getLogSet()`	The logSet to be associated with the processed logs.
`String`	`getLogSetExtRegex()`	The regex to be applied against given logSetKey.
`LogSetKeyTypes`	`getLogSetKey()`	An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex.
`String`	`getLogSourceName()`	Name of the Logging Analytics Source to use for the processing.
`LogTypes`	`getLogType()`	Type of files/objects in this object collection rule.
`String`	`getName()`	A unique name to the rule.
`List<String>`	`getObjectNameFilters()`	When the filters are provided, only the objects matching the filters are picked up for processing.
`String`	`getOsBucketName()`	Name of the Object Storage bucket.
`String`	`getOsNamespace()`	Object Storage namespace.
`Map<String,List<PropertyOverride>>`	`getOverrides()`	Use this to override some property values which are defined at bucket level to the scope of object.
`String`	`getPollSince()`	The oldest time of the file in the bucket to consider for collection.
`String`	`getPollTill()`	The newest time of the file in the bucket to consider for collection.
`Date`	`getTimeCreated()`	The time when this rule was created.
`Date`	`getTimeUpdated()`	The time when this rule was last updated.
`String`	`getTimezone()`	Timezone to be used when processing log entries whose timestamps do not include an explicit timezone.
`int`	`hashCode()`
`LogAnalyticsObjectCollectionRule.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)`	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LogAnalyticsObjectCollectionRule
```
@Deprecated
@ConstructorProperties({"id","name","description","compartmentId","osNamespace","osBucketName","collectionType","pollSince","pollTill","logGroupId","logSourceName","entityId","charEncoding","timezone","logSet","logSetKey","logSetExtRegex","overrides","lifecycleState","lifecycleDetails","timeCreated","timeUpdated","isEnabled","objectNameFilters","logType","isForceHistoricCollection","definedTags","freeformTags"})
public LogAnalyticsObjectCollectionRule(String id,
                                        String name,
                                        String description,
                                        String compartmentId,
                                        String osNamespace,
                                        String osBucketName,
                                        ObjectCollectionRuleCollectionTypes collectionType,
                                        String pollSince,
                                        String pollTill,
                                        String logGroupId,
                                        String logSourceName,
                                        String entityId,
                                        String charEncoding,
                                        String timezone,
                                        String logSet,
                                        LogSetKeyTypes logSetKey,
                                        String logSetExtRegex,
                                        Map<String,List<PropertyOverride>> overrides,
                                        ObjectCollectionRuleLifecycleStates lifecycleState,
                                        String lifecycleDetails,
                                        Date timeCreated,
                                        Date timeUpdated,
                                        Boolean isEnabled,
                                        List<String> objectNameFilters,
                                        LogTypes logType,
                                        Boolean isForceHistoricCollection,
                                        Map<String,Map<String,Object>> definedTags,
                                        Map<String,String> freeformTags)
```
    Deprecated.
- Method Detail
  - builder
```
public static LogAnalyticsObjectCollectionRule.Builder builder()
```
    Create a new builder.
  - toBuilder
```
public LogAnalyticsObjectCollectionRule.Builder toBuilder()
```
  - getId
```
public String getId()
```
    The OCID of this rule.
    
    Returns:
    
    the value
  - getName
```
public String getName()
```
    A unique name to the rule.
    The name must be unique, within the tenancy, and cannot be changed.
    
    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
  - getCollectionType
```
public ObjectCollectionRuleCollectionTypes getCollectionType()
```
    The type of log collection.
    
    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 to associate the processed logs with.
    
    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
  - 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()
```
    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”.
    
    Returns:
    
    the value
  - getLifecycleState
```
public ObjectCollectionRuleLifecycleStates getLifecycleState()
```
    The current state of the rule.
    
    Returns:
    
    the value
  - getLifecycleDetails
```
public String getLifecycleDetails()
```
    A detailed status of the life cycle state.
    
    Returns:
    
    the value
  - getTimeCreated
```
public Date getTimeCreated()
```
    The time when this rule was created.
    An RFC3339 formatted datetime string.
    
    Returns:
    
    the value
  - getTimeUpdated
```
public Date getTimeUpdated()
```
    The time when this rule was last updated.
    An RFC3339 formatted datetime string.
    
    Returns:
    
    the value
  - getIsEnabled
```
public Boolean getIsEnabled()
```
    Whether or not this rule is currently enabled.
    
    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
  - 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

Class LogAnalyticsObjectCollectionRule

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

LogAnalyticsObjectCollectionRule

Method Detail

builder

toBuilder

getId

getName

getDescription

getCompartmentId

getOsNamespace

getOsBucketName

getCollectionType

getPollSince

getPollTill

getLogGroupId

getLogSourceName

getEntityId

getCharEncoding

getTimezone

getLogSet

getLogSetKey

getLogSetExtRegex

getOverrides

getLifecycleState

getLifecycleDetails

getTimeCreated

getTimeUpdated

getIsEnabled

getObjectNameFilters

getLogType

getIsForceHistoricCollection

getDefinedTags

getFreeformTags

toString

toString

equals

hashCode