com.datadog.api.client.v2.model

Class ObservabilityPipelineSocketSource

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineSocketSource

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

The socket source ingests logs over TCP or UDP.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ADDRESS_KEY
static String	JSON_PROPERTY_FRAMING
static String	JSON_PROPERTY_ID
static String	JSON_PROPERTY_MODE
static String	JSON_PROPERTY_TLS
static String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor and Description
ObservabilityPipelineSocketSource()
ObservabilityPipelineSocketSource(ObservabilityPipelineSocketSourceFraming framing, String id, ObservabilityPipelineSocketSourceMode mode, ObservabilityPipelineSocketSourceType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineSocketSource	addressKey(String addressKey)
boolean	equals(Object o) Return true if this ObservabilityPipelineSocketSource object is equal to o.
ObservabilityPipelineSocketSource	framing(ObservabilityPipelineSocketSourceFraming 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 listen address for the socket.
ObservabilityPipelineSocketSourceFraming	getFraming() Framing method configuration for the socket source.
String	getId() The unique identifier for this component.
ObservabilityPipelineSocketSourceMode	getMode() Protocol used to receive logs.
ObservabilityPipelineMtlsServerTls	getTls() Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
ObservabilityPipelineSocketSourceType	getType() The source type.
int	hashCode()
ObservabilityPipelineSocketSource	id(String id)
ObservabilityPipelineSocketSource	mode(ObservabilityPipelineSocketSourceMode mode)
ObservabilityPipelineSocketSource	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setAddressKey(String addressKey)
void	setFraming(ObservabilityPipelineSocketSourceFraming framing)
void	setId(String id)
void	setMode(ObservabilityPipelineSocketSourceMode mode)
void	setTls(ObservabilityPipelineMtlsServerTls tls)
void	setType(ObservabilityPipelineSocketSourceType type)
ObservabilityPipelineSocketSource	tls(ObservabilityPipelineMtlsServerTls tls)
String	toString()
ObservabilityPipelineSocketSource	type(ObservabilityPipelineSocketSourceType type)

Methods inherited from class java.lang.Object

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

Field Detail

unparsed

public boolean unparsed

JSON_PROPERTY_ADDRESS_KEY

public static final String JSON_PROPERTY_ADDRESS_KEY

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

ObservabilityPipelineSocketSource

public ObservabilityPipelineSocketSource()

ObservabilityPipelineSocketSource

public ObservabilityPipelineSocketSource(ObservabilityPipelineSocketSourceFraming framing,
                                         String id,
                                         ObservabilityPipelineSocketSourceMode mode,
                                         ObservabilityPipelineSocketSourceType type)

Method Detail

addressKey

public ObservabilityPipelineSocketSource addressKey(String addressKey)

getAddressKey

@Nullable
public String getAddressKey()

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

Returns:

addressKey

setAddressKey

public void setAddressKey(String addressKey)

framing

public ObservabilityPipelineSocketSource framing(ObservabilityPipelineSocketSourceFraming framing)

getFraming

public ObservabilityPipelineSocketSourceFraming getFraming()

Framing method configuration for the socket source.

Returns:

framing

setFraming

public void setFraming(ObservabilityPipelineSocketSourceFraming framing)

id

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

mode

public ObservabilityPipelineSocketSource mode(ObservabilityPipelineSocketSourceMode mode)

getMode

public ObservabilityPipelineSocketSourceMode getMode()

Protocol used to receive logs.

Returns:

mode

setMode

public void setMode(ObservabilityPipelineSocketSourceMode mode)

tls

public ObservabilityPipelineSocketSource 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 ObservabilityPipelineSocketSource type(ObservabilityPipelineSocketSourceType type)

getType

public ObservabilityPipelineSocketSourceType getType()

The source type. The value should always be socket.

Returns:

type

setType

public void setType(ObservabilityPipelineSocketSourceType type)

putAdditionalProperty

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

ObservabilityPipelineSocketSource

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