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

Class ObservabilityPipelineHttpServerSource

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineHttpServerSource

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

The http_server source collects logs over HTTP POST from external services.

Supported pipeline types: logs

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_CUSTOM_KEY
static final String	JSON_PROPERTY_DECODING
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_PASSWORD_KEY
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
ObservabilityPipelineHttpServerSource()
ObservabilityPipelineHttpServerSource(ObservabilityPipelineHttpServerSourceAuthStrategy authStrategy, ObservabilityPipelineDecoding decoding, String id, ObservabilityPipelineHttpServerSourceType type)

Method Summary

Modifier and Type	Method	Description
ObservabilityPipelineHttpServerSource	addressKey(String addressKey)
ObservabilityPipelineHttpServerSource	addValidTokensItem(ObservabilityPipelineHttpServerSourceValidToken validTokensItem)
ObservabilityPipelineHttpServerSource	authStrategy(ObservabilityPipelineHttpServerSourceAuthStrategy authStrategy)
ObservabilityPipelineHttpServerSource	customKey(String customKey)
ObservabilityPipelineHttpServerSource	decoding(ObservabilityPipelineDecoding decoding)
boolean	equals(Object o)	Return true if this ObservabilityPipelineHttpServerSource 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 HTTP server.
ObservabilityPipelineHttpServerSourceAuthStrategy	getAuthStrategy()	HTTP authentication method.
String	getCustomKey()	Name of the environment variable or secret that holds a custom header value (used with custom auth strategies).
ObservabilityPipelineDecoding	getDecoding()	The decoding format used to interpret incoming logs.
String	getId()	Unique ID for the HTTP server source.
String	getPasswordKey()	Name of the environment variable or secret that holds the password (used when auth_strategy is plain).
ObservabilityPipelineMtlsServerTls	getTls()	Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
ObservabilityPipelineHttpServerSourceType	getType()	The source type.
String	getUsernameKey()	Name of the environment variable or secret that holds the username (used when auth_strategy is plain).
List<ObservabilityPipelineHttpServerSourceValidToken>	getValidTokens()	A list of tokens that are accepted for authenticating incoming HTTP requests.
int	hashCode()
ObservabilityPipelineHttpServerSource	id(String id)
ObservabilityPipelineHttpServerSource	passwordKey(String passwordKey)
ObservabilityPipelineHttpServerSource	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setAddressKey(String addressKey)
void	setAuthStrategy(ObservabilityPipelineHttpServerSourceAuthStrategy authStrategy)
void	setCustomKey(String customKey)
void	setDecoding(ObservabilityPipelineDecoding decoding)
void	setId(String id)
void	setPasswordKey(String passwordKey)
void	setTls(ObservabilityPipelineMtlsServerTls tls)
void	setType(ObservabilityPipelineHttpServerSourceType type)
void	setUsernameKey(String usernameKey)
void	setValidTokens(List<ObservabilityPipelineHttpServerSourceValidToken> validTokens)
ObservabilityPipelineHttpServerSource	tls(ObservabilityPipelineMtlsServerTls tls)
String	toString()
ObservabilityPipelineHttpServerSource	type(ObservabilityPipelineHttpServerSourceType type)
ObservabilityPipelineHttpServerSource	usernameKey(String usernameKey)
ObservabilityPipelineHttpServerSource	validTokens(List<ObservabilityPipelineHttpServerSourceValidToken> 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_CUSTOM_KEY

public static final String JSON_PROPERTY_CUSTOM_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_DECODING

public static final String JSON_PROPERTY_DECODING

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

ObservabilityPipelineHttpServerSource

public ObservabilityPipelineHttpServerSource()

ObservabilityPipelineHttpServerSource

public ObservabilityPipelineHttpServerSource(ObservabilityPipelineHttpServerSourceAuthStrategy authStrategy,
 ObservabilityPipelineDecoding decoding,
 String id,
 ObservabilityPipelineHttpServerSourceType type)

Method Details

addressKey

public ObservabilityPipelineHttpServerSource addressKey(String addressKey)

getAddressKey

@Nullable
public String getAddressKey()

Name of the environment variable or secret that holds the listen address for the HTTP server.

Returns:

addressKey

setAddressKey

public void setAddressKey(String addressKey)

authStrategy

public ObservabilityPipelineHttpServerSource authStrategy(ObservabilityPipelineHttpServerSourceAuthStrategy authStrategy)

getAuthStrategy

public ObservabilityPipelineHttpServerSourceAuthStrategy getAuthStrategy()

HTTP authentication method.

Returns:

authStrategy

setAuthStrategy

public void setAuthStrategy(ObservabilityPipelineHttpServerSourceAuthStrategy authStrategy)

customKey

public ObservabilityPipelineHttpServerSource customKey(String customKey)

getCustomKey

@Nullable
public String getCustomKey()

Name of the environment variable or secret that holds a custom header value (used with custom auth strategies).

Returns:

customKey

setCustomKey

public void setCustomKey(String customKey)

decoding

public ObservabilityPipelineHttpServerSource decoding(ObservabilityPipelineDecoding decoding)

getDecoding

public ObservabilityPipelineDecoding getDecoding()

The decoding format used to interpret incoming logs.

Returns:

decoding

setDecoding

public void setDecoding(ObservabilityPipelineDecoding decoding)

id

public ObservabilityPipelineHttpServerSource id(String id)

getId

public String getId()

Unique ID for the HTTP server source.

Returns:

id

setId

public void setId(String id)

passwordKey

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

tls

public ObservabilityPipelineHttpServerSource 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 ObservabilityPipelineHttpServerSource type(ObservabilityPipelineHttpServerSourceType type)

getType

public ObservabilityPipelineHttpServerSourceType getType()

The source type. The value should always be http_server.

Returns:

type

setType

public void setType(ObservabilityPipelineHttpServerSourceType type)

usernameKey

public ObservabilityPipelineHttpServerSource 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 ObservabilityPipelineHttpServerSource validTokens(List<ObservabilityPipelineHttpServerSourceValidToken> validTokens)

addValidTokensItem

public ObservabilityPipelineHttpServerSource addValidTokensItem(ObservabilityPipelineHttpServerSourceValidToken validTokensItem)

getValidTokens

@Nullable
public List<ObservabilityPipelineHttpServerSourceValidToken> getValidTokens()

A list of tokens that are accepted for authenticating incoming HTTP requests. When set, the source rejects any request whose token does not match an enabled entry in this list. Cannot be combined with the plain auth strategy.

Returns:

validTokens

setValidTokens

public void setValidTokens(List<ObservabilityPipelineHttpServerSourceValidToken> validTokens)

putAdditionalProperty

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

ObservabilityPipelineHttpServerSource

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