com.datadog.api.client.v2.model

Class ObservabilityPipelineClickhouseDestination

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineClickhouseDestination

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

The clickhouse destination sends log events to a ClickHouse database table over HTTP.

Supported pipeline types: logs.

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_AUTH
static String	JSON_PROPERTY_BATCH
static String	JSON_PROPERTY_BATCH_ENCODING
static String	JSON_PROPERTY_BUFFER
static String	JSON_PROPERTY_COMPRESSION
static String	JSON_PROPERTY_DATABASE
static String	JSON_PROPERTY_DATE_TIME_BEST_EFFORT
static String	JSON_PROPERTY_ENDPOINT_URL_KEY
static String	JSON_PROPERTY_FORMAT
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_INPUTS
static String	JSON_PROPERTY_SKIP_UNKNOWN_FIELDS
static String	JSON_PROPERTY_TABLE
static String	JSON_PROPERTY_TLS
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineClickhouseDestination()
ObservabilityPipelineClickhouseDestination(String id, List<String> inputs, String table, ObservabilityPipelineClickhouseDestinationType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineClickhouseDestination	addInputsItem(String inputsItem)
ObservabilityPipelineClickhouseDestination	auth(ObservabilityPipelineClickhouseDestinationAuth auth)
ObservabilityPipelineClickhouseDestination	batch(ObservabilityPipelineClickhouseDestinationBatch batch)
ObservabilityPipelineClickhouseDestination	batchEncoding(ObservabilityPipelineClickhouseDestinationBatchEncoding batchEncoding)
ObservabilityPipelineClickhouseDestination	buffer(ObservabilityPipelineBufferOptions buffer)
ObservabilityPipelineClickhouseDestination	compression(ObservabilityPipelineClickhouseDestinationCompression compression)
ObservabilityPipelineClickhouseDestination	database(String database)
ObservabilityPipelineClickhouseDestination	dateTimeBestEffort(Boolean dateTimeBestEffort)
ObservabilityPipelineClickhouseDestination	endpointUrlKey(String endpointUrlKey)
boolean	equals(Object o) Return true if this ObservabilityPipelineClickhouseDestination object is equal to o.
ObservabilityPipelineClickhouseDestination	format(ObservabilityPipelineClickhouseDestinationFormat format)
Map<String,Object>	getAdditionalProperties() Return the additional (undeclared) property.
Object	getAdditionalProperty(String key) Return the additional (undeclared) property with the specified name.
ObservabilityPipelineClickhouseDestinationAuth	getAuth() HTTP Basic Authentication credentials for the ClickHouse destination.
ObservabilityPipelineClickhouseDestinationBatch	getBatch() Batching configuration for ClickHouse inserts.
ObservabilityPipelineClickhouseDestinationBatchEncoding	getBatchEncoding() Batch encoding configuration for the ClickHouse destination.
ObservabilityPipelineBufferOptions	getBuffer() Configuration for buffer settings on destination components.
ObservabilityPipelineClickhouseDestinationCompression	getCompression() Compression setting for outbound HTTP requests to ClickHouse.
String	getDatabase() Optional ClickHouse database name.
Boolean	getDateTimeBestEffort() When true, enables flexible DateTime parsing on the ClickHouse server side.
String	getEndpointUrlKey() Name of the environment variable or secret that contains the ClickHouse HTTP endpoint URL.
ObservabilityPipelineClickhouseDestinationFormat	getFormat() Insert format for events sent to ClickHouse.
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.
org.openapitools.jackson.nullable.JsonNullable<Boolean>	getSkipUnknownFields_JsonNullable()
Boolean	getSkipUnknownFields() When true, fields not present in the target table schema are dropped instead of causing insert errors.
String	getTable() Target ClickHouse table name.
ObservabilityPipelineTls	getTls() Configuration for enabling TLS encryption between the pipeline component and external services.
ObservabilityPipelineClickhouseDestinationType	getType() The destination type.
int	hashCode()
ObservabilityPipelineClickhouseDestination	id(String id)
ObservabilityPipelineClickhouseDestination	inputs(List<String> inputs)
ObservabilityPipelineClickhouseDestination	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setAuth(ObservabilityPipelineClickhouseDestinationAuth auth)
void	setBatch(ObservabilityPipelineClickhouseDestinationBatch batch)
void	setBatchEncoding(ObservabilityPipelineClickhouseDestinationBatchEncoding batchEncoding)
void	setBuffer(ObservabilityPipelineBufferOptions buffer)
void	setCompression(ObservabilityPipelineClickhouseDestinationCompression compression)
void	setDatabase(String database)
void	setDateTimeBestEffort(Boolean dateTimeBestEffort)
void	setEndpointUrlKey(String endpointUrlKey)
void	setFormat(ObservabilityPipelineClickhouseDestinationFormat format)
void	setId(String id)
void	setInputs(List<String> inputs)
void	setSkipUnknownFields_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> skipUnknownFields)
void	setSkipUnknownFields(Boolean skipUnknownFields)
void	setTable(String table)
void	setTls(ObservabilityPipelineTls tls)
void	setType(ObservabilityPipelineClickhouseDestinationType type)
ObservabilityPipelineClickhouseDestination	skipUnknownFields(Boolean skipUnknownFields)
ObservabilityPipelineClickhouseDestination	table(String table)
ObservabilityPipelineClickhouseDestination	tls(ObservabilityPipelineTls tls)
String	toString()
ObservabilityPipelineClickhouseDestination	type(ObservabilityPipelineClickhouseDestinationType type)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_AUTH

