Package com.datadog.api.client.v1.model

Class LogsSchemaCategoryMapper

java.lang.Object

com.datadog.api.client.v1.model.LogsSchemaCategoryMapper

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

Use the Schema Category Mapper to categorize log event into enum fields. In the case of OCSF, they can be used to map sibling fields which are composed of an ID and a name.

Notes:

• The syntax of the query is the one of Logs Explorer search bar. The query can be done on any log attribute or tag, whether it is a facet or not. Wildcards can also be used inside your query.
• Categories are executed in order and processing stops at the first match. Make sure categories are properly ordered in case a log could match multiple queries.
• Sibling fields always have a numerical ID field and a human-readable string name.
• A fallback section handles cases where the name or ID value matches a specific value. If the name matches "Other" or the ID matches 99, the value of the sibling name field will be pulled from a source field from the original log.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_CATEGORIES
static final String	JSON_PROPERTY_FALLBACK
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_TARGETS
static final String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
LogsSchemaCategoryMapper()
LogsSchemaCategoryMapper(List<LogsSchemaCategoryMapperCategory> categories, String name, LogsSchemaCategoryMapperTargets targets, LogsSchemaCategoryMapperType type)

Method Summary

Modifier and Type	Method	Description
LogsSchemaCategoryMapper	addCategoriesItem(LogsSchemaCategoryMapperCategory categoriesItem)
LogsSchemaCategoryMapper	categories(List<LogsSchemaCategoryMapperCategory> categories)
boolean	equals(Object o)	Return true if this LogsSchemaCategoryMapper object is equal to o.
LogsSchemaCategoryMapper	fallback(LogsSchemaCategoryMapperFallback fallback)
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
List<LogsSchemaCategoryMapperCategory>	getCategories()	Array of filters to match or not a log and their corresponding name to assign a custom value to the log.
LogsSchemaCategoryMapperFallback	getFallback()	Used to override hardcoded category values with a value pulled from a source attribute on the log.
String	getName()	Name of the logs schema category mapper.
LogsSchemaCategoryMapperTargets	getTargets()	Name of the target attributes which value is defined by the matching category.
LogsSchemaCategoryMapperType	getType()	Type of logs schema category mapper.
int	hashCode()
LogsSchemaCategoryMapper	name(String name)
LogsSchemaCategoryMapper	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setCategories(List<LogsSchemaCategoryMapperCategory> categories)
void	setFallback(LogsSchemaCategoryMapperFallback fallback)
void	setName(String name)
void	setTargets(LogsSchemaCategoryMapperTargets targets)
void	setType(LogsSchemaCategoryMapperType type)
LogsSchemaCategoryMapper	targets(LogsSchemaCategoryMapperTargets targets)
String	toString()
LogsSchemaCategoryMapper	type(LogsSchemaCategoryMapperType type)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_CATEGORIES

public static final String JSON_PROPERTY_CATEGORIES

See Also:

• Constant Field Values

JSON_PROPERTY_FALLBACK

public static final String JSON_PROPERTY_FALLBACK

See Also:

• Constant Field Values

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_TARGETS

public static final String JSON_PROPERTY_TARGETS

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

Constructor Details

LogsSchemaCategoryMapper

public LogsSchemaCategoryMapper()

LogsSchemaCategoryMapper

public LogsSchemaCategoryMapper(List<LogsSchemaCategoryMapperCategory> categories,
 String name,
 LogsSchemaCategoryMapperTargets targets,
 LogsSchemaCategoryMapperType type)

Method Details

categories

public LogsSchemaCategoryMapper categories(List<LogsSchemaCategoryMapperCategory> categories)

addCategoriesItem

public LogsSchemaCategoryMapper addCategoriesItem(LogsSchemaCategoryMapperCategory categoriesItem)

getCategories

public List<LogsSchemaCategoryMapperCategory> getCategories()

Array of filters to match or not a log and their corresponding name to assign a custom value to the log.

Returns:

categories

setCategories

public void setCategories(List<LogsSchemaCategoryMapperCategory> categories)

fallback

public LogsSchemaCategoryMapper fallback(LogsSchemaCategoryMapperFallback fallback)

getFallback

@Nullable
public LogsSchemaCategoryMapperFallback getFallback()

Used to override hardcoded category values with a value pulled from a source attribute on the log.

Returns:

fallback

setFallback

public void setFallback(LogsSchemaCategoryMapperFallback fallback)

name

public LogsSchemaCategoryMapper name(String name)

getName

public String getName()

Name of the logs schema category mapper.

Returns:

name

setName

public void setName(String name)

targets

public LogsSchemaCategoryMapper targets(LogsSchemaCategoryMapperTargets targets)

getTargets

public LogsSchemaCategoryMapperTargets getTargets()

Name of the target attributes which value is defined by the matching category.

Returns:

targets

setTargets

public void setTargets(LogsSchemaCategoryMapperTargets targets)

type

public LogsSchemaCategoryMapper type(LogsSchemaCategoryMapperType type)

getType

public LogsSchemaCategoryMapperType getType()

Type of logs schema category mapper.

Returns:

type

setType

public void setType(LogsSchemaCategoryMapperType type)

putAdditionalProperty

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

LogsSchemaCategoryMapper

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