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

Class ObservabilityPipelinePrometheusRemoteWriteDestination

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelinePrometheusRemoteWriteDestination

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

The prometheus_remote_write destination forwards metrics to an endpoint that supports the Prometheus Remote Write protocol.

Supported pipeline types: metrics

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_AUTH_STRATEGY
static final String	JSON_PROPERTY_BUFFER
static final String	JSON_PROPERTY_DEFAULT_NAMESPACE
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_PASSWORD_KEY
static final String	JSON_PROPERTY_TENANT_ID
static final String	JSON_PROPERTY_TLS
static final String	JSON_PROPERTY_TOKEN_KEY
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_USERNAME_KEY
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
ObservabilityPipelinePrometheusRemoteWriteDestination()
ObservabilityPipelinePrometheusRemoteWriteDestination(String id, List<String> inputs, ObservabilityPipelinePrometheusRemoteWriteDestinationType type)

Method Summary

Modifier and Type	Method	Description
ObservabilityPipelinePrometheusRemoteWriteDestination	addInputsItem(String inputsItem)
ObservabilityPipelinePrometheusRemoteWriteDestination	authStrategy(ObservabilityPipelinePrometheusRemoteWriteDestinationAuthStrategy authStrategy)
ObservabilityPipelinePrometheusRemoteWriteDestination	buffer(ObservabilityPipelineBufferOptions buffer)
ObservabilityPipelinePrometheusRemoteWriteDestination	defaultNamespace(String defaultNamespace)
ObservabilityPipelinePrometheusRemoteWriteDestination	endpointUrlKey(String endpointUrlKey)
boolean	equals(Object o)	Return true if this ObservabilityPipelinePrometheusRemoteWriteDestination 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.
ObservabilityPipelinePrometheusRemoteWriteDestinationAuthStrategy	getAuthStrategy()	The authentication strategy to use for outgoing Prometheus Remote Write requests.
ObservabilityPipelineBufferOptions	getBuffer()	Configuration for buffer settings on destination components.
String	getDefaultNamespace()	The default namespace to add as a prefix to metric names that do not already have one.
String	getEndpointUrlKey()	Name of the environment variable or secret that holds the Prometheus Remote Write 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.
String	getPasswordKey()	Name of the environment variable or secret that holds the password (used when auth_strategy is basic).
String	getTenantId()	The tenant ID to include with outgoing requests.
ObservabilityPipelineClientTls	getTls()	Configuration for enabling TLS encryption between the pipeline component and external services.
String	getTokenKey()	Name of the environment variable or secret that holds the bearer token (used when auth_strategy is bearer).
ObservabilityPipelinePrometheusRemoteWriteDestinationType	getType()	The destination type.
String	getUsernameKey()	Name of the environment variable or secret that holds the username (used when auth_strategy is basic).
int	hashCode()
ObservabilityPipelinePrometheusRemoteWriteDestination	id(String id)
ObservabilityPipelinePrometheusRemoteWriteDestination	inputs(List<String> inputs)
ObservabilityPipelinePrometheusRemoteWriteDestination	passwordKey(String passwordKey)
ObservabilityPipelinePrometheusRemoteWriteDestination	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setAuthStrategy(ObservabilityPipelinePrometheusRemoteWriteDestinationAuthStrategy authStrategy)
void	setBuffer(ObservabilityPipelineBufferOptions buffer)
void	setDefaultNamespace(String defaultNamespace)
void	setEndpointUrlKey(String endpointUrlKey)
void	setId(String id)
void	setInputs(List<String> inputs)
void	setPasswordKey(String passwordKey)
void	setTenantId(String tenantId)
void	setTls(ObservabilityPipelineClientTls tls)
void	setTokenKey(String tokenKey)
void	setType(ObservabilityPipelinePrometheusRemoteWriteDestinationType type)
void	setUsernameKey(String usernameKey)
ObservabilityPipelinePrometheusRemoteWriteDestination	tenantId(String tenantId)
ObservabilityPipelinePrometheusRemoteWriteDestination	tls(ObservabilityPipelineClientTls tls)
ObservabilityPipelinePrometheusRemoteWriteDestination	tokenKey(String tokenKey)
String	toString()
ObservabilityPipelinePrometheusRemoteWriteDestination	type(ObservabilityPipelinePrometheusRemoteWriteDestinationType type)
ObservabilityPipelinePrometheusRemoteWriteDestination	usernameKey(String usernameKey)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_AUTH_STRATEGY

public static final String JSON_PROPERTY_AUTH_STRATEGY

See Also:

• Constant Field Values

JSON_PROPERTY_BUFFER

public static final String JSON_PROPERTY_BUFFER

See Also:

• Constant Field Values

JSON_PROPERTY_DEFAULT_NAMESPACE

public static final String JSON_PROPERTY_DEFAULT_NAMESPACE

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_PASSWORD_KEY

public static final String JSON_PROPERTY_PASSWORD_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_TENANT_ID

public static final String JSON_PROPERTY_TENANT_ID

See Also:

• Constant Field Values

JSON_PROPERTY_TLS

public static final String JSON_PROPERTY_TLS

See Also:

• Constant Field Values

