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

Class ObservabilityPipelineAmazonS3Source

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineAmazonS3Source

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

The amazon_s3 source ingests logs from an Amazon S3 bucket. It supports AWS authentication, TLS encryption, and configurable compression.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_AUTH
static final String	JSON_PROPERTY_COMPRESSION
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_REGION
static final String	JSON_PROPERTY_TLS
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_URL_KEY
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
ObservabilityPipelineAmazonS3Source()
ObservabilityPipelineAmazonS3Source(String id, String region, ObservabilityPipelineAmazonS3SourceType type)

Method Summary

Modifier and Type	Method	Description
ObservabilityPipelineAmazonS3Source	auth(ObservabilityPipelineAwsAuth auth)
ObservabilityPipelineAmazonS3Source	compression(ObservabilityPipelineAmazonS3SourceCompression compression)
boolean	equals(Object o)	Return true if this ObservabilityPipelineAmazonS3Source 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.
ObservabilityPipelineAwsAuth	getAuth()	AWS authentication credentials used for accessing AWS services such as S3.
ObservabilityPipelineAmazonS3SourceCompression	getCompression()	Compression format for objects retrieved from the S3 bucket.
String	getId()	The unique identifier for this component.
String	getRegion()	AWS region where the S3 bucket resides.
ObservabilityPipelineTls	getTls()	Configuration for enabling TLS encryption between the pipeline component and external services.
ObservabilityPipelineAmazonS3SourceType	getType()	The source type.
String	getUrlKey()	Name of the environment variable or secret that holds the S3 bucket URL.
int	hashCode()
ObservabilityPipelineAmazonS3Source	id(String id)
ObservabilityPipelineAmazonS3Source	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
ObservabilityPipelineAmazonS3Source	region(String region)
void	setAuth(ObservabilityPipelineAwsAuth auth)
void	setCompression(ObservabilityPipelineAmazonS3SourceCompression compression)
void	setId(String id)
void	setRegion(String region)
void	setTls(ObservabilityPipelineTls tls)
void	setType(ObservabilityPipelineAmazonS3SourceType type)
void	setUrlKey(String urlKey)
ObservabilityPipelineAmazonS3Source	tls(ObservabilityPipelineTls tls)
String	toString()
ObservabilityPipelineAmazonS3Source	type(ObservabilityPipelineAmazonS3SourceType type)
ObservabilityPipelineAmazonS3Source	urlKey(String urlKey)

Methods inherited from class java.lang.Object

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

Field Details

unparsed

public boolean unparsed

JSON_PROPERTY_AUTH

public static final String JSON_PROPERTY_AUTH

See Also:

• Constant Field Values

JSON_PROPERTY_COMPRESSION

public static final String JSON_PROPERTY_COMPRESSION

See Also:

• Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

See Also:

• Constant Field Values

JSON_PROPERTY_REGION

public static final String JSON_PROPERTY_REGION

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

JSON_PROPERTY_URL_KEY

public static final String JSON_PROPERTY_URL_KEY

See Also:

• Constant Field Values

Constructor Details

ObservabilityPipelineAmazonS3Source

public ObservabilityPipelineAmazonS3Source()

ObservabilityPipelineAmazonS3Source

public ObservabilityPipelineAmazonS3Source(String id,
 String region,
 ObservabilityPipelineAmazonS3SourceType type)

Method Details

auth

public ObservabilityPipelineAmazonS3Source auth(ObservabilityPipelineAwsAuth auth)

getAuth

@Nullable
public ObservabilityPipelineAwsAuth getAuth()

AWS authentication credentials used for accessing AWS services such as S3. If omitted, the system’s default credentials are used (for example, the IAM role and environment variables).

Returns:

auth

setAuth

public void setAuth(ObservabilityPipelineAwsAuth auth)

compression

public ObservabilityPipelineAmazonS3Source compression(ObservabilityPipelineAmazonS3SourceCompression compression)

getCompression

@Nullable
public ObservabilityPipelineAmazonS3SourceCompression getCompression()

Compression format for objects retrieved from the S3 bucket. Use auto to detect compression from the object's Content-Encoding header or file extension.

Returns:

compression

setCompression

public void setCompression(ObservabilityPipelineAmazonS3SourceCompression compression)

id

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

region

public ObservabilityPipelineAmazonS3Source region(String region)

getRegion

public String getRegion()

AWS region where the S3 bucket resides.

Returns:

region

setRegion

public void setRegion(String region)

tls

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

type

public ObservabilityPipelineAmazonS3Source type(ObservabilityPipelineAmazonS3SourceType type)

getType

public ObservabilityPipelineAmazonS3SourceType getType()

The source type. Always amazon_s3.

Returns:

type

setType

public void setType(ObservabilityPipelineAmazonS3SourceType type)

urlKey

public ObservabilityPipelineAmazonS3Source urlKey(String urlKey)

getUrlKey

@Nullable
public String getUrlKey()

Name of the environment variable or secret that holds the S3 bucket URL.

Returns:

urlKey

setUrlKey

public void setUrlKey(String urlKey)

putAdditionalProperty

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

ObservabilityPipelineAmazonS3Source

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