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

Class ObservabilityPipelineWebsocketSource

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineWebsocketSource

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

The websocket source ingests logs from a WebSocket server using the ws:// or wss:// protocol.

Supported pipeline types: logs.

Field Summary

Fields

Modifier and Type	Field	Description
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_TOKEN_KEY
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_URI_KEY
static final String	JSON_PROPERTY_USERNAME_KEY
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
ObservabilityPipelineWebsocketSource()
ObservabilityPipelineWebsocketSource(ObservabilityPipelineWebsocketSourceAuthStrategy authStrategy, ObservabilityPipelineDecoding decoding, String id, ObservabilityPipelineWebsocketSourceType type)

Method Summary

Modifier and Type	Method	Description
ObservabilityPipelineWebsocketSource	authStrategy(ObservabilityPipelineWebsocketSourceAuthStrategy authStrategy)
ObservabilityPipelineWebsocketSource	customKey(String customKey)
ObservabilityPipelineWebsocketSource	decoding(ObservabilityPipelineDecoding decoding)
boolean	equals(Object o)	Return true if this ObservabilityPipelineWebsocketSource 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.
ObservabilityPipelineWebsocketSourceAuthStrategy	getAuthStrategy()	Authentication strategy for the WebSocket source connection.
String	getCustomKey()	Name of the environment variable or secret that holds the custom authorization header value.
ObservabilityPipelineDecoding	getDecoding()	The decoding format used to interpret incoming logs.
String	getId()	The unique identifier for this component.
String	getPasswordKey()	Name of the environment variable or secret that holds the password.
ObservabilityPipelineWebsocketSourceTls	getTls()	TLS configuration for the WebSocket source.
String	getTokenKey()	Name of the environment variable or secret that holds the bearer token.
ObservabilityPipelineWebsocketSourceType	getType()	The source type.
String	getUriKey()	Name of the environment variable or secret that holds the WebSocket server URI (ws:// or wss://).
String	getUsernameKey()	Name of the environment variable or secret that holds the username.
int	hashCode()
ObservabilityPipelineWebsocketSource	id(String id)
ObservabilityPipelineWebsocketSource	passwordKey(String passwordKey)
ObservabilityPipelineWebsocketSource	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setAuthStrategy(ObservabilityPipelineWebsocketSourceAuthStrategy authStrategy)
void	setCustomKey(String customKey)
void	setDecoding(ObservabilityPipelineDecoding decoding)
void	setId(String id)
void	setPasswordKey(String passwordKey)
void	setTls(ObservabilityPipelineWebsocketSourceTls tls)
void	setTokenKey(String tokenKey)
void	setType(ObservabilityPipelineWebsocketSourceType type)
void	setUriKey(String uriKey)
void	setUsernameKey(String usernameKey)
ObservabilityPipelineWebsocketSource	tls(ObservabilityPipelineWebsocketSourceTls tls)
ObservabilityPipelineWebsocketSource	tokenKey(String tokenKey)
String	toString()
ObservabilityPipelineWebsocketSource	type(ObservabilityPipelineWebsocketSourceType type)
ObservabilityPipelineWebsocketSource	uriKey(String uriKey)
ObservabilityPipelineWebsocketSource	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_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_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_URI_KEY

public static final String JSON_PROPERTY_URI_KEY

See Also:

• Constant Field Values

JSON_PROPERTY_USERNAME_KEY

public static final String JSON_PROPERTY_USERNAME_KEY

See Also:

• Constant Field Values

Constructor Details

ObservabilityPipelineWebsocketSource

public ObservabilityPipelineWebsocketSource()

ObservabilityPipelineWebsocketSource

public ObservabilityPipelineWebsocketSource(ObservabilityPipelineWebsocketSourceAuthStrategy authStrategy,
 ObservabilityPipelineDecoding decoding,
 String id,
 ObservabilityPipelineWebsocketSourceType type)

Method Details

authStrategy

public ObservabilityPipelineWebsocketSource authStrategy(ObservabilityPipelineWebsocketSourceAuthStrategy authStrategy)

getAuthStrategy

public ObservabilityPipelineWebsocketSourceAuthStrategy getAuthStrategy()

Authentication strategy for the WebSocket source connection.

Returns:

authStrategy

setAuthStrategy

public void setAuthStrategy(ObservabilityPipelineWebsocketSourceAuthStrategy authStrategy)

customKey

public ObservabilityPipelineWebsocketSource customKey(String customKey)

getCustomKey

@Nullable
public String getCustomKey()

Name of the environment variable or secret that holds the custom authorization header value. Used when auth_strategy is custom.

Returns:

customKey

setCustomKey

public void setCustomKey(String customKey)

decoding

public ObservabilityPipelineWebsocketSource 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 ObservabilityPipelineWebsocketSource id(String id)

getId

public String getId()

The unique identifier for this component.

Returns:

id

setId

public void setId(String id)

passwordKey

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

tls

public ObservabilityPipelineWebsocketSource tls(ObservabilityPipelineWebsocketSourceTls tls)

getTls

@Nullable
public ObservabilityPipelineWebsocketSourceTls getTls()

TLS configuration for the WebSocket source. Use enabled for standard wss:// connections, or with_client_cert to present a client certificate for mutual TLS.

Returns:

tls

setTls

public void setTls(ObservabilityPipelineWebsocketSourceTls tls)

tokenKey

public ObservabilityPipelineWebsocketSource 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 ObservabilityPipelineWebsocketSource type(ObservabilityPipelineWebsocketSourceType type)

getType

public ObservabilityPipelineWebsocketSourceType getType()

The source type. The value should always be websocket.

Returns:

type

setType

public void setType(ObservabilityPipelineWebsocketSourceType type)

uriKey

public ObservabilityPipelineWebsocketSource uriKey(String uriKey)

getUriKey

@Nullable
public String getUriKey()

Name of the environment variable or secret that holds the WebSocket server URI (ws:// or wss://).

Returns:

uriKey

setUriKey

public void setUriKey(String uriKey)

usernameKey

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

ObservabilityPipelineWebsocketSource

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