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

Class ObservabilityPipelinePrometheusRemoteWriteSource

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelinePrometheusRemoteWriteSource

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

The prometheus_remote_write source ingests metrics pushed over the Prometheus Remote Write protocol.

Supported pipeline types: metrics

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ADDRESS_KEY
static final String	JSON_PROPERTY_AUTH_STRATEGY
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_PASSWORD_KEY
static final String	JSON_PROPERTY_PATH
static final String	JSON_PROPERTY_TLS
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_USERNAME_KEY
static final String	JSON_PROPERTY_VALID_TOKENS
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
ObservabilityPipelinePrometheusRemoteWriteSource()
ObservabilityPipelinePrometheusRemoteWriteSource(ObservabilityPipelinePrometheusRemoteWriteSourceAuthStrategy authStrategy, String id, String path, ObservabilityPipelinePrometheusRemoteWriteSourceType type)

Method Summary

Modifier and Type	Method	Description
ObservabilityPipelinePrometheusRemoteWriteSource	addressKey(String addressKey)
ObservabilityPipelinePrometheusRemoteWriteSource	addValidTokensItem(ObservabilityPipelinePrometheusRemoteWriteSourceValidToken validTokensItem)
ObservabilityPipelinePrometheusRemoteWriteSource	authStrategy(ObservabilityPipelinePrometheusRemoteWriteSourceAuthStrategy authStrategy)
boolean	equals(Object o)	Return true if this ObservabilityPipelinePrometheusRemoteWriteSource 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	getAddressKey()	Name of the environment variable or secret that holds the listen address for the Prometheus Remote Write endpoint.
ObservabilityPipelinePrometheusRemoteWriteSourceAuthStrategy	getAuthStrategy()	HTTP authentication method.
String	getId()	The unique identifier for this component.
String	getPasswordKey()	Name of the environment variable or secret that holds the password (used when auth_strategy is plain).
String	getPath()	The HTTP path on which the source listens for incoming Prometheus Remote Write requests.
ObservabilityPipelineMtlsServerTls	getTls()	Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
ObservabilityPipelinePrometheusRemoteWriteSourceType	getType()	The source type.
String	getUsernameKey()	Name of the environment variable or secret that holds the username (used when auth_strategy is plain).
List<ObservabilityPipelinePrometheusRemoteWriteSourceValidToken>	getValidTokens()	A list of tokens that are accepted for authenticating incoming requests.
int	hashCode()
ObservabilityPipelinePrometheusRemoteWriteSource	id(String id)
ObservabilityPipelinePrometheusRemoteWriteSource	passwordKey(String passwordKey)
ObservabilityPipelinePrometheusRemoteWriteSource	path(String path)
ObservabilityPipelinePrometheusRemoteWriteSource	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setAddressKey(String addressKey)
void	setAuthStrategy(ObservabilityPipelinePrometheusRemoteWriteSourceAuthStrategy authStrategy)
void	setId(String id)
void	setPasswordKey(String passwordKey)
void	setPath(String path)
void	setTls(ObservabilityPipelineMtlsServerTls tls)
void	setType(ObservabilityPipelinePrometheusRemoteWriteSourceType type)
void	setUsernameKey(String usernameKey)
void	setValidTokens(List<ObservabilityPipelinePrometheusRemoteWriteSourceValidToken> validTokens)
ObservabilityPipelinePrometheusRemoteWriteSource	tls(ObservabilityPipelineMtlsServerTls tls)
String	toString()
ObservabilityPipelinePrometheusRemoteWriteSource	type(ObservabilityPipelinePrometheusRemoteWriteSourceType type)
ObservabilityPipelinePrometheusRemoteWriteSource	usernameKey(String usernameKey)
ObservabilityPipelinePrometheusRemoteWriteSource	validTokens(List<ObservabilityPipelinePrometheusRemoteWriteSourceValidToken> validTokens)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_ADDRESS_KEY

public static final String JSON_PROPERTY_ADDRESS_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_AUTH_STRATEGY

public static final String JSON_PROPERTY_AUTH_STRATEGY

See Also:

• Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

• Constant Field Values

JSON_PROPERTY_PASSWORD_KEY

