com.datadog.api.client.v2.model

Class ObservabilityPipelineElasticsearchDestination

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineElasticsearchDestination

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

The elasticsearch destination writes logs or metrics to an Elasticsearch cluster.

Supported pipeline types: logs, metrics

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_API_VERSION
static String	JSON_PROPERTY_AUTH
static String	JSON_PROPERTY_BUFFER
static String	JSON_PROPERTY_BULK_INDEX
static String	JSON_PROPERTY_COMPRESSION
static String	JSON_PROPERTY_DATA_STREAM
static String	JSON_PROPERTY_ENDPOINT_URL_KEY
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_ID_KEY
static String	JSON_PROPERTY_INPUTS
static String	JSON_PROPERTY_PIPELINE
static String	JSON_PROPERTY_REQUEST_RETRY_PARTIAL
static String	JSON_PROPERTY_TLS
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineElasticsearchDestination()
ObservabilityPipelineElasticsearchDestination(String id, List<String> inputs, ObservabilityPipelineElasticsearchDestinationType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineElasticsearchDestination	addInputsItem(String inputsItem)
ObservabilityPipelineElasticsearchDestination	apiVersion(ObservabilityPipelineElasticsearchDestinationApiVersion apiVersion)
ObservabilityPipelineElasticsearchDestination	auth(ObservabilityPipelineElasticsearchDestinationAuth auth)
ObservabilityPipelineElasticsearchDestination	buffer(ObservabilityPipelineBufferOptions buffer)
ObservabilityPipelineElasticsearchDestination	bulkIndex(String bulkIndex)
ObservabilityPipelineElasticsearchDestination	compression(ObservabilityPipelineElasticsearchDestinationCompression compression)
ObservabilityPipelineElasticsearchDestination	dataStream(ObservabilityPipelineElasticsearchDestinationDataStream dataStream)
ObservabilityPipelineElasticsearchDestination	endpointUrlKey(String endpointUrlKey)
boolean	equals(Object o) Return true if this ObservabilityPipelineElasticsearchDestination 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.
ObservabilityPipelineElasticsearchDestinationApiVersion	getApiVersion() The Elasticsearch API version to use.
ObservabilityPipelineElasticsearchDestinationAuth	getAuth() Authentication settings for the Elasticsearch destination.
ObservabilityPipelineBufferOptions	getBuffer() Configuration for buffer settings on destination components.
String	getBulkIndex() The name of the index to write events to in Elasticsearch.
ObservabilityPipelineElasticsearchDestinationCompression	getCompression() Compression configuration for the Elasticsearch destination.
ObservabilityPipelineElasticsearchDestinationDataStream	getDataStream() Configuration options for writing to Elasticsearch Data Streams instead of a fixed index.
String	getEndpointUrlKey() Name of the environment variable or secret that holds the Elasticsearch endpoint URL.
String	getId() The unique identifier for this component.
String	getIdKey() The name of the field used as the document ID in Elasticsearch.
List<String>	getInputs() A list of component IDs whose output is used as the input for this component.
String	getPipeline() The name of an Elasticsearch ingest pipeline to apply to events before indexing.
Boolean	getRequestRetryPartial() When true, retries failed partial bulk requests when some events in a batch fail while others succeed.
ObservabilityPipelineTls	getTls() Configuration for enabling TLS encryption between the pipeline component and external services.
ObservabilityPipelineElasticsearchDestinationType	getType() The destination type.
int	hashCode()
ObservabilityPipelineElasticsearchDestination	id(String id)
ObservabilityPipelineElasticsearchDestination	idKey(String idKey)
ObservabilityPipelineElasticsearchDestination	inputs(List<String> inputs)
ObservabilityPipelineElasticsearchDestination	pipeline(String pipeline)
ObservabilityPipelineElasticsearchDestination	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
ObservabilityPipelineElasticsearchDestination	requestRetryPartial(Boolean requestRetryPartial)
void	setApiVersion(ObservabilityPipelineElasticsearchDestinationApiVersion apiVersion)
void	setAuth(ObservabilityPipelineElasticsearchDestinationAuth auth)
void	setBuffer(ObservabilityPipelineBufferOptions buffer)
void	setBulkIndex(String bulkIndex)
void	setCompression(ObservabilityPipelineElasticsearchDestinationCompression compression)
void	setDataStream(ObservabilityPipelineElasticsearchDestinationDataStream dataStream)
void	setEndpointUrlKey(String endpointUrlKey)
void	setId(String id)
void	setIdKey(String idKey)
void	setInputs(List<String> inputs)
void	setPipeline(String pipeline)
void	setRequestRetryPartial(Boolean requestRetryPartial)
void	setTls(ObservabilityPipelineTls tls)
void	setType(ObservabilityPipelineElasticsearchDestinationType type)
ObservabilityPipelineElasticsearchDestination	tls(ObservabilityPipelineTls tls)
String	toString()
ObservabilityPipelineElasticsearchDestination	type(ObservabilityPipelineElasticsearchDestinationType type)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_API_VERSION

public static final String JSON_PROPERTY_API_VERSION

See Also:

Constant Field Values

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_COMPRESSION

public static final String JSON_PROPERTY_COMPRESSION

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_ID_KEY

public static final String JSON_PROPERTY_ID_KEY

See Also:

Constant Field Values

JSON_PROPERTY_INPUTS

public static final String JSON_PROPERTY_INPUTS

See Also:

Constant Field Values

JSON_PROPERTY_PIPELINE

public static final String JSON_PROPERTY_PIPELINE

See Also:

Constant Field Values

JSON_PROPERTY_REQUEST_RETRY_PARTIAL

public static final String JSON_PROPERTY_REQUEST_RETRY_PARTIAL

See Also:

Constant Field Values

JSON_PROPERTY_TLS

public static final String JSON_PROPERTY_TLS

See Also:

Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

Constant Field Values

Constructor Detail

ObservabilityPipelineElasticsearchDestination

public ObservabilityPipelineElasticsearchDestination()

ObservabilityPipelineElasticsearchDestination

public ObservabilityPipelineElasticsearchDestination(String id,
                                                     List<String> inputs,
                                                     ObservabilityPipelineElasticsearchDestinationType type)

Method Detail

apiVersion

public ObservabilityPipelineElasticsearchDestination apiVersion(ObservabilityPipelineElasticsearchDestinationApiVersion apiVersion)

getApiVersion

@Nullable
public ObservabilityPipelineElasticsearchDestinationApiVersion getApiVersion()

The Elasticsearch API version to use. Set to auto to auto-detect.

Returns:

apiVersion

setApiVersion

public void setApiVersion(ObservabilityPipelineElasticsearchDestinationApiVersion apiVersion)

auth

public ObservabilityPipelineElasticsearchDestination 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 ObservabilityPipelineElasticsearchDestination 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 ObservabilityPipelineElasticsearchDestination bulkIndex(String bulkIndex)

getBulkIndex

@Nullable
public String getBulkIndex()

The name of the index to write events to in Elasticsearch.

Returns:

bulkIndex

setBulkIndex

public void setBulkIndex(String bulkIndex)

compression

public ObservabilityPipelineElasticsearchDestination compression(ObservabilityPipelineElasticsearchDestinationCompression compression)

getCompression

@Nullable
public ObservabilityPipelineElasticsearchDestinationCompression getCompression()

Compression configuration for the Elasticsearch destination.

Returns:

compression

setCompression

public void setCompression(ObservabilityPipelineElasticsearchDestinationCompression compression)

dataStream

public ObservabilityPipelineElasticsearchDestination dataStream(ObservabilityPipelineElasticsearchDestinationDataStream dataStream)

getDataStream

@Nullable
public ObservabilityPipelineElasticsearchDestinationDataStream getDataStream()

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

Returns:

dataStream

setDataStream

public void setDataStream(ObservabilityPipelineElasticsearchDestinationDataStream dataStream)

endpointUrlKey

public ObservabilityPipelineElasticsearchDestination endpointUrlKey(String endpointUrlKey)

getEndpointUrlKey

@Nullable
public String getEndpointUrlKey()

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

Returns:

endpointUrlKey

setEndpointUrlKey

public void setEndpointUrlKey(String endpointUrlKey)

id

public ObservabilityPipelineElasticsearchDestination id(String id)

getId

public String getId()

The unique identifier for this component.

Returns:

id

setId

public void setId(String id)

idKey

public ObservabilityPipelineElasticsearchDestination idKey(String idKey)

getIdKey

@Nullable
public String getIdKey()

The name of the field used as the document ID in Elasticsearch.

Returns:

idKey

setIdKey

public void setIdKey(String idKey)

inputs

public ObservabilityPipelineElasticsearchDestination inputs(List<String> inputs)

addInputsItem

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

pipeline

public ObservabilityPipelineElasticsearchDestination pipeline(String pipeline)

getPipeline

@Nullable
public String getPipeline()

The name of an Elasticsearch ingest pipeline to apply to events before indexing.

Returns:

pipeline

setPipeline

public void setPipeline(String pipeline)

requestRetryPartial

public ObservabilityPipelineElasticsearchDestination requestRetryPartial(Boolean requestRetryPartial)

getRequestRetryPartial

@Nullable
public Boolean getRequestRetryPartial()

When true, retries failed partial bulk requests when some events in a batch fail while others succeed.

Returns:

requestRetryPartial

setRequestRetryPartial

public void setRequestRetryPartial(Boolean requestRetryPartial)

tls

public ObservabilityPipelineElasticsearchDestination tls(ObservabilityPipelineTls tls)

getTls

@Nullable
public ObservabilityPipelineTls getTls()

Configuration for enabling TLS encryption between the pipeline component and external services.

Returns:

tls

setTls

public void setTls(ObservabilityPipelineTls tls)

type

public ObservabilityPipelineElasticsearchDestination type(ObservabilityPipelineElasticsearchDestinationType type)

getType

public ObservabilityPipelineElasticsearchDestinationType getType()

The destination type. The value should always be elasticsearch.

Returns:

type

setType

public void setType(ObservabilityPipelineElasticsearchDestinationType type)

putAdditionalProperty

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

ObservabilityPipelineElasticsearchDestination

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