LogAnalyticsObjectCollectionRule.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.loganalytics.model.LogAnalyticsObjectCollectionRule.Builder

Enclosing class:: LogAnalyticsObjectCollectionRule

public static class LogAnalyticsObjectCollectionRule.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LogAnalyticsObjectCollectionRule`	`build()`
`LogAnalyticsObjectCollectionRule.Builder`	`charEncoding(String charEncoding)` An optional character encoding to aid in detecting the character encoding of the contents of the objects while processing.
`LogAnalyticsObjectCollectionRule.Builder`	`collectionType(ObjectCollectionRuleCollectionTypes collectionType)` The type of log collection.
`LogAnalyticsObjectCollectionRule.Builder`	`compartmentId(String compartmentId)` The OCID of the compartment to which this rule belongs.
`LogAnalyticsObjectCollectionRule.Builder`	`copy(LogAnalyticsObjectCollectionRule model)`
`LogAnalyticsObjectCollectionRule.Builder`	`definedTags(Map<String,Map<String,Object>> definedTags)` Defined tags for this resource.
`LogAnalyticsObjectCollectionRule.Builder`	`description(String description)` A string that describes the details of the rule.
`LogAnalyticsObjectCollectionRule.Builder`	`entityId(String entityId)` Logging Analytics entity OCID to associate the processed logs with.
`LogAnalyticsObjectCollectionRule.Builder`	`freeformTags(Map<String,String> freeformTags)` Simple key-value pair that is applied without any predefined name, type or scope.
`LogAnalyticsObjectCollectionRule.Builder`	`id(String id)` The OCID of this rule.
`LogAnalyticsObjectCollectionRule.Builder`	`isEnabled(Boolean isEnabled)` Whether or not this rule is currently enabled.
`LogAnalyticsObjectCollectionRule.Builder`	`isForceHistoricCollection(Boolean isForceHistoricCollection)` Flag to allow historic collection if poll period overlaps with existing ACTIVE collection rule
`LogAnalyticsObjectCollectionRule.Builder`	`lifecycleDetails(String lifecycleDetails)` A detailed status of the life cycle state.
`LogAnalyticsObjectCollectionRule.Builder`	`lifecycleState(ObjectCollectionRuleLifecycleStates lifecycleState)` The current state of the rule.
`LogAnalyticsObjectCollectionRule.Builder`	`logGroupId(String logGroupId)` Logging Analytics Log group OCID to associate the processed logs with.
`LogAnalyticsObjectCollectionRule.Builder`	`logSet(String logSet)` The logSet to be associated with the processed logs.
`LogAnalyticsObjectCollectionRule.Builder`	`logSetExtRegex(String logSetExtRegex)` The regex to be applied against given logSetKey.
`LogAnalyticsObjectCollectionRule.Builder`	`logSetKey(LogSetKeyTypes logSetKey)` An optional parameter to indicate from where the logSet to be extracted using logSetExtRegex.
`LogAnalyticsObjectCollectionRule.Builder`	`logSourceName(String logSourceName)` Name of the Logging Analytics Source to use for the processing.
`LogAnalyticsObjectCollectionRule.Builder`	`logType(LogTypes logType)` Type of files/objects in this object collection rule.
`LogAnalyticsObjectCollectionRule.Builder`	`name(String name)` A unique name to the rule.
`LogAnalyticsObjectCollectionRule.Builder`	`objectNameFilters(List<String> objectNameFilters)` When the filters are provided, only the objects matching the filters are picked up for processing.
`LogAnalyticsObjectCollectionRule.Builder`	`osBucketName(String osBucketName)` Name of the Object Storage bucket.
`LogAnalyticsObjectCollectionRule.Builder`	`osNamespace(String osNamespace)` Object Storage namespace.
`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.
`LogAnalyticsObjectCollectionRule.Builder`	`pollSince(String pollSince)` The oldest time of the file in the bucket to consider for collection.
`LogAnalyticsObjectCollectionRule.Builder`	`pollTill(String pollTill)` The newest time of the file in the bucket to consider for collection.
`LogAnalyticsObjectCollectionRule.Builder`	`timeCreated(Date timeCreated)` The time when this rule was created.
`LogAnalyticsObjectCollectionRule.Builder`	`timeUpdated(Date timeUpdated)` The time when this rule was last updated.
`LogAnalyticsObjectCollectionRule.Builder`	`timezone(String timezone)` Timezone to be used when processing log entries whose timestamps do not include an explicit timezone.

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - id
```
public LogAnalyticsObjectCollectionRule.Builder id(String id)
```
    The OCID of this rule.
    
    Parameters:
    
    id - the value to set
    
    Returns:
    
    this builder
  - 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
  - compartmentId
```
public LogAnalyticsObjectCollectionRule.Builder compartmentId(String compartmentId)
```
    The OCID of the compartment to which this rule belongs.
    
    Parameters:
    
    compartmentId - the value to set
    
    Returns:
    
    this builder
  - osNamespace
```
public LogAnalyticsObjectCollectionRule.Builder osNamespace(String osNamespace)
```
    Object Storage namespace.
    
    Parameters:
    
    osNamespace - the value to set
    
    Returns:
    
    this builder
  - osBucketName
```
public LogAnalyticsObjectCollectionRule.Builder osBucketName(String osBucketName)
```
    Name of the Object Storage bucket.
    
    Parameters:
    
    osBucketName - the value to set
    
    Returns:
    
    this builder
  - collectionType
```
public LogAnalyticsObjectCollectionRule.Builder collectionType(ObjectCollectionRuleCollectionTypes collectionType)
```
    The type of log collection.
    
    Parameters:
    
    collectionType - 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
  - entityId
```
public LogAnalyticsObjectCollectionRule.Builder entityId(String entityId)
```
    Logging Analytics entity OCID to associate the processed logs with.
    
    Parameters:
    
    entityId - 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
  - lifecycleState
```
public LogAnalyticsObjectCollectionRule.Builder lifecycleState(ObjectCollectionRuleLifecycleStates lifecycleState)
```
    The current state of the rule.
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder
  - lifecycleDetails
```
public LogAnalyticsObjectCollectionRule.Builder lifecycleDetails(String lifecycleDetails)
```
    A detailed status of the life cycle state.
    
    Parameters:
    
    lifecycleDetails - 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
  - isEnabled
```
public LogAnalyticsObjectCollectionRule.Builder isEnabled(Boolean isEnabled)
```
    Whether or not this rule is currently enabled.
    
    Parameters:
    
    isEnabled - 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
  - logType
```
public LogAnalyticsObjectCollectionRule.Builder logType(LogTypes logType)
```
    Type of files/objects in this object collection rule.
    
    Parameters:
    
    logType - 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
  - 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
  - build
```
public LogAnalyticsObjectCollectionRule build()
```
  - copy
```
public LogAnalyticsObjectCollectionRule.Builder copy(LogAnalyticsObjectCollectionRule model)
```

Class LogAnalyticsObjectCollectionRule.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

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

build

copy