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

Class ObservabilityPipelineHttpServerSourceValidToken

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineHttpServerSourceValidToken

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

An accepted token used to authenticate incoming HTTP server requests.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ENABLED
static final String	JSON_PROPERTY_FIELD_TO_ADD
static final String	JSON_PROPERTY_PATH_TO_TOKEN
static final String	JSON_PROPERTY_TOKEN_KEY
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
ObservabilityPipelineHttpServerSourceValidToken()
ObservabilityPipelineHttpServerSourceValidToken(String tokenKey)

Method Summary

Modifier and Type	Method	Description
ObservabilityPipelineHttpServerSourceValidToken	enabled(Boolean enabled)
boolean	equals(Object o)	Return true if this ObservabilityPipelineHttpServerSourceValidToken object is equal to o.
ObservabilityPipelineHttpServerSourceValidToken	fieldToAdd(ObservabilityPipelineSourceValidTokenFieldToAdd fieldToAdd)
Map<String,Object>	getAdditionalProperties()	Return the additional (undeclared) property.
Object	getAdditionalProperty(String key)	Return the additional (undeclared) property with the specified name.
Boolean	getEnabled()	Indicates whether this token is currently accepted.
ObservabilityPipelineSourceValidTokenFieldToAdd	getFieldToAdd()	An optional metadata field that is attached to every event authenticated by the associated token.
ObservabilityPipelineHttpServerSourceValidTokenPathToToken	getPathToToken()	Specifies where the worker extracts the token from in the incoming HTTP request.
String	getTokenKey()	Name of the environment variable or secret that holds the expected token value.
int	hashCode()
ObservabilityPipelineHttpServerSourceValidToken	pathToToken(ObservabilityPipelineHttpServerSourceValidTokenPathToToken pathToToken)
ObservabilityPipelineHttpServerSourceValidToken	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setEnabled(Boolean enabled)
void	setFieldToAdd(ObservabilityPipelineSourceValidTokenFieldToAdd fieldToAdd)
void	setPathToToken(ObservabilityPipelineHttpServerSourceValidTokenPathToToken pathToToken)
void	setTokenKey(String tokenKey)
ObservabilityPipelineHttpServerSourceValidToken	tokenKey(String tokenKey)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_ENABLED

public static final String JSON_PROPERTY_ENABLED

See Also:

• Constant Field Values

JSON_PROPERTY_FIELD_TO_ADD

public static final String JSON_PROPERTY_FIELD_TO_ADD

See Also:

• Constant Field Values

JSON_PROPERTY_PATH_TO_TOKEN

public static final String JSON_PROPERTY_PATH_TO_TOKEN

See Also:

• Constant Field Values

JSON_PROPERTY_TOKEN_KEY

public static final String JSON_PROPERTY_TOKEN_KEY

See Also:

• Constant Field Values

Constructor Details

ObservabilityPipelineHttpServerSourceValidToken

public ObservabilityPipelineHttpServerSourceValidToken()

ObservabilityPipelineHttpServerSourceValidToken

public ObservabilityPipelineHttpServerSourceValidToken(String tokenKey)

Method Details

enabled

public ObservabilityPipelineHttpServerSourceValidToken enabled(Boolean enabled)

getEnabled

@Nullable
public Boolean getEnabled()

Indicates whether this token is currently accepted. Disabled tokens are rejected without being removed from the configuration.

Returns:

enabled

setEnabled

public void setEnabled(Boolean enabled)

fieldToAdd

public ObservabilityPipelineHttpServerSourceValidToken fieldToAdd(ObservabilityPipelineSourceValidTokenFieldToAdd fieldToAdd)

getFieldToAdd

@Nullable
public ObservabilityPipelineSourceValidTokenFieldToAdd getFieldToAdd()

An optional metadata field that is attached to every event authenticated by the associated token. Both key and value must match ^[A-Za-z0-9_]+$.

Returns:

fieldToAdd

setFieldToAdd

public void setFieldToAdd(ObservabilityPipelineSourceValidTokenFieldToAdd fieldToAdd)

pathToToken

public ObservabilityPipelineHttpServerSourceValidToken pathToToken(ObservabilityPipelineHttpServerSourceValidTokenPathToToken pathToToken)

getPathToToken

@Nullable
public ObservabilityPipelineHttpServerSourceValidTokenPathToToken getPathToToken()

Specifies where the worker extracts the token from in the incoming HTTP request. This can be either a built-in location (path or address) or an HTTP header object.

Returns:

pathToToken

setPathToToken

public void setPathToToken(ObservabilityPipelineHttpServerSourceValidTokenPathToToken pathToToken)

tokenKey

public ObservabilityPipelineHttpServerSourceValidToken tokenKey(String tokenKey)

getTokenKey

public String getTokenKey()

Name of the environment variable or secret that holds the expected token value.

Returns:

tokenKey

setTokenKey

public void setTokenKey(String tokenKey)

putAdditionalProperty

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

ObservabilityPipelineHttpServerSourceValidToken

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