com.datadog.api.client.v2.model

Class ObservabilityPipelineParseXMLProcessor

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineParseXMLProcessor

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

The parse_xml processor parses XML from a specified field and extracts it into the event.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ALWAYS_USE_TEXT_KEY
static String	JSON_PROPERTY_ATTR_PREFIX
static String	JSON_PROPERTY_DISPLAY_NAME
static String	JSON_PROPERTY_ENABLED
static String	JSON_PROPERTY_FIELD
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_INCLUDE
static String	JSON_PROPERTY_INCLUDE_ATTR
static String	JSON_PROPERTY_PARSE_BOOL
static String	JSON_PROPERTY_PARSE_NULL
static String	JSON_PROPERTY_PARSE_NUMBER
static String	JSON_PROPERTY_TEXT_KEY
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineParseXMLProcessor()
ObservabilityPipelineParseXMLProcessor(Boolean enabled, String field, String id, String include, ObservabilityPipelineParseXMLProcessorType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineParseXMLProcessor	alwaysUseTextKey(Boolean alwaysUseTextKey)
ObservabilityPipelineParseXMLProcessor	attrPrefix(String attrPrefix)
ObservabilityPipelineParseXMLProcessor	displayName(String displayName)
ObservabilityPipelineParseXMLProcessor	enabled(Boolean enabled)
boolean	equals(Object o) Return true if this ObservabilityPipelineParseXMLProcessor object is equal to o.
ObservabilityPipelineParseXMLProcessor	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	getAlwaysUseTextKey() Whether to always use a text key for element content.
String	getAttrPrefix() The prefix to use for XML attributes in the parsed output.
String	getDisplayName() The display name for a component.
Boolean	getEnabled() Indicates whether the processor is enabled.
String	getField() The name of the log field that contains an XML string.
String	getId() The unique identifier for this component.
String	getInclude() A Datadog search query used to determine which logs this processor targets.
Boolean	getIncludeAttr() Whether to include XML attributes in the parsed output.
Boolean	getParseBool() Whether to parse boolean values from strings.
Boolean	getParseNull() Whether to parse null values.
Boolean	getParseNumber() Whether to parse numeric values from strings.
String	getTextKey() The key name to use for text content within XML elements.
ObservabilityPipelineParseXMLProcessorType	getType() The processor type.
int	hashCode()
ObservabilityPipelineParseXMLProcessor	id(String id)
ObservabilityPipelineParseXMLProcessor	include(String include)
ObservabilityPipelineParseXMLProcessor	includeAttr(Boolean includeAttr)
ObservabilityPipelineParseXMLProcessor	parseBool(Boolean parseBool)
ObservabilityPipelineParseXMLProcessor	parseNull(Boolean parseNull)
ObservabilityPipelineParseXMLProcessor	parseNumber(Boolean parseNumber)
ObservabilityPipelineParseXMLProcessor	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setAlwaysUseTextKey(Boolean alwaysUseTextKey)
void	setAttrPrefix(String attrPrefix)
void	setDisplayName(String displayName)
void	setEnabled(Boolean enabled)
void	setField(String field)
void	setId(String id)
void	setInclude(String include)
void	setIncludeAttr(Boolean includeAttr)
void	setParseBool(Boolean parseBool)
void	setParseNull(Boolean parseNull)
void	setParseNumber(Boolean parseNumber)
void	setTextKey(String textKey)
void	setType(ObservabilityPipelineParseXMLProcessorType type)
ObservabilityPipelineParseXMLProcessor	textKey(String textKey)
String	toString()
ObservabilityPipelineParseXMLProcessor	type(ObservabilityPipelineParseXMLProcessorType type)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_ALWAYS_USE_TEXT_KEY

public static final String JSON_PROPERTY_ALWAYS_USE_TEXT_KEY

See Also:

Constant Field Values

JSON_PROPERTY_ATTR_PREFIX

public static final String JSON_PROPERTY_ATTR_PREFIX

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_INCLUDE_ATTR

public static final String JSON_PROPERTY_INCLUDE_ATTR

See Also:

Constant Field Values

JSON_PROPERTY_PARSE_BOOL

public static final String JSON_PROPERTY_PARSE_BOOL

See Also:

Constant Field Values

JSON_PROPERTY_PARSE_NULL

public static final String JSON_PROPERTY_PARSE_NULL

See Also:

Constant Field Values

JSON_PROPERTY_PARSE_NUMBER

public static final String JSON_PROPERTY_PARSE_NUMBER

See Also:

Constant Field Values

JSON_PROPERTY_TEXT_KEY

public static final String JSON_PROPERTY_TEXT_KEY

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

ObservabilityPipelineParseXMLProcessor

public ObservabilityPipelineParseXMLProcessor()

ObservabilityPipelineParseXMLProcessor

public ObservabilityPipelineParseXMLProcessor(Boolean enabled,
                                              String field,
                                              String id,
                                              String include,
                                              ObservabilityPipelineParseXMLProcessorType type)

Method Detail

alwaysUseTextKey

public ObservabilityPipelineParseXMLProcessor alwaysUseTextKey(Boolean alwaysUseTextKey)

getAlwaysUseTextKey

@Nullable
public Boolean getAlwaysUseTextKey()

Whether to always use a text key for element content.

Returns:

alwaysUseTextKey

setAlwaysUseTextKey

public void setAlwaysUseTextKey(Boolean alwaysUseTextKey)

attrPrefix

public ObservabilityPipelineParseXMLProcessor attrPrefix(String attrPrefix)

getAttrPrefix

@Nullable
public String getAttrPrefix()

The prefix to use for XML attributes in the parsed output.

Returns:

attrPrefix

setAttrPrefix

public void setAttrPrefix(String attrPrefix)

displayName

public ObservabilityPipelineParseXMLProcessor displayName(String displayName)

getDisplayName

@Nullable
public String getDisplayName()

The display name for a component.

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

enabled

public ObservabilityPipelineParseXMLProcessor enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

Indicates whether the processor is enabled.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

field

public ObservabilityPipelineParseXMLProcessor field(String field)

getField

public String getField()

The name of the log field that contains an XML string.

Returns:

field

setField

public void setField(String field)

id

public ObservabilityPipelineParseXMLProcessor id(String id)

getId

public String getId()

The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the input to downstream components).

