Package com.datadog.api.client.v2.model

Class ObservabilityPipelineParseGrokProcessor

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineParseGrokProcessor

@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class ObservabilityPipelineParseGrokProcessor
extends Object

The parse_grok processor extracts structured fields from unstructured log messages using Grok patterns.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_DISABLE_LIBRARY_RULES
static final String	JSON_PROPERTY_DISPLAY_NAME
static final String	JSON_PROPERTY_ENABLED
static final String	JSON_PROPERTY_FIELD
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_INCLUDE
static final String	JSON_PROPERTY_RULES
static final String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
ObservabilityPipelineParseGrokProcessor()
ObservabilityPipelineParseGrokProcessor(Boolean enabled, String id, String include, List<ObservabilityPipelineParseGrokProcessorRuleItem> rules, ObservabilityPipelineParseGrokProcessorType type)

Method Summary

Modifier and Type	Method	Description
ObservabilityPipelineParseGrokProcessor	addRulesItem(ObservabilityPipelineParseGrokProcessorRuleItem rulesItem)
ObservabilityPipelineParseGrokProcessor	disableLibraryRules(Boolean disableLibraryRules)
ObservabilityPipelineParseGrokProcessor	displayName(String displayName)
ObservabilityPipelineParseGrokProcessor	enabled(Boolean enabled)
boolean	equals(Object o)	Return true if this ObservabilityPipelineParseGrokProcessor object is equal to o.
ObservabilityPipelineParseGrokProcessor	field(String field)
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
Boolean	getDisableLibraryRules()	If set to true, disables the default Grok rules provided by Datadog.
String	getDisplayName()	The display name for a component.
Boolean	getEnabled()	Indicates whether the processor is enabled.
String	getField()	The log field to parse with the Grok rules.
String	getId()	A unique identifier for this processor.
String	getInclude()	A Datadog search query used to determine which logs this processor targets.
List<ObservabilityPipelineParseGrokProcessorRuleItem>	getRules()	The list of Grok parsing rules selected by either source field or include query.
ObservabilityPipelineParseGrokProcessorType	getType()	The processor type.
int	hashCode()
ObservabilityPipelineParseGrokProcessor	id(String id)
ObservabilityPipelineParseGrokProcessor	include(String include)
ObservabilityPipelineParseGrokProcessor	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
ObservabilityPipelineParseGrokProcessor	rules(List<ObservabilityPipelineParseGrokProcessorRuleItem> rules)
void	setDisableLibraryRules(Boolean disableLibraryRules)
void	setDisplayName(String displayName)
void	setEnabled(Boolean enabled)
void	setField(String field)
void	setId(String id)
void	setInclude(String include)
void	setRules(List<ObservabilityPipelineParseGrokProcessorRuleItem> rules)
void	setType(ObservabilityPipelineParseGrokProcessorType type)
String	toString()
ObservabilityPipelineParseGrokProcessor	type(ObservabilityPipelineParseGrokProcessorType type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_DISABLE_LIBRARY_RULES

public static final String JSON_PROPERTY_DISABLE_LIBRARY_RULES

See Also:

• Constant Field Values

JSON_PROPERTY_DISPLAY_NAME

public static final String JSON_PROPERTY_DISPLAY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_ENABLED

public static final String JSON_PROPERTY_ENABLED

See Also:

• Constant Field Values

JSON_PROPERTY_FIELD

public static final String JSON_PROPERTY_FIELD

See Also:

• Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

• Constant Field Values

JSON_PROPERTY_INCLUDE

public static final String JSON_PROPERTY_INCLUDE

See Also:

• Constant Field Values

JSON_PROPERTY_RULES

public static final String JSON_PROPERTY_RULES

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

Constructor Details

ObservabilityPipelineParseGrokProcessor

public ObservabilityPipelineParseGrokProcessor()

ObservabilityPipelineParseGrokProcessor

public ObservabilityPipelineParseGrokProcessor(Boolean enabled,
 String id,
 String include,
 List<ObservabilityPipelineParseGrokProcessorRuleItem> rules,
 ObservabilityPipelineParseGrokProcessorType type)

Method Details

disableLibraryRules

public ObservabilityPipelineParseGrokProcessor disableLibraryRules(Boolean disableLibraryRules)

getDisableLibraryRules

@Nullable
public Boolean getDisableLibraryRules()

If set to true, disables the default Grok rules provided by Datadog.

Returns:

disableLibraryRules

setDisableLibraryRules

public void setDisableLibraryRules(Boolean disableLibraryRules)

displayName

public ObservabilityPipelineParseGrokProcessor displayName(String displayName)

getDisplayName

@Nullable
public String getDisplayName()

The display name for a component.

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

enabled

public ObservabilityPipelineParseGrokProcessor enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

Indicates whether the processor is enabled.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

field

public ObservabilityPipelineParseGrokProcessor field(String field)

getField

@Nullable
public String getField()

The log field to parse with the Grok rules.

Returns:

field

setField

public void setField(String field)

id

public ObservabilityPipelineParseGrokProcessor id(String id)

getId

public String getId()

A unique identifier for this processor.

Returns:

id

setId

public void setId(String id)

include

public ObservabilityPipelineParseGrokProcessor include(String include)

getInclude

public String getInclude()

A Datadog search query used to determine which logs this processor targets.

Returns:

include

setInclude

public void setInclude(String include)

rules

public ObservabilityPipelineParseGrokProcessor rules(List<ObservabilityPipelineParseGrokProcessorRuleItem> rules)

addRulesItem

public ObservabilityPipelineParseGrokProcessor addRulesItem(ObservabilityPipelineParseGrokProcessorRuleItem rulesItem)

getRules

public List<ObservabilityPipelineParseGrokProcessorRuleItem> getRules()

The list of Grok parsing rules selected by either source field or include query.

Returns:

rules

setRules

public void setRules(List<ObservabilityPipelineParseGrokProcessorRuleItem> rules)

type

public ObservabilityPipelineParseGrokProcessor type(ObservabilityPipelineParseGrokProcessorType type)

getType

public ObservabilityPipelineParseGrokProcessorType getType()

The processor type. The value should always be parse_grok.

Returns:

type

setType

public void setType(ObservabilityPipelineParseGrokProcessorType type)

putAdditionalProperty

public ObservabilityPipelineParseGrokProcessor putAdditionalProperty(String key,
 Object value)

Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.

Parameters:

key - The arbitrary key to set

value - The associated value

Returns:

ObservabilityPipelineParseGrokProcessor

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

Return the additional (undeclared) property.

Returns:

The additional properties

getAdditionalProperty

public Object getAdditionalProperty(String key)

Return the additional (undeclared) property with the specified name.

Parameters:

key - The arbitrary key to get

Returns:

The specific additional property for the given key

equals

public boolean equals(Object o)

Return true if this ObservabilityPipelineParseGrokProcessor object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object