public static final String JSON_PROPERTY_AUTH

See Also:

Constant Field Values

JSON_PROPERTY_BATCH

public static final String JSON_PROPERTY_BATCH

See Also:

Constant Field Values

JSON_PROPERTY_BATCH_ENCODING

public static final String JSON_PROPERTY_BATCH_ENCODING

See Also:

Constant Field Values

JSON_PROPERTY_BUFFER

public static final String JSON_PROPERTY_BUFFER

See Also:

Constant Field Values

JSON_PROPERTY_COMPRESSION

public static final String JSON_PROPERTY_COMPRESSION

See Also:

Constant Field Values

JSON_PROPERTY_DATABASE

public static final String JSON_PROPERTY_DATABASE

See Also:

Constant Field Values

JSON_PROPERTY_DATE_TIME_BEST_EFFORT

public static final String JSON_PROPERTY_DATE_TIME_BEST_EFFORT

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_FORMAT

public static final String JSON_PROPERTY_FORMAT

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_SKIP_UNKNOWN_FIELDS

public static final String JSON_PROPERTY_SKIP_UNKNOWN_FIELDS

See Also:

Constant Field Values

JSON_PROPERTY_TABLE

public static final String JSON_PROPERTY_TABLE

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

ObservabilityPipelineClickhouseDestination

public ObservabilityPipelineClickhouseDestination()

ObservabilityPipelineClickhouseDestination

public ObservabilityPipelineClickhouseDestination(String id,
                                                  List<String> inputs,
                                                  String table,
                                                  ObservabilityPipelineClickhouseDestinationType type)

Method Detail

auth

public ObservabilityPipelineClickhouseDestination auth(ObservabilityPipelineClickhouseDestinationAuth auth)

getAuth

@Nullable
public ObservabilityPipelineClickhouseDestinationAuth getAuth()

HTTP Basic Authentication credentials for the ClickHouse destination. When strategy is basic, provide username_key and password_key that reference environment variables or secrets containing the credentials.

Returns:

auth

setAuth

public void setAuth(ObservabilityPipelineClickhouseDestinationAuth auth)

batch

public ObservabilityPipelineClickhouseDestination batch(ObservabilityPipelineClickhouseDestinationBatch batch)

getBatch

@Nullable
public ObservabilityPipelineClickhouseDestinationBatch getBatch()

Batching configuration for ClickHouse inserts.

Returns:

batch

setBatch

public void setBatch(ObservabilityPipelineClickhouseDestinationBatch batch)

batchEncoding

public ObservabilityPipelineClickhouseDestination batchEncoding(ObservabilityPipelineClickhouseDestinationBatchEncoding batchEncoding)

getBatchEncoding

@Nullable
public ObservabilityPipelineClickhouseDestinationBatchEncoding getBatchEncoding()

Batch encoding configuration for the ClickHouse destination. Required when format is arrow_stream. The codec field must be set to arrow_stream .

Returns:

batchEncoding

setBatchEncoding

public void setBatchEncoding(ObservabilityPipelineClickhouseDestinationBatchEncoding batchEncoding)

buffer

public ObservabilityPipelineClickhouseDestination buffer(ObservabilityPipelineBufferOptions buffer)

getBuffer

@Nullable
public ObservabilityPipelineBufferOptions getBuffer()

