@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
CreateLogAnalyticsObjectCollectionRuleDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
CreateLogAnalyticsObjectCollectionRuleDetails(String name,
String description,
String compartmentId,
String osNamespace,
String osBucketName,
ObjectCollectionRuleCollectionTypes collectionType,
String pollSince,
String pollTill,
String logGroupId,
String logSourceName,
String entityId,
String charEncoding,
Boolean isEnabled,
String timezone,
String logSet,
LogSetKeyTypes logSetKey,
String logSetExtRegex,
Map<String,List<PropertyOverride>> overrides,
List<String> objectNameFilters,
LogTypes logType,
Boolean isForceHistoricCollection,
Map<String,Map<String,Object>> definedTags,
Map<String,String> freeformTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static CreateLogAnalyticsObjectCollectionRuleDetails.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 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.
|
Map<String,String> |
getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.
|
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 |
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 given 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()
The override is used to modify some important configuration properties for objects matching a
specific pattern inside the bucket.
|
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.
|
String |
getTimezone()
Timezone to be used when processing log entries whose timestamps do not include an explicit
timezone.
|
int |
hashCode() |
CreateLogAnalyticsObjectCollectionRuleDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"name","description","compartmentId","osNamespace","osBucketName","collectionType","pollSince","pollTill","logGroupId","logSourceName","entityId","charEncoding","isEnabled","timezone","logSet","logSetKey","logSetExtRegex","overrides","objectNameFilters","logType","isForceHistoricCollection","definedTags","freeformTags"}) public CreateLogAnalyticsObjectCollectionRuleDetails(String name, String description, String compartmentId, String osNamespace, String osBucketName, ObjectCollectionRuleCollectionTypes collectionType, String pollSince, String pollTill, String logGroupId, String logSourceName, String entityId, String charEncoding, Boolean isEnabled, String timezone, String logSet, LogSetKeyTypes logSetKey, String logSetExtRegex, Map<String,List<PropertyOverride>> overrides, List<String> objectNameFilters, LogTypes logType, Boolean isForceHistoricCollection, Map<String,Map<String,Object>> definedTags, Map<String,String> freeformTags)
public static CreateLogAnalyticsObjectCollectionRuleDetails.Builder builder()
Create a new builder.
public CreateLogAnalyticsObjectCollectionRuleDetails.Builder toBuilder()
public String getName()
A unique name given to the rule. The name must be unique within the tenancy, and cannot be modified.
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.
public String getCompartmentId()
The OCID of the compartment to which this rule belongs.
public String getOsNamespace()
Object Storage namespace.
public String getOsBucketName()
Name of the Object Storage bucket.
public ObjectCollectionRuleCollectionTypes getCollectionType()
The type of collection.
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.
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.
public String getLogGroupId()
Logging Analytics Log group OCID to associate the processed logs with.
public String getLogSourceName()
Name of the Logging Analytics Source to use for the processing.
public String getEntityId()
Logging Analytics entity OCID. Associates the processed logs with the given entity (optional).
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.
public Boolean getIsEnabled()
Whether or not this rule is currently enabled.
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.
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.
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/
public String getLogSetExtRegex()
The regex to be applied against given logSetKey. Regex has to be in string escaped format.
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”.
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.
public LogTypes getLogType()
Type of files/objects in this object collection rule.
public Boolean getIsForceHistoricCollection()
Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
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"}}
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"}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.