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

Class ObservabilityPipelineOpenSearchDestination

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineOpenSearchDestination

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

The opensearch destination writes logs to an OpenSearch cluster.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_AUTH
static final String	JSON_PROPERTY_BUFFER
static final String	JSON_PROPERTY_BULK_INDEX
static final String	JSON_PROPERTY_DATA_STREAM
static final String	JSON_PROPERTY_ENDPOINT_URL_KEY
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_INPUTS
static final String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
ObservabilityPipelineOpenSearchDestination()
ObservabilityPipelineOpenSearchDestination(String id, List<String> inputs, ObservabilityPipelineOpenSearchDestinationType type)

Method Summary

Modifier and Type	Method	Description
ObservabilityPipelineOpenSearchDestination	addInputsItem(String inputsItem)
ObservabilityPipelineOpenSearchDestination	auth(ObservabilityPipelineElasticsearchDestinationAuth auth)
ObservabilityPipelineOpenSearchDestination	buffer(ObservabilityPipelineBufferOptions buffer)
ObservabilityPipelineOpenSearchDestination	bulkIndex(String bulkIndex)
ObservabilityPipelineOpenSearchDestination	dataStream(ObservabilityPipelineOpenSearchDestinationDataStream dataStream)
ObservabilityPipelineOpenSearchDestination	endpointUrlKey(String endpointUrlKey)
boolean	equals(Object o)	Return true if this ObservabilityPipelineOpenSearchDestination 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.
ObservabilityPipelineElasticsearchDestinationAuth	getAuth()	Authentication settings for the Elasticsearch destination.
ObservabilityPipelineBufferOptions	getBuffer()	Configuration for buffer settings on destination components.
String	getBulkIndex()	The index to write logs to.
ObservabilityPipelineOpenSearchDestinationDataStream	getDataStream()	Configuration options for writing to OpenSearch Data Streams instead of a fixed index.
String	getEndpointUrlKey()	Name of the environment variable or secret that holds the OpenSearch endpoint URL.
String	getId()	The unique identifier for this component.
List<String>	getInputs()	A list of component IDs whose output is used as the input for this component.
ObservabilityPipelineOpenSearchDestinationType	getType()	The destination type.
int	hashCode()
ObservabilityPipelineOpenSearchDestination	id(String id)
ObservabilityPipelineOpenSearchDestination	inputs(List<String> inputs)
ObservabilityPipelineOpenSearchDestination	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setAuth(ObservabilityPipelineElasticsearchDestinationAuth auth)
void	setBuffer(ObservabilityPipelineBufferOptions buffer)
void	setBulkIndex(String bulkIndex)
void	setDataStream(ObservabilityPipelineOpenSearchDestinationDataStream dataStream)
void	setEndpointUrlKey(String endpointUrlKey)
void	setId(String id)
void	setInputs(List<String> inputs)
void	setType(ObservabilityPipelineOpenSearchDestinationType type)
String	toString()
ObservabilityPipelineOpenSearchDestination	type(ObservabilityPipelineOpenSearchDestinationType type)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_AUTH

public static final String JSON_PROPERTY_AUTH

See Also:

• Constant Field Values

JSON_PROPERTY_BUFFER

public static final String JSON_PROPERTY_BUFFER

See Also:

• Constant Field Values

JSON_PROPERTY_BULK_INDEX

public static final String JSON_PROPERTY_BULK_INDEX

See Also:

• Constant Field Values

JSON_PROPERTY_DATA_STREAM

public static final String JSON_PROPERTY_DATA_STREAM

See Also:

• Constant Field Values

JSON_PROPERTY_ENDPOINT_URL_KEY

public static final String JSON_PROPERTY_ENDPOINT_URL_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

• Constant Field Values

JSON_PROPERTY_INPUTS

public static final String JSON_PROPERTY_INPUTS

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

Constructor Details

ObservabilityPipelineOpenSearchDestination

public ObservabilityPipelineOpenSearchDestination()

ObservabilityPipelineOpenSearchDestination

public ObservabilityPipelineOpenSearchDestination(String id,
 List<String> inputs,
 ObservabilityPipelineOpenSearchDestinationType type)

Method Details

auth

public ObservabilityPipelineOpenSearchDestination auth(ObservabilityPipelineElasticsearchDestinationAuth auth)

getAuth

@Nullable
public ObservabilityPipelineElasticsearchDestinationAuth getAuth()

Authentication settings for the Elasticsearch destination. When strategy is basic, use username_key and password_key to reference credentials stored in environment variables or secrets.

Returns:

auth

setAuth

public void setAuth(ObservabilityPipelineElasticsearchDestinationAuth auth)

buffer

public ObservabilityPipelineOpenSearchDestination buffer(ObservabilityPipelineBufferOptions buffer)

getBuffer

@Nullable
public ObservabilityPipelineBufferOptions getBuffer()

Configuration for buffer settings on destination components.

Returns:

buffer

setBuffer

public void setBuffer(ObservabilityPipelineBufferOptions buffer)

bulkIndex

public ObservabilityPipelineOpenSearchDestination bulkIndex(String bulkIndex)

getBulkIndex

@Nullable
public String getBulkIndex()

The index to write logs to.

Returns:

bulkIndex

setBulkIndex

public void setBulkIndex(String bulkIndex)

dataStream

public ObservabilityPipelineOpenSearchDestination dataStream(ObservabilityPipelineOpenSearchDestinationDataStream dataStream)

getDataStream

@Nullable
public ObservabilityPipelineOpenSearchDestinationDataStream getDataStream()

Configuration options for writing to OpenSearch Data Streams instead of a fixed index.

Returns:

dataStream

setDataStream

public void setDataStream(ObservabilityPipelineOpenSearchDestinationDataStream dataStream)

endpointUrlKey

public ObservabilityPipelineOpenSearchDestination endpointUrlKey(String endpointUrlKey)

getEndpointUrlKey

@Nullable
public String getEndpointUrlKey()

Name of the environment variable or secret that holds the OpenSearch endpoint URL.

Returns:

endpointUrlKey

setEndpointUrlKey

public void setEndpointUrlKey(String endpointUrlKey)

id

public ObservabilityPipelineOpenSearchDestination id(String id)

getId

public String getId()

The unique identifier for this component.

Returns:

id

setId

public void setId(String id)

inputs

public ObservabilityPipelineOpenSearchDestination inputs(List<String> inputs)

addInputsItem

public ObservabilityPipelineOpenSearchDestination addInputsItem(String inputsItem)

getInputs

public List<String> getInputs()

A list of component IDs whose output is used as the input for this component.

Returns:

inputs

setInputs

public void setInputs(List<String> inputs)

type

public ObservabilityPipelineOpenSearchDestination type(ObservabilityPipelineOpenSearchDestinationType type)

getType

public ObservabilityPipelineOpenSearchDestinationType getType()

The destination type. The value should always be opensearch.

Returns:

type

setType

public void setType(ObservabilityPipelineOpenSearchDestinationType type)

putAdditionalProperty

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

ObservabilityPipelineOpenSearchDestination

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