com.datadog.api.client.v2.model

Class ObservabilityPipelineOcsfMapperProcessor

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineOcsfMapperProcessor

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

The ocsf_mapper processor transforms logs into the OCSF schema using a predefined mapping configuration.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_DISPLAY_NAME
static String	JSON_PROPERTY_ENABLED
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_INCLUDE
static String	JSON_PROPERTY_KEEP_UNMATCHED
static String	JSON_PROPERTY_MAPPINGS
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineOcsfMapperProcessor()
ObservabilityPipelineOcsfMapperProcessor(Boolean enabled, String id, String include, List<ObservabilityPipelineOcsfMapperProcessorMapping> mappings, ObservabilityPipelineOcsfMapperProcessorType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineOcsfMapperProcessor	addMappingsItem(ObservabilityPipelineOcsfMapperProcessorMapping mappingsItem)
ObservabilityPipelineOcsfMapperProcessor	displayName(String displayName)
ObservabilityPipelineOcsfMapperProcessor	enabled(Boolean enabled)
boolean	equals(Object o) Return true if this ObservabilityPipelineOcsfMapperProcessor object is equal to o.
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
String	getDisplayName() The display name for a component.
Boolean	getEnabled() Indicates whether the processor is enabled.
String	getId() The unique identifier for this component.
String	getInclude() A Datadog search query used to determine which logs this processor targets.
Boolean	getKeepUnmatched() Whether to keep an event that does not match any of the mapping filters.
List<ObservabilityPipelineOcsfMapperProcessorMapping>	getMappings() A list of mapping rules to convert events to the OCSF format.
ObservabilityPipelineOcsfMapperProcessorType	getType() The processor type.
int	hashCode()
ObservabilityPipelineOcsfMapperProcessor	id(String id)
ObservabilityPipelineOcsfMapperProcessor	include(String include)
ObservabilityPipelineOcsfMapperProcessor	keepUnmatched(Boolean keepUnmatched)
ObservabilityPipelineOcsfMapperProcessor	mappings(List<ObservabilityPipelineOcsfMapperProcessorMapping> mappings)
ObservabilityPipelineOcsfMapperProcessor	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setDisplayName(String displayName)
void	setEnabled(Boolean enabled)
void	setId(String id)
void	setInclude(String include)
void	setKeepUnmatched(Boolean keepUnmatched)
void	setMappings(List<ObservabilityPipelineOcsfMapperProcessorMapping> mappings)
void	setType(ObservabilityPipelineOcsfMapperProcessorType type)
String	toString()
ObservabilityPipelineOcsfMapperProcessor	type(ObservabilityPipelineOcsfMapperProcessorType type)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

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_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_KEEP_UNMATCHED

public static final String JSON_PROPERTY_KEEP_UNMATCHED

See Also:

Constant Field Values

JSON_PROPERTY_MAPPINGS

public static final String JSON_PROPERTY_MAPPINGS

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

ObservabilityPipelineOcsfMapperProcessor

public ObservabilityPipelineOcsfMapperProcessor()

ObservabilityPipelineOcsfMapperProcessor

public ObservabilityPipelineOcsfMapperProcessor(Boolean enabled,
                                                String id,
                                                String include,
                                                List<ObservabilityPipelineOcsfMapperProcessorMapping> mappings,
                                                ObservabilityPipelineOcsfMapperProcessorType type)

Method Detail

displayName

public ObservabilityPipelineOcsfMapperProcessor displayName(String displayName)

getDisplayName

@Nullable
public String getDisplayName()

The display name for a component.

Returns:

displayName

setDisplayName

public void setDisplayName(String displayName)

enabled

public ObservabilityPipelineOcsfMapperProcessor enabled(Boolean enabled)

getEnabled

public Boolean getEnabled()

Indicates whether the processor is enabled.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

id

public ObservabilityPipelineOcsfMapperProcessor id(String id)

getId

public String getId()

The unique identifier for this component. Used to reference this component in other parts of the pipeline.

Returns:

id

setId

public void setId(String id)

include

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

keepUnmatched

public ObservabilityPipelineOcsfMapperProcessor keepUnmatched(Boolean keepUnmatched)

getKeepUnmatched

@Nullable
public Boolean getKeepUnmatched()

Whether to keep an event that does not match any of the mapping filters.

Returns:

keepUnmatched

setKeepUnmatched

public void setKeepUnmatched(Boolean keepUnmatched)

mappings

public ObservabilityPipelineOcsfMapperProcessor mappings(List<ObservabilityPipelineOcsfMapperProcessorMapping> mappings)

addMappingsItem

public ObservabilityPipelineOcsfMapperProcessor addMappingsItem(ObservabilityPipelineOcsfMapperProcessorMapping mappingsItem)

getMappings

public List<ObservabilityPipelineOcsfMapperProcessorMapping> getMappings()

A list of mapping rules to convert events to the OCSF format.

Returns:

mappings

setMappings

public void setMappings(List<ObservabilityPipelineOcsfMapperProcessorMapping> mappings)

type

public ObservabilityPipelineOcsfMapperProcessor type(ObservabilityPipelineOcsfMapperProcessorType type)

getType

public ObservabilityPipelineOcsfMapperProcessorType getType()

The processor type. The value should always be ocsf_mapper.

Returns:

type

setType

public void setType(ObservabilityPipelineOcsfMapperProcessorType type)

putAdditionalProperty

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

ObservabilityPipelineOcsfMapperProcessor

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