@Generated(value="OracleSDKGenerator", comments="API Version: 20200601") public final class LogAnalyticsObjectCollectionRule extends Object
The configuration details of an Object Storage based collection rule.
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
__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take
__explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null from unset null).| Modifier and Type | Class and Description |
|---|---|
static class |
LogAnalyticsObjectCollectionRule.Builder |
| Constructor and 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,
Map<String,List<PropertyOverride>> overrides,
ObjectCollectionRuleLifecycleStates lifecycleState,
String lifecycleDetails,
Date timeCreated,
Date timeUpdated,
Boolean isEnabled,
Map<String,Map<String,Object>> definedTags,
Map<String,String> freeformTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static LogAnalyticsObjectCollectionRule.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
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.
|
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 |
getLogSourceName()
Name of the Logging Analytics Source to use for the processing.
|
String |
getName()
A unique name to the rule.
|
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.
|
int |
hashCode() |
LogAnalyticsObjectCollectionRule.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"id","name","description","compartmentId","osNamespace","osBucketName","collectionType","pollSince","pollTill","logGroupId","logSourceName","entityId","charEncoding","overrides","lifecycleState","lifecycleDetails","timeCreated","timeUpdated","isEnabled","definedTags","freeformTags"}) @Deprecated 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, Map<String,List<PropertyOverride>> overrides, ObjectCollectionRuleLifecycleStates lifecycleState, String lifecycleDetails, Date timeCreated, Date timeUpdated, Boolean isEnabled, Map<String,Map<String,Object>> definedTags, Map<String,String> freeformTags)
public static LogAnalyticsObjectCollectionRule.Builder builder()
Create a new builder.
public LogAnalyticsObjectCollectionRule.Builder toBuilder()
public String getName()
A unique name to the rule. The name must be unique, within the tenancy, and cannot be changed.
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 log 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 to associate the processed logs with.
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 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. Supported matchType for override are "contains".
public ObjectCollectionRuleLifecycleStates getLifecycleState()
The current state of the rule.
public String getLifecycleDetails()
A detailed status of the life cycle state.
public Date getTimeCreated()
The time when this rule was created. An RFC3339 formatted datetime string.
public Date getTimeUpdated()
The time when this rule was last updated. An RFC3339 formatted datetime string.
public Boolean getIsEnabled()
Whether or not this rule is currently enabled.
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\"}
Copyright © 2016–2021. All rights reserved.