ObservabilityPipelineAmazonDataFirehoseSource (datadog-api-client 2.56.0 API)

java.lang.Object
- com.datadog.api.client.v2.model.ObservabilityPipelineAmazonDataFirehoseSource

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

The amazon_data_firehose source ingests logs from AWS Data Firehose.

Supported pipeline types: logs

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`JSON_PROPERTY_ADDRESS_KEY`
`static String`	`JSON_PROPERTY_AUTH`
`static String`	`JSON_PROPERTY_ID`
`static String`	`JSON_PROPERTY_TLS`
`static String`	`JSON_PROPERTY_TYPE`
`boolean`	`unparsed`

Constructor Summary

Constructors
Constructor and Description
`ObservabilityPipelineAmazonDataFirehoseSource()`
`ObservabilityPipelineAmazonDataFirehoseSource(String id, ObservabilityPipelineAmazonDataFirehoseSourceType type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ObservabilityPipelineAmazonDataFirehoseSource`	`addressKey(String addressKey)`
`ObservabilityPipelineAmazonDataFirehoseSource`	`auth(ObservabilityPipelineAwsAuth auth)`
`boolean`	`equals(Object o)` Return true if this ObservabilityPipelineAmazonDataFirehoseSource 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 Firehose delivery stream address.
`ObservabilityPipelineAwsAuth`	`getAuth()` AWS authentication credentials used for accessing AWS services such as S3.
`String`	`getId()` The unique identifier for this component.
`ObservabilityPipelineTls`	`getTls()` Configuration for enabling TLS encryption between the pipeline component and external services.
`ObservabilityPipelineAmazonDataFirehoseSourceType`	`getType()` The source type.
`int`	`hashCode()`
`ObservabilityPipelineAmazonDataFirehoseSource`	`id(String id)`
`ObservabilityPipelineAmazonDataFirehoseSource`	`putAdditionalProperty(String key, Object value)` Set the additional (undeclared) property with the specified name and value.
`void`	`setAddressKey(String addressKey)`
`void`	`setAuth(ObservabilityPipelineAwsAuth auth)`
`void`	`setId(String id)`
`void`	`setTls(ObservabilityPipelineTls tls)`
`void`	`setType(ObservabilityPipelineAmazonDataFirehoseSourceType type)`
`ObservabilityPipelineAmazonDataFirehoseSource`	`tls(ObservabilityPipelineTls tls)`
`String`	`toString()`
`ObservabilityPipelineAmazonDataFirehoseSource`	`type(ObservabilityPipelineAmazonDataFirehoseSourceType 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_AUTH

public static final String JSON_PROPERTY_AUTH

See Also:: Constant Field Values

JSON_PROPERTY_ID

public static final String JSON_PROPERTY_ID

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

ObservabilityPipelineAmazonDataFirehoseSource

public ObservabilityPipelineAmazonDataFirehoseSource()

ObservabilityPipelineAmazonDataFirehoseSource

public ObservabilityPipelineAmazonDataFirehoseSource(String id,
                                                     ObservabilityPipelineAmazonDataFirehoseSourceType type)

Method Detail
- addressKey
```
public ObservabilityPipelineAmazonDataFirehoseSource addressKey(String addressKey)
```
- getAddressKey
```
@Nullable
public String getAddressKey()
```
  Name of the environment variable or secret that holds the Firehose delivery stream address.
  
  Returns:
  
  addressKey
- setAddressKey
```
public void setAddressKey(String addressKey)
```
- auth
```
public ObservabilityPipelineAmazonDataFirehoseSource 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)
```
- id
```
public ObservabilityPipelineAmazonDataFirehoseSource 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)
```
- tls
```
public ObservabilityPipelineAmazonDataFirehoseSource 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 ObservabilityPipelineAmazonDataFirehoseSource type(ObservabilityPipelineAmazonDataFirehoseSourceType type)
```
- getType
```
public ObservabilityPipelineAmazonDataFirehoseSourceType getType()
```
  The source type. The value should always be amazon_data_firehose.
  
  Returns:
  
  type
- setType
```
public void setType(ObservabilityPipelineAmazonDataFirehoseSourceType type)
```
- putAdditionalProperty
```
public ObservabilityPipelineAmazonDataFirehoseSource 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:
  
  ObservabilityPipelineAmazonDataFirehoseSource
- 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 ObservabilityPipelineAmazonDataFirehoseSource 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

Class ObservabilityPipelineAmazonDataFirehoseSource

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

unparsed

JSON_PROPERTY_ADDRESS_KEY

JSON_PROPERTY_AUTH

JSON_PROPERTY_ID

JSON_PROPERTY_TLS

JSON_PROPERTY_TYPE

Constructor Detail

ObservabilityPipelineAmazonDataFirehoseSource

ObservabilityPipelineAmazonDataFirehoseSource

Method Detail

addressKey

getAddressKey

setAddressKey

auth

getAuth

setAuth

id

getId

setId

tls

getTls

setTls

type

getType

setType

putAdditionalProperty

getAdditionalProperties

getAdditionalProperty

equals

hashCode

toString