Returns:

id

setId

public void setId(String id)

include

public ObservabilityPipelineParseXMLProcessor 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)

includeAttr

public ObservabilityPipelineParseXMLProcessor includeAttr(Boolean includeAttr)

getIncludeAttr

@Nullable
public Boolean getIncludeAttr()

Whether to include XML attributes in the parsed output.

Returns:

includeAttr

setIncludeAttr

public void setIncludeAttr(Boolean includeAttr)

parseBool

public ObservabilityPipelineParseXMLProcessor parseBool(Boolean parseBool)

getParseBool

@Nullable
public Boolean getParseBool()

Whether to parse boolean values from strings.

Returns:

parseBool

setParseBool

public void setParseBool(Boolean parseBool)

parseNull

public ObservabilityPipelineParseXMLProcessor parseNull(Boolean parseNull)

getParseNull

@Nullable
public Boolean getParseNull()

Whether to parse null values.

Returns:

parseNull

setParseNull

public void setParseNull(Boolean parseNull)

parseNumber

public ObservabilityPipelineParseXMLProcessor parseNumber(Boolean parseNumber)

getParseNumber

@Nullable
public Boolean getParseNumber()

Whether to parse numeric values from strings.

Returns:

parseNumber

setParseNumber

public void setParseNumber(Boolean parseNumber)

textKey

public ObservabilityPipelineParseXMLProcessor textKey(String textKey)

getTextKey

@Nullable
public String getTextKey()

The key name to use for text content within XML elements. Must be at least 1 character if specified.

Returns:

textKey

setTextKey

public void setTextKey(String textKey)

type

public ObservabilityPipelineParseXMLProcessor type(ObservabilityPipelineParseXMLProcessorType type)

getType

public ObservabilityPipelineParseXMLProcessorType getType()

The processor type. The value should always be parse_xml.

Returns:

type

setType

public void setType(ObservabilityPipelineParseXMLProcessorType type)

putAdditionalProperty

public ObservabilityPipelineParseXMLProcessor 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:

ObservabilityPipelineParseXMLProcessor

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 ObservabilityPipelineParseXMLProcessor 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