Configuration for buffer settings on destination components.

Returns:

buffer

setBuffer

public void setBuffer(ObservabilityPipelineBufferOptions buffer)

compression

public ObservabilityPipelineClickhouseDestination compression(ObservabilityPipelineClickhouseDestinationCompression compression)

getCompression

@Nullable
public ObservabilityPipelineClickhouseDestinationCompression getCompression()

Compression setting for outbound HTTP requests to ClickHouse. Can be specified as a shorthand string ("gzip" or "none") or as an object with an algorithm field and an optional level (gzip only, 1–9).

Returns:

compression

setCompression

public void setCompression(ObservabilityPipelineClickhouseDestinationCompression compression)

database

public ObservabilityPipelineClickhouseDestination database(String database)

getDatabase

@Nullable
public String getDatabase()

Optional ClickHouse database name. If omitted, the user's default database on the ClickHouse server is used.

Returns:

database

setDatabase

public void setDatabase(String database)

dateTimeBestEffort

public ObservabilityPipelineClickhouseDestination dateTimeBestEffort(Boolean dateTimeBestEffort)

getDateTimeBestEffort

@Nullable
public Boolean getDateTimeBestEffort()

When true, enables flexible DateTime parsing on the ClickHouse server side.

Returns:

dateTimeBestEffort

setDateTimeBestEffort

public void setDateTimeBestEffort(Boolean dateTimeBestEffort)

endpointUrlKey

public ObservabilityPipelineClickhouseDestination endpointUrlKey(String endpointUrlKey)

getEndpointUrlKey

@Nullable
public String getEndpointUrlKey()

Name of the environment variable or secret that contains the ClickHouse HTTP endpoint URL. Defaults to DESTINATION_CLICKHOUSE_ENDPOINT_URL (prefixed with DD_OP_ at runtime).

Returns:

endpointUrlKey

setEndpointUrlKey

public void setEndpointUrlKey(String endpointUrlKey)

format

public ObservabilityPipelineClickhouseDestination format(ObservabilityPipelineClickhouseDestinationFormat format)

getFormat

@Nullable
public ObservabilityPipelineClickhouseDestinationFormat getFormat()

Insert format for events sent to ClickHouse. - json_each_row: Maps event fields to columns by name (ClickHouse JSONEachRow). - json_as_object: Inserts each event into a single Object('json') / JSON column (ClickHouse JSONAsObject). - json_as_string: Inserts each event into a single String-typed column as raw JSON (ClickHouse JSONAsString). - arrow_stream: Batches events using Apache Arrow IPC streaming format. Requires batch_encoding.

Returns:

format

setFormat

public void setFormat(ObservabilityPipelineClickhouseDestinationFormat format)

id

public ObservabilityPipelineClickhouseDestination id(String id)

getId

public String getId()

The unique identifier for this component.

Returns:

id

setId

public void setId(String id)

inputs

public ObservabilityPipelineClickhouseDestination inputs(List<String> inputs)

addInputsItem

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

skipUnknownFields

public ObservabilityPipelineClickhouseDestination skipUnknownFields(Boolean skipUnknownFields)

getSkipUnknownFields

@Nullable
public Boolean getSkipUnknownFields()

When true, fields not present in the target table schema are dropped instead of causing insert errors. When unset, the ClickHouse server's own input_format_skip_unknown_fields setting applies.

Returns:

skipUnknownFields

getSkipUnknownFields_JsonNullable

public org.openapitools.jackson.nullable.JsonNullable<Boolean> getSkipUnknownFields_JsonNullable()

setSkipUnknownFields_JsonNullable

public void setSkipUnknownFields_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Boolean> skipUnknownFields)

setSkipUnknownFields

public void setSkipUnknownFields(Boolean skipUnknownFields)

table

public ObservabilityPipelineClickhouseDestination table(String table)

getTable

public String getTable()

Target ClickHouse table name. Events are inserted into this table.

Returns:

table

setTable

public void setTable(String table)

tls

public ObservabilityPipelineClickhouseDestination 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 ObservabilityPipelineClickhouseDestination type(ObservabilityPipelineClickhouseDestinationType type)

getType

public ObservabilityPipelineClickhouseDestinationType getType()

The destination type. The value must be clickhouse.

Returns:

type

setType

public void setType(ObservabilityPipelineClickhouseDestinationType type)

putAdditionalProperty

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

ObservabilityPipelineClickhouseDestination

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