com.datadog.api.client.v2.model

Class ObservabilityPipelineSyslogNgSource

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineSyslogNgSource

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

The syslog_ng source listens for logs over TCP or UDP from a syslog-ng server using the syslog protocol.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field and Description
static String	JSON_PROPERTY_ADDRESS_KEY
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
ObservabilityPipelineSyslogNgSource()
ObservabilityPipelineSyslogNgSource(String id, ObservabilityPipelineSyslogSourceMode mode, ObservabilityPipelineSyslogNgSourceType type)

Method Summary

Modifier and Type	Method and Description
ObservabilityPipelineSyslogNgSource	addressKey(String addressKey)
boolean	equals(Object o) Return true if this ObservabilityPipelineSyslogNgSource 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.
String	getAddressKey() Name of the environment variable or secret that holds the listen address for the syslog-ng receiver.
String	getId() The unique identifier for this component.
ObservabilityPipelineSyslogSourceMode	getMode() Protocol used by the syslog source to receive messages.
ObservabilityPipelineMtlsServerTls	getTls() Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
ObservabilityPipelineSyslogNgSourceType	getType() The source type.
int	hashCode()
ObservabilityPipelineSyslogNgSource	id(String id)
ObservabilityPipelineSyslogNgSource	mode(ObservabilityPipelineSyslogSourceMode mode)
ObservabilityPipelineSyslogNgSource	putAdditionalProperty(String key, Object value) Set the additional (undeclared) property with the specified name and value.
void	setAddressKey(String addressKey)
void	setId(String id)
void	setMode(ObservabilityPipelineSyslogSourceMode mode)
void	setTls(ObservabilityPipelineMtlsServerTls tls)
void	setType(ObservabilityPipelineSyslogNgSourceType type)
ObservabilityPipelineSyslogNgSource	tls(ObservabilityPipelineMtlsServerTls tls)
String	toString()
ObservabilityPipelineSyslogNgSource	type(ObservabilityPipelineSyslogNgSourceType 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_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

ObservabilityPipelineSyslogNgSource

public ObservabilityPipelineSyslogNgSource()

ObservabilityPipelineSyslogNgSource

public ObservabilityPipelineSyslogNgSource(String id,
                                           ObservabilityPipelineSyslogSourceMode mode,
                                           ObservabilityPipelineSyslogNgSourceType type)

Method Detail

addressKey

public ObservabilityPipelineSyslogNgSource addressKey(String addressKey)

getAddressKey

@Nullable
public String getAddressKey()

Name of the environment variable or secret that holds the listen address for the syslog-ng receiver.

Returns:

addressKey

setAddressKey

public void setAddressKey(String addressKey)

id

public ObservabilityPipelineSyslogNgSource 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 ObservabilityPipelineSyslogNgSource mode(ObservabilityPipelineSyslogSourceMode mode)

getMode

public ObservabilityPipelineSyslogSourceMode getMode()

Protocol used by the syslog source to receive messages.

Returns:

mode

setMode

public void setMode(ObservabilityPipelineSyslogSourceMode mode)

tls

public ObservabilityPipelineSyslogNgSource 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 ObservabilityPipelineSyslogNgSource type(ObservabilityPipelineSyslogNgSourceType type)

getType

public ObservabilityPipelineSyslogNgSourceType getType()

The source type. The value should always be syslog_ng.

Returns:

type

setType

public void setType(ObservabilityPipelineSyslogNgSourceType type)

putAdditionalProperty

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

ObservabilityPipelineSyslogNgSource

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