com.oracle.bmc.loganalytics.model

Class UpdateLogAnalyticsObjectCollectionRuleDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.loganalytics.model.UpdateLogAnalyticsObjectCollectionRuleDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public final class UpdateLogAnalyticsObjectCollectionRuleDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Configuration of the collection rule to be updated.
Note: Objects should always be created or deserialized using the UpdateLogAnalyticsObjectCollectionRuleDetails.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 UpdateLogAnalyticsObjectCollectionRuleDetails.Builder, which maintain a set of all explicitly set fields called UpdateLogAnalyticsObjectCollectionRuleDetails.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 and Description
static class	UpdateLogAnalyticsObjectCollectionRuleDetails.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 and Description

UpdateLogAnalyticsObjectCollectionRuleDetails(String description, 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, Map<String,Map<String,Object>> definedTags, Map<String,String> freeformTags) Deprecated.

Method Summary

Modifier and Type	Method and Description
static UpdateLogAnalyticsObjectCollectionRuleDetails.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.
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.
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.
List<String>	getObjectNameFilters() When the filters are provided, only the objects matching the filters are picked up for processing.
Map<String,List<PropertyOverride>>	getOverrides() Use this to override some property values which are defined at bucket level to the scope of object.
String	getTimezone() Timezone to be used when processing log entries whose timestamps do not include an explicit timezone.
int	hashCode()
UpdateLogAnalyticsObjectCollectionRuleDetails.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

UpdateLogAnalyticsObjectCollectionRuleDetails

@Deprecated
 @ConstructorProperties(value={"description","logGroupId","logSourceName","entityId","charEncoding","isEnabled","timezone","logSet","logSetKey","logSetExtRegex","overrides","objectNameFilters","definedTags","freeformTags"})
public UpdateLogAnalyticsObjectCollectionRuleDetails(String description,
                                                                                                                                                                                                                                                                                                 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,
                                                                                                                                                                                                                                                                                                 Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                                                 Map<String,String> freeformTags)

Deprecated.

Method Detail

builder

public static UpdateLogAnalyticsObjectCollectionRuleDetails.Builder builder()

Create a new builder.

toBuilder

public UpdateLogAnalyticsObjectCollectionRuleDetails.Builder toBuilder()

getDescription

public String getDescription()

A string that describes the details of the rule. Avoid entering confidential information.

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()

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

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

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