com.datadog.api.client.v2.model

Class ObservabilityPipelineHttpClientSource

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineHttpClientSource

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

The http_client source scrapes logs from HTTP endpoints at regular intervals.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_AUTH_STRATEGY
static String	JSON_PROPERTY_CUSTOM_KEY
static String	JSON_PROPERTY_DECODING
static String	JSON_PROPERTY_ENDPOINT_URL_KEY
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_PASSWORD_KEY
static String	JSON_PROPERTY_SCRAPE_INTERVAL_SECS
static String	JSON_PROPERTY_SCRAPE_TIMEOUT_SECS
static String	JSON_PROPERTY_TLS
static String	JSON_PROPERTY_TOKEN_KEY
static String	JSON_PROPERTY_TYPE
static String	JSON_PROPERTY_USERNAME_KEY
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineHttpClientSource()
ObservabilityPipelineHttpClientSource(ObservabilityPipelineDecoding decoding, String id, ObservabilityPipelineHttpClientSourceType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineHttpClientSource	authStrategy(ObservabilityPipelineHttpClientSourceAuthStrategy authStrategy)
ObservabilityPipelineHttpClientSource	customKey(String customKey)
ObservabilityPipelineHttpClientSource	decoding(ObservabilityPipelineDecoding decoding)
ObservabilityPipelineHttpClientSource	endpointUrlKey(String endpointUrlKey)
boolean	equals(Object o) Return true if this ObservabilityPipelineHttpClientSource 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.
ObservabilityPipelineHttpClientSourceAuthStrategy	getAuthStrategy() Optional authentication strategy for HTTP requests.
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	getEndpointUrlKey() Name of the environment variable or secret that holds the HTTP endpoint URL to scrape.
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 basic).
Long	getScrapeIntervalSecs() The interval (in seconds) between HTTP scrape requests.
Long	getScrapeTimeoutSecs() The timeout (in seconds) for each scrape request.
ObservabilityPipelineTls	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).
ObservabilityPipelineHttpClientSourceType	getType() The source type.
String	getUsernameKey() Name of the environment variable or secret that holds the username (used when auth_strategy is basic).
int	hashCode()
ObservabilityPipelineHttpClientSource	id(String id)
ObservabilityPipelineHttpClientSource	passwordKey(String passwordKey)
ObservabilityPipelineHttpClientSource	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
ObservabilityPipelineHttpClientSource	scrapeIntervalSecs(Long scrapeIntervalSecs)
ObservabilityPipelineHttpClientSource	scrapeTimeoutSecs(Long scrapeTimeoutSecs)
void	setAuthStrategy(ObservabilityPipelineHttpClientSourceAuthStrategy authStrategy)
void	setCustomKey(String customKey)
void	setDecoding(ObservabilityPipelineDecoding decoding)
void	setEndpointUrlKey(String endpointUrlKey)
void	setId(String id)
void	setPasswordKey(String passwordKey)
void	setScrapeIntervalSecs(Long scrapeIntervalSecs)
void	setScrapeTimeoutSecs(Long scrapeTimeoutSecs)
void	setTls(ObservabilityPipelineTls tls)
void	setTokenKey(String tokenKey)
void	setType(ObservabilityPipelineHttpClientSourceType type)
void	setUsernameKey(String usernameKey)
ObservabilityPipelineHttpClientSource	tls(ObservabilityPipelineTls tls)
ObservabilityPipelineHttpClientSource	tokenKey(String tokenKey)
String	toString()
ObservabilityPipelineHttpClientSource	type(ObservabilityPipelineHttpClientSourceType type)
ObservabilityPipelineHttpClientSource	usernameKey(String usernameKey)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

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

public static final String JSON_PROPERTY_PASSWORD_KEY

See Also:

Constant Field Values

JSON_PROPERTY_SCRAPE_INTERVAL_SECS

public static final String JSON_PROPERTY_SCRAPE_INTERVAL_SECS

See Also:

Constant Field Values

JSON_PROPERTY_SCRAPE_TIMEOUT_SECS

public static final String JSON_PROPERTY_SCRAPE_TIMEOUT_SECS

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 Detail

ObservabilityPipelineHttpClientSource

public ObservabilityPipelineHttpClientSource()

ObservabilityPipelineHttpClientSource

public ObservabilityPipelineHttpClientSource(ObservabilityPipelineDecoding decoding,
                                             String id,
                                             ObservabilityPipelineHttpClientSourceType type)

Method Detail

authStrategy

public ObservabilityPipelineHttpClientSource authStrategy(ObservabilityPipelineHttpClientSourceAuthStrategy authStrategy)

getAuthStrategy

@Nullable
public ObservabilityPipelineHttpClientSourceAuthStrategy getAuthStrategy()

Optional authentication strategy for HTTP requests.

Returns:

authStrategy

setAuthStrategy

public void setAuthStrategy(ObservabilityPipelineHttpClientSourceAuthStrategy authStrategy)

customKey

public ObservabilityPipelineHttpClientSource 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 ObservabilityPipelineHttpClientSource decoding(ObservabilityPipelineDecoding decoding)

getDecoding

public ObservabilityPipelineDecoding getDecoding()

The decoding format used to interpret incoming logs.

Returns:

decoding

setDecoding

public void setDecoding(ObservabilityPipelineDecoding decoding)

endpointUrlKey

public ObservabilityPipelineHttpClientSource endpointUrlKey(String endpointUrlKey)

getEndpointUrlKey

@Nullable
public String getEndpointUrlKey()

Name of the environment variable or secret that holds the HTTP endpoint URL to scrape.

Returns:

endpointUrlKey

setEndpointUrlKey

public void setEndpointUrlKey(String endpointUrlKey)

id

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

scrapeIntervalSecs

public ObservabilityPipelineHttpClientSource scrapeIntervalSecs(Long scrapeIntervalSecs)

getScrapeIntervalSecs

@Nullable
public Long getScrapeIntervalSecs()

The interval (in seconds) between HTTP scrape requests.

Returns:

scrapeIntervalSecs

setScrapeIntervalSecs

public void setScrapeIntervalSecs(Long scrapeIntervalSecs)

scrapeTimeoutSecs

public ObservabilityPipelineHttpClientSource scrapeTimeoutSecs(Long scrapeTimeoutSecs)

getScrapeTimeoutSecs

@Nullable
public Long getScrapeTimeoutSecs()

The timeout (in seconds) for each scrape request.

Returns:

scrapeTimeoutSecs

setScrapeTimeoutSecs

public void setScrapeTimeoutSecs(Long scrapeTimeoutSecs)

tls

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

tokenKey

public ObservabilityPipelineHttpClientSource 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 ObservabilityPipelineHttpClientSource type(ObservabilityPipelineHttpClientSourceType type)

getType

public ObservabilityPipelineHttpClientSourceType getType()

The source type. The value should always be http_client.

Returns:

type

setType

public void setType(ObservabilityPipelineHttpClientSourceType type)

usernameKey

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

ObservabilityPipelineHttpClientSource

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