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

Class ObservabilityPipelineSocketDestination

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineSocketDestination

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

The socket destination sends logs over TCP or UDP to a remote server.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ADDRESS_KEY
static final String	JSON_PROPERTY_BUFFER
static final String	JSON_PROPERTY_ENCODING
static final String	JSON_PROPERTY_FRAMING
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_INPUTS
static final String	JSON_PROPERTY_MODE
static final String	JSON_PROPERTY_TLS
static final String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
ObservabilityPipelineSocketDestination()
ObservabilityPipelineSocketDestination(ObservabilityPipelineSocketDestinationEncoding encoding, ObservabilityPipelineSocketDestinationFraming framing, String id, List<String> inputs, ObservabilityPipelineSocketDestinationMode mode, ObservabilityPipelineSocketDestinationType type)

Method Summary

Modifier and Type	Method	Description
ObservabilityPipelineSocketDestination	addInputsItem(String inputsItem)
ObservabilityPipelineSocketDestination	addressKey(String addressKey)
ObservabilityPipelineSocketDestination	buffer(ObservabilityPipelineBufferOptions buffer)
ObservabilityPipelineSocketDestination	encoding(ObservabilityPipelineSocketDestinationEncoding encoding)
boolean	equals(Object o)	Return true if this ObservabilityPipelineSocketDestination object is equal to o.
ObservabilityPipelineSocketDestination	framing(ObservabilityPipelineSocketDestinationFraming framing)
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 socket address (host:port).
ObservabilityPipelineBufferOptions	getBuffer()	Configuration for buffer settings on destination components.
ObservabilityPipelineSocketDestinationEncoding	getEncoding()	Encoding format for log events.
ObservabilityPipelineSocketDestinationFraming	getFraming()	Framing method configuration.
String	getId()	The unique identifier for this component.
List<String>	getInputs()	A list of component IDs whose output is used as the input for this component.
ObservabilityPipelineSocketDestinationMode	getMode()	Protocol used to send logs.
ObservabilityPipelineClientTls	getTls()	Configuration for enabling TLS encryption between the pipeline component and external services.
ObservabilityPipelineSocketDestinationType	getType()	The destination type.
int	hashCode()
ObservabilityPipelineSocketDestination	id(String id)
ObservabilityPipelineSocketDestination	inputs(List<String> inputs)
ObservabilityPipelineSocketDestination	mode(ObservabilityPipelineSocketDestinationMode mode)
ObservabilityPipelineSocketDestination	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
void	setAddressKey(String addressKey)
void	setBuffer(ObservabilityPipelineBufferOptions buffer)
void	setEncoding(ObservabilityPipelineSocketDestinationEncoding encoding)
void	setFraming(ObservabilityPipelineSocketDestinationFraming framing)
void	setId(String id)
void	setInputs(List<String> inputs)
void	setMode(ObservabilityPipelineSocketDestinationMode mode)
void	setTls(ObservabilityPipelineClientTls tls)
void	setType(ObservabilityPipelineSocketDestinationType type)
ObservabilityPipelineSocketDestination	tls(ObservabilityPipelineClientTls tls)
String	toString()
ObservabilityPipelineSocketDestination	type(ObservabilityPipelineSocketDestinationType type)

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_BUFFER

public static final String JSON_PROPERTY_BUFFER

See Also:

• Constant Field Values

JSON_PROPERTY_ENCODING

public static final String JSON_PROPERTY_ENCODING

See Also:

• Constant Field Values

JSON_PROPERTY_FRAMING

public static final String JSON_PROPERTY_FRAMING

See Also:

• Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

• Constant Field Values

JSON_PROPERTY_INPUTS

public static final String JSON_PROPERTY_INPUTS

See Also:

• Constant Field Values

JSON_PROPERTY_MODE

public static final String JSON_PROPERTY_MODE

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

Constructor Details

ObservabilityPipelineSocketDestination

public ObservabilityPipelineSocketDestination()

ObservabilityPipelineSocketDestination

public ObservabilityPipelineSocketDestination(ObservabilityPipelineSocketDestinationEncoding encoding,
 ObservabilityPipelineSocketDestinationFraming framing,
 String id,
 List<String> inputs,
 ObservabilityPipelineSocketDestinationMode mode,
 ObservabilityPipelineSocketDestinationType type)

Method Details

addressKey

public ObservabilityPipelineSocketDestination addressKey(String addressKey)

getAddressKey

@Nullable
public String getAddressKey()

Name of the environment variable or secret that holds the socket address (host:port).

Returns:

addressKey

setAddressKey

public void setAddressKey(String addressKey)

buffer

public ObservabilityPipelineSocketDestination buffer(ObservabilityPipelineBufferOptions buffer)

getBuffer

@Nullable
public ObservabilityPipelineBufferOptions getBuffer()

Configuration for buffer settings on destination components.

Returns:

buffer

setBuffer

public void setBuffer(ObservabilityPipelineBufferOptions buffer)

encoding

public ObservabilityPipelineSocketDestination encoding(ObservabilityPipelineSocketDestinationEncoding encoding)

getEncoding

public ObservabilityPipelineSocketDestinationEncoding getEncoding()

Encoding format for log events.

Returns:

encoding

setEncoding

public void setEncoding(ObservabilityPipelineSocketDestinationEncoding encoding)

framing

public ObservabilityPipelineSocketDestination framing(ObservabilityPipelineSocketDestinationFraming framing)

getFraming

public ObservabilityPipelineSocketDestinationFraming getFraming()

Framing method configuration.

Returns:

framing

setFraming

public void setFraming(ObservabilityPipelineSocketDestinationFraming framing)

id

public ObservabilityPipelineSocketDestination id(String id)

getId

public String getId()

The unique identifier for this component.

Returns:

id

setId

public void setId(String id)

inputs

public ObservabilityPipelineSocketDestination inputs(List<String> inputs)

addInputsItem

public ObservabilityPipelineSocketDestination addInputsItem(String inputsItem)

getInputs

public List<String> getInputs()

A list of component IDs whose output is used as the input for this component.

Returns:

inputs

setInputs

public void setInputs(List<String> inputs)

mode

public ObservabilityPipelineSocketDestination mode(ObservabilityPipelineSocketDestinationMode mode)

getMode

public ObservabilityPipelineSocketDestinationMode getMode()

Protocol used to send logs.

Returns:

mode

setMode

public void setMode(ObservabilityPipelineSocketDestinationMode mode)

tls

public ObservabilityPipelineSocketDestination tls(ObservabilityPipelineClientTls tls)

getTls

@Nullable
public ObservabilityPipelineClientTls getTls()

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

Returns:

tls

setTls

public void setTls(ObservabilityPipelineClientTls tls)

type

public ObservabilityPipelineSocketDestination type(ObservabilityPipelineSocketDestinationType type)

getType

public ObservabilityPipelineSocketDestinationType getType()

The destination type. The value should always be socket.

Returns:

type

setType

public void setType(ObservabilityPipelineSocketDestinationType type)

putAdditionalProperty

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

ObservabilityPipelineSocketDestination

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