public static final String JSON_PROPERTY_PASSWORD_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_PATH

public static final String JSON_PROPERTY_PATH

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

JSON_PROPERTY_USERNAME_KEY

public static final String JSON_PROPERTY_USERNAME_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_VALID_TOKENS

public static final String JSON_PROPERTY_VALID_TOKENS

See Also:

• Constant Field Values

Constructor Details

ObservabilityPipelinePrometheusRemoteWriteSource

public ObservabilityPipelinePrometheusRemoteWriteSource()

ObservabilityPipelinePrometheusRemoteWriteSource

public ObservabilityPipelinePrometheusRemoteWriteSource(ObservabilityPipelinePrometheusRemoteWriteSourceAuthStrategy authStrategy,
 String id,
 String path,
 ObservabilityPipelinePrometheusRemoteWriteSourceType type)

Method Details

addressKey

public ObservabilityPipelinePrometheusRemoteWriteSource addressKey(String addressKey)

getAddressKey

@Nullable
public String getAddressKey()

Name of the environment variable or secret that holds the listen address for the Prometheus Remote Write endpoint.

Returns:

addressKey

setAddressKey

public void setAddressKey(String addressKey)

authStrategy

public ObservabilityPipelinePrometheusRemoteWriteSource authStrategy(ObservabilityPipelinePrometheusRemoteWriteSourceAuthStrategy authStrategy)

getAuthStrategy

public ObservabilityPipelinePrometheusRemoteWriteSourceAuthStrategy getAuthStrategy()

HTTP authentication method.

Returns:

authStrategy

setAuthStrategy

public void setAuthStrategy(ObservabilityPipelinePrometheusRemoteWriteSourceAuthStrategy authStrategy)

id

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

passwordKey

public ObservabilityPipelinePrometheusRemoteWriteSource passwordKey(String passwordKey)

getPasswordKey

@Nullable
public String getPasswordKey()

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

Returns:

passwordKey

setPasswordKey

public void setPasswordKey(String passwordKey)

path

public ObservabilityPipelinePrometheusRemoteWriteSource path(String path)

getPath

public String getPath()

The HTTP path on which the source listens for incoming Prometheus Remote Write requests.

Returns:

path

setPath

public void setPath(String path)

tls

public ObservabilityPipelinePrometheusRemoteWriteSource tls(ObservabilityPipelineMtlsServerTls tls)

getTls

@Nullable
public ObservabilityPipelineMtlsServerTls getTls()

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

Returns:

tls

setTls

public void setTls(ObservabilityPipelineMtlsServerTls tls)

type

public ObservabilityPipelinePrometheusRemoteWriteSource type(ObservabilityPipelinePrometheusRemoteWriteSourceType type)

getType

public ObservabilityPipelinePrometheusRemoteWriteSourceType getType()

The source type. The value should always be prometheus_remote_write.

Returns:

type

setType

public void setType(ObservabilityPipelinePrometheusRemoteWriteSourceType type)

usernameKey

public ObservabilityPipelinePrometheusRemoteWriteSource usernameKey(String usernameKey)

getUsernameKey

@Nullable
public String getUsernameKey()

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

Returns:

usernameKey

setUsernameKey

public void setUsernameKey(String usernameKey)

validTokens

public ObservabilityPipelinePrometheusRemoteWriteSource validTokens(List<ObservabilityPipelinePrometheusRemoteWriteSourceValidToken> validTokens)

addValidTokensItem

public ObservabilityPipelinePrometheusRemoteWriteSource addValidTokensItem(ObservabilityPipelinePrometheusRemoteWriteSourceValidToken validTokensItem)

getValidTokens

@Nullable
public List<ObservabilityPipelinePrometheusRemoteWriteSourceValidToken> getValidTokens()

A list of tokens that are accepted for authenticating incoming requests. When set, the source rejects any request whose token does not match an enabled entry in this list.

Returns:

validTokens

setValidTokens

public void setValidTokens(List<ObservabilityPipelinePrometheusRemoteWriteSourceValidToken> validTokens)

putAdditionalProperty

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

ObservabilityPipelinePrometheusRemoteWriteSource

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