JSON_PROPERTY_TOKEN_KEY

public static final String JSON_PROPERTY_TOKEN_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_TYPE

public static final String JSON_PROPERTY_TYPE

See Also:

• Constant Field Values

JSON_PROPERTY_USERNAME_KEY

public static final String JSON_PROPERTY_USERNAME_KEY

See Also:

• Constant Field Values

Constructor Details

ObservabilityPipelinePrometheusRemoteWriteDestination

public ObservabilityPipelinePrometheusRemoteWriteDestination()

ObservabilityPipelinePrometheusRemoteWriteDestination

public ObservabilityPipelinePrometheusRemoteWriteDestination(String id,
 List<String> inputs,
 ObservabilityPipelinePrometheusRemoteWriteDestinationType type)

Method Details

authStrategy

public ObservabilityPipelinePrometheusRemoteWriteDestination authStrategy(ObservabilityPipelinePrometheusRemoteWriteDestinationAuthStrategy authStrategy)

getAuthStrategy

@Nullable
public ObservabilityPipelinePrometheusRemoteWriteDestinationAuthStrategy getAuthStrategy()

The authentication strategy to use for outgoing Prometheus Remote Write requests.

Returns:

authStrategy

setAuthStrategy

public void setAuthStrategy(ObservabilityPipelinePrometheusRemoteWriteDestinationAuthStrategy authStrategy)

buffer

public ObservabilityPipelinePrometheusRemoteWriteDestination buffer(ObservabilityPipelineBufferOptions buffer)

getBuffer

@Nullable
public ObservabilityPipelineBufferOptions getBuffer()

Configuration for buffer settings on destination components.

Returns:

buffer

setBuffer

public void setBuffer(ObservabilityPipelineBufferOptions buffer)

defaultNamespace

public ObservabilityPipelinePrometheusRemoteWriteDestination defaultNamespace(String defaultNamespace)

getDefaultNamespace

@Nullable
public String getDefaultNamespace()

The default namespace to add as a prefix to metric names that do not already have one.

Returns:

defaultNamespace

setDefaultNamespace

public void setDefaultNamespace(String defaultNamespace)

endpointUrlKey

public ObservabilityPipelinePrometheusRemoteWriteDestination endpointUrlKey(String endpointUrlKey)

getEndpointUrlKey

@Nullable
public String getEndpointUrlKey()

Name of the environment variable or secret that holds the Prometheus Remote Write endpoint URL. Defaults to DESTINATION_PROMETHEUS_REMOTE_WRITE_ENDPOINT_URL (prefixed with DD_OP_ at runtime).

Returns:

endpointUrlKey

setEndpointUrlKey

public void setEndpointUrlKey(String endpointUrlKey)

id

public ObservabilityPipelinePrometheusRemoteWriteDestination id(String id)

getId

public String getId()

The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the input to downstream components).

Returns:

id

setId

public void setId(String id)

inputs

public ObservabilityPipelinePrometheusRemoteWriteDestination inputs(List<String> inputs)

addInputsItem

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

passwordKey

public ObservabilityPipelinePrometheusRemoteWriteDestination passwordKey(String passwordKey)

getPasswordKey

@Nullable
public String getPasswordKey()

Name of the environment variable or secret that holds the password (used when auth_strategy is basic).

Returns:

passwordKey

setPasswordKey

public void setPasswordKey(String passwordKey)

tenantId

public ObservabilityPipelinePrometheusRemoteWriteDestination tenantId(String tenantId)

getTenantId

@Nullable
public String getTenantId()

The tenant ID to include with outgoing requests. Used by multi-tenant Prometheus Remote Write receivers.

Returns:

tenantId

setTenantId

public void setTenantId(String tenantId)

tls

public ObservabilityPipelinePrometheusRemoteWriteDestination tls(ObservabilityPipelineClientTls tls)

getTls

@Nullable
public ObservabilityPipelineClientTls getTls()

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

Returns:

tls

setTls

public void setTls(ObservabilityPipelineClientTls tls)

tokenKey

public ObservabilityPipelinePrometheusRemoteWriteDestination tokenKey(String tokenKey)

getTokenKey

@Nullable
public String getTokenKey()

Name of the environment variable or secret that holds the bearer token (used when auth_strategy is bearer).

Returns:

tokenKey

setTokenKey

public void setTokenKey(String tokenKey)

type

public ObservabilityPipelinePrometheusRemoteWriteDestination type(ObservabilityPipelinePrometheusRemoteWriteDestinationType type)

getType

public ObservabilityPipelinePrometheusRemoteWriteDestinationType getType()

The destination type. The value should always be prometheus_remote_write.

Returns:

type

setType

public void setType(ObservabilityPipelinePrometheusRemoteWriteDestinationType type)

usernameKey

public ObservabilityPipelinePrometheusRemoteWriteDestination usernameKey(String usernameKey)

getUsernameKey

@Nullable
public String getUsernameKey()

Name of the environment variable or secret that holds the username (used when auth_strategy is basic).

Returns:

usernameKey

setUsernameKey

public void setUsernameKey(String usernameKey)

putAdditionalProperty

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

ObservabilityPipelinePrometheusRemoteWriteDestination

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