java.lang.Object
- software.amazon.awssdk.services.firehose.model.ElasticsearchDestinationDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ElasticsearchDestinationDescription.Builder,ElasticsearchDestinationDescription>

@Generated("software.amazon.awssdk:codegen")
public final class ElasticsearchDestinationDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ElasticsearchDestinationDescription.Builder,ElasticsearchDestinationDescription>

The destination description in Amazon ES.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ElasticsearchDestinationDescription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ElasticsearchBufferingHints`	`bufferingHints()`	The buffering options.
`static ElasticsearchDestinationDescription.Builder`	`builder()`
`CloudWatchLoggingOptions`	`cloudWatchLoggingOptions()`	The Amazon CloudWatch logging options.
`String`	`clusterEndpoint()`	The endpoint to use when communicating with the cluster.
`DocumentIdOptions`	`documentIdOptions()`	Indicates the method for setting up document ID.
`String`	`domainARN()`	The ARN of the Amazon ES domain.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`indexName()`	The Elasticsearch index name.
`ElasticsearchIndexRotationPeriod`	`indexRotationPeriod()`	The Elasticsearch index rotation period
`String`	`indexRotationPeriodAsString()`	The Elasticsearch index rotation period
`ProcessingConfiguration`	`processingConfiguration()`	The data processing configuration.
`ElasticsearchRetryOptions`	`retryOptions()`	The Amazon ES retry options.
`String`	`roleARN()`	The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
`ElasticsearchS3BackupMode`	`s3BackupMode()`	The Amazon S3 backup mode.
`String`	`s3BackupModeAsString()`	The Amazon S3 backup mode.
`S3DestinationDescription`	`s3DestinationDescription()`	The Amazon S3 destination.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ElasticsearchDestinationDescription.Builder>`	`serializableBuilderClass()`
`ElasticsearchDestinationDescription.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`typeName()`	The Elasticsearch type name.
`VpcConfigurationDescription`	`vpcConfigurationDescription()`	The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - roleARN
```
public final String roleARN()
```
    The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
  - domainARN
```
public final String domainARN()
```
    The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.
    
    Returns:
    
    The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
    
    Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.
  - clusterEndpoint
```
public final String clusterEndpoint()
```
    The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.
    
    Returns:
    
    The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.
  - indexName
```
public final String indexName()
```
    The Elasticsearch index name.
    
    Returns:
    
    The Elasticsearch index name.
  - typeName
```
public final String typeName()
```
    The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
    
    Returns:
    
    The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
  - indexRotationPeriod
```
public final ElasticsearchIndexRotationPeriod indexRotationPeriod()
```
    The Elasticsearch index rotation period
    
    If the service returns an enum value that is not available in the current SDK version, indexRotationPeriod will return ElasticsearchIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexRotationPeriodAsString().
    
    Returns:
    
    The Elasticsearch index rotation period
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - indexRotationPeriodAsString
```
public final String indexRotationPeriodAsString()
```
    The Elasticsearch index rotation period
    
    If the service returns an enum value that is not available in the current SDK version, indexRotationPeriod will return ElasticsearchIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexRotationPeriodAsString().
    
    Returns:
    
    The Elasticsearch index rotation period
    
    See Also:
    
    ElasticsearchIndexRotationPeriod
  - bufferingHints
```
public final ElasticsearchBufferingHints bufferingHints()
```
    The buffering options.
    
    Returns:
    
    The buffering options.
  - retryOptions
```
public final ElasticsearchRetryOptions retryOptions()
```
    The Amazon ES retry options.
    
    Returns:
    
    The Amazon ES retry options.
  - s3BackupMode
```
public final ElasticsearchS3BackupMode s3BackupMode()
```
    The Amazon S3 backup mode.
    
    If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return ElasticsearchS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().
    
    Returns:
    
    The Amazon S3 backup mode.
    
    See Also:
    
    ElasticsearchS3BackupMode
  - s3BackupModeAsString
```
public final String s3BackupModeAsString()
```
    The Amazon S3 backup mode.
    
    If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return ElasticsearchS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().
    
    Returns:
    
    The Amazon S3 backup mode.
    
    See Also:
    
    ElasticsearchS3BackupMode
  - s3DestinationDescription
```
public final S3DestinationDescription s3DestinationDescription()
```
    The Amazon S3 destination.
    
    Returns:
    
    The Amazon S3 destination.
  - processingConfiguration
```
public final ProcessingConfiguration processingConfiguration()
```
    The data processing configuration.
    
    Returns:
    
    The data processing configuration.
  - cloudWatchLoggingOptions
```
public final CloudWatchLoggingOptions cloudWatchLoggingOptions()
```
    The Amazon CloudWatch logging options.
    
    Returns:
    
    The Amazon CloudWatch logging options.
  - vpcConfigurationDescription
```
public final VpcConfigurationDescription vpcConfigurationDescription()
```
    The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.
    
    Returns:
    
    The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.
  - documentIdOptions
```
public final DocumentIdOptions documentIdOptions()
```
    Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
    
    Returns:
    
    Indicates the method for setting up document ID. The supported methods are Kinesis Data Firehose generated document ID and OpenSearch Service generated document ID.
  - toBuilder
```
public ElasticsearchDestinationDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ElasticsearchDestinationDescription.Builder,ElasticsearchDestinationDescription>
  - builder
```
public static ElasticsearchDestinationDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ElasticsearchDestinationDescription.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ElasticsearchDestinationDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

roleARN

domainARN

clusterEndpoint

indexName

typeName

indexRotationPeriod

indexRotationPeriodAsString

bufferingHints

retryOptions

s3BackupMode

s3BackupModeAsString

s3DestinationDescription

processingConfiguration

cloudWatchLoggingOptions

vpcConfigurationDescription

documentIdOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields