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

Class ObservabilityPipelineAmazonS3Destination

java.lang.Object

com.datadog.api.client.v2.model.ObservabilityPipelineAmazonS3Destination

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

The amazon_s3 destination sends your logs in Datadog-rehydratable format to an Amazon S3 bucket for archiving.

Supported pipeline types: logs

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_AUTH
static final String	JSON_PROPERTY_BUCKET
static final String	JSON_PROPERTY_BUFFER
static final String	JSON_PROPERTY_COMPRESSION
static final String	JSON_PROPERTY_ID
static final String	JSON_PROPERTY_INPUTS
static final String	JSON_PROPERTY_KEY_PREFIX
static final String	JSON_PROPERTY_REGION
static final String	JSON_PROPERTY_SERVER_SIDE_ENCRYPTION
static final String	JSON_PROPERTY_SSEKMS_KEY_ID
static final String	JSON_PROPERTY_STORAGE_CLASS
static final String	JSON_PROPERTY_TLS
static final String	JSON_PROPERTY_TYPE
boolean	unparsed

Constructor Summary

Constructors

Constructor	Description
ObservabilityPipelineAmazonS3Destination()
ObservabilityPipelineAmazonS3Destination(String bucket, String id, List<String> inputs, String region, ObservabilityPipelineAmazonS3DestinationStorageClass storageClass, ObservabilityPipelineAmazonS3DestinationType type)

Method Summary

Modifier and Type	Method	Description
ObservabilityPipelineAmazonS3Destination	addInputsItem(String inputsItem)
ObservabilityPipelineAmazonS3Destination	auth(ObservabilityPipelineAwsAuth auth)
ObservabilityPipelineAmazonS3Destination	bucket(String bucket)
ObservabilityPipelineAmazonS3Destination	buffer(ObservabilityPipelineBufferOptions buffer)
ObservabilityPipelineAmazonS3Destination	compression(ObservabilityPipelineAmazonS3DestinationCompression compression)
boolean	equals(Object o)	Return true if this ObservabilityPipelineAmazonS3Destination 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.
String	getBucket()	S3 bucket name.
ObservabilityPipelineBufferOptions	getBuffer()	Configuration for buffer settings on destination components.
ObservabilityPipelineAmazonS3DestinationCompression	getCompression()	Compression configuration for archived logs.
String	getId()	Unique identifier for the destination component.
List<String>	getInputs()	A list of component IDs whose output is used as the input for this component.
String	getKeyPrefix()	Optional prefix for object keys.
String	getRegion()	AWS region of the S3 bucket.
ObservabilityPipelineAmazonS3DestinationServerSideEncryption	getServerSideEncryption()	Server-side encryption type for Amazon S3.
String	getSsekmsKeyId()	The AWS KMS key ID used for SSE-KMS encryption.
ObservabilityPipelineAmazonS3DestinationStorageClass	getStorageClass()	S3 storage class.
ObservabilityPipelineTls	getTls()	Configuration for enabling TLS encryption between the pipeline component and external services.
ObservabilityPipelineAmazonS3DestinationType	getType()	The destination type.
int	hashCode()
ObservabilityPipelineAmazonS3Destination	id(String id)
ObservabilityPipelineAmazonS3Destination	inputs(List<String> inputs)
ObservabilityPipelineAmazonS3Destination	keyPrefix(String keyPrefix)
ObservabilityPipelineAmazonS3Destination	putAdditionalProperty(String key, Object value)	Set the additional (undeclared) property with the specified name and value.
ObservabilityPipelineAmazonS3Destination	region(String region)
ObservabilityPipelineAmazonS3Destination	serverSideEncryption(ObservabilityPipelineAmazonS3DestinationServerSideEncryption serverSideEncryption)
void	setAuth(ObservabilityPipelineAwsAuth auth)
void	setBucket(String bucket)
void	setBuffer(ObservabilityPipelineBufferOptions buffer)
void	setCompression(ObservabilityPipelineAmazonS3DestinationCompression compression)
void	setId(String id)
void	setInputs(List<String> inputs)
void	setKeyPrefix(String keyPrefix)
void	setRegion(String region)
void	setServerSideEncryption(ObservabilityPipelineAmazonS3DestinationServerSideEncryption serverSideEncryption)
void	setSsekmsKeyId(String ssekmsKeyId)
void	setStorageClass(ObservabilityPipelineAmazonS3DestinationStorageClass storageClass)
void	setTls(ObservabilityPipelineTls tls)
void	setType(ObservabilityPipelineAmazonS3DestinationType type)
ObservabilityPipelineAmazonS3Destination	ssekmsKeyId(String ssekmsKeyId)
ObservabilityPipelineAmazonS3Destination	storageClass(ObservabilityPipelineAmazonS3DestinationStorageClass storageClass)
ObservabilityPipelineAmazonS3Destination	tls(ObservabilityPipelineTls tls)
String	toString()
ObservabilityPipelineAmazonS3Destination	type(ObservabilityPipelineAmazonS3DestinationType type)

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_BUCKET

public static final String JSON_PROPERTY_BUCKET

See Also:

• Constant Field Values

JSON_PROPERTY_BUFFER

public static final String JSON_PROPERTY_BUFFER

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_INPUTS

public static final String JSON_PROPERTY_INPUTS

See Also:

• Constant Field Values

JSON_PROPERTY_KEY_PREFIX

public static final String JSON_PROPERTY_KEY_PREFIX

See Also:

• Constant Field Values

JSON_PROPERTY_REGION

public static final String JSON_PROPERTY_REGION

See Also:

• Constant Field Values

JSON_PROPERTY_SERVER_SIDE_ENCRYPTION

public static final String JSON_PROPERTY_SERVER_SIDE_ENCRYPTION

See Also:

• Constant Field Values

JSON_PROPERTY_SSEKMS_KEY_ID

public static final String JSON_PROPERTY_SSEKMS_KEY_ID

See Also:

• Constant Field Values

JSON_PROPERTY_STORAGE_CLASS

public static final String JSON_PROPERTY_STORAGE_CLASS

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

ObservabilityPipelineAmazonS3Destination

public ObservabilityPipelineAmazonS3Destination()

ObservabilityPipelineAmazonS3Destination

public ObservabilityPipelineAmazonS3Destination(String bucket,
 String id,
 List<String> inputs,
 String region,
 ObservabilityPipelineAmazonS3DestinationStorageClass storageClass,
 ObservabilityPipelineAmazonS3DestinationType type)

Method Details

auth

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

bucket

public ObservabilityPipelineAmazonS3Destination bucket(String bucket)

getBucket

public String getBucket()

S3 bucket name.

Returns:

bucket

setBucket

public void setBucket(String bucket)

buffer

public ObservabilityPipelineAmazonS3Destination buffer(ObservabilityPipelineBufferOptions buffer)

getBuffer

@Nullable
public ObservabilityPipelineBufferOptions getBuffer()

Configuration for buffer settings on destination components.

Returns:

buffer

setBuffer

public void setBuffer(ObservabilityPipelineBufferOptions buffer)

compression

public ObservabilityPipelineAmazonS3Destination compression(ObservabilityPipelineAmazonS3DestinationCompression compression)

getCompression

@Nullable
public ObservabilityPipelineAmazonS3DestinationCompression getCompression()

Compression configuration for archived logs. When omitted, logs are compressed with gzip for backward compatibility.

Returns:

compression

setCompression

public void setCompression(ObservabilityPipelineAmazonS3DestinationCompression compression)

id

public ObservabilityPipelineAmazonS3Destination id(String id)

getId

public String getId()

Unique identifier for the destination component.

Returns:

id

setId

public void setId(String id)

inputs

public ObservabilityPipelineAmazonS3Destination inputs(List<String> inputs)

addInputsItem

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

keyPrefix

public ObservabilityPipelineAmazonS3Destination keyPrefix(String keyPrefix)

getKeyPrefix

@Nullable
public String getKeyPrefix()

Optional prefix for object keys.

Returns:

keyPrefix

setKeyPrefix

public void setKeyPrefix(String keyPrefix)

region

public ObservabilityPipelineAmazonS3Destination region(String region)

getRegion

public String getRegion()

AWS region of the S3 bucket.

Returns:

region

setRegion

public void setRegion(String region)

serverSideEncryption

public ObservabilityPipelineAmazonS3Destination serverSideEncryption(ObservabilityPipelineAmazonS3DestinationServerSideEncryption serverSideEncryption)

getServerSideEncryption

@Nullable
public ObservabilityPipelineAmazonS3DestinationServerSideEncryption getServerSideEncryption()

Server-side encryption type for Amazon S3.

Returns:

serverSideEncryption

setServerSideEncryption

public void setServerSideEncryption(ObservabilityPipelineAmazonS3DestinationServerSideEncryption serverSideEncryption)

ssekmsKeyId

public ObservabilityPipelineAmazonS3Destination ssekmsKeyId(String ssekmsKeyId)

getSsekmsKeyId

@Nullable
public String getSsekmsKeyId()

The AWS KMS key ID used for SSE-KMS encryption. Only applies when server_side_encryption is set to aws:kms.

Returns:

ssekmsKeyId

setSsekmsKeyId

public void setSsekmsKeyId(String ssekmsKeyId)

storageClass

public ObservabilityPipelineAmazonS3Destination storageClass(ObservabilityPipelineAmazonS3DestinationStorageClass storageClass)

getStorageClass

public ObservabilityPipelineAmazonS3DestinationStorageClass getStorageClass()

S3 storage class.

Returns:

storageClass

setStorageClass

public void setStorageClass(ObservabilityPipelineAmazonS3DestinationStorageClass storageClass)

tls

public ObservabilityPipelineAmazonS3Destination 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 ObservabilityPipelineAmazonS3Destination type(ObservabilityPipelineAmazonS3DestinationType type)

getType

public ObservabilityPipelineAmazonS3DestinationType getType()

The destination type. Always amazon_s3.

Returns:

type

setType

public void setType(ObservabilityPipelineAmazonS3DestinationType type)

putAdditionalProperty

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

ObservabilityPipelineAmazonS3Destination

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