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

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

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

Describes the configuration of a destination in Amazon OpenSearch Service

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AmazonopensearchserviceDestinationConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AmazonopensearchserviceBufferingHints`	`bufferingHints()`	The buffering options.
`static AmazonopensearchserviceDestinationConfiguration.Builder`	`builder()`
`CloudWatchLoggingOptions`	`cloudWatchLoggingOptions()`	Returns the value of the CloudWatchLoggingOptions property for this object.
`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 OpenSearch Service domain.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`indexName()`	The ElasticsearAmazon OpenSearch Service index name.
`AmazonopensearchserviceIndexRotationPeriod`	`indexRotationPeriod()`	The Amazon OpenSearch Service index rotation period.
`String`	`indexRotationPeriodAsString()`	The Amazon OpenSearch Service index rotation period.
`ProcessingConfiguration`	`processingConfiguration()`	Returns the value of the ProcessingConfiguration property for this object.
`AmazonopensearchserviceRetryOptions`	`retryOptions()`	The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
`String`	`roleARN()`	The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
`AmazonopensearchserviceS3BackupMode`	`s3BackupMode()`	Defines how documents should be delivered to Amazon S3.
`String`	`s3BackupModeAsString()`	Defines how documents should be delivered to Amazon S3.
`S3DestinationConfiguration`	`s3Configuration()`	Returns the value of the S3Configuration property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AmazonopensearchserviceDestinationConfiguration.Builder>`	`serializableBuilderClass()`
`AmazonopensearchserviceDestinationConfiguration.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`typeName()`	The Amazon OpenSearch Service type name.
`VpcConfiguration`	`vpcConfiguration()`	Returns the value of the VpcConfiguration property for this object.

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 IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
  - domainARN
```
public final String domainARN()
```
    The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.
    
    Returns:
    
    The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.
  - clusterEndpoint
```
public final String clusterEndpoint()
```
    The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
    
    Returns:
    
    The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
  - indexName
```
public final String indexName()
```
    The ElasticsearAmazon OpenSearch Service index name.
    
    Returns:
    
    The ElasticsearAmazon OpenSearch Service index name.
  - typeName
```
public final String typeName()
```
    The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.
    
    Returns:
    
    The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.
  - indexRotationPeriod
```
public final AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod()
```
    The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
    
    If the service returns an enum value that is not available in the current SDK version, indexRotationPeriod will return AmazonopensearchserviceIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexRotationPeriodAsString().
    
    Returns:
    
    The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
    
    See Also:
    
    AmazonopensearchserviceIndexRotationPeriod
  - indexRotationPeriodAsString
```
public final String indexRotationPeriodAsString()
```
    The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
    
    If the service returns an enum value that is not available in the current SDK version, indexRotationPeriod will return AmazonopensearchserviceIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexRotationPeriodAsString().
    
    Returns:
    
    The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
    
    See Also:
    
    AmazonopensearchserviceIndexRotationPeriod
  - bufferingHints
```
public final AmazonopensearchserviceBufferingHints bufferingHints()
```
    The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
    
    Returns:
    
    The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
  - retryOptions
```
public final AmazonopensearchserviceRetryOptions retryOptions()
```
    The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
    
    Returns:
    
    The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
  - s3BackupMode
```
public final AmazonopensearchserviceS3BackupMode s3BackupMode()
```
    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
    
    If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return AmazonopensearchserviceS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().
    
    Returns:
    
    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
    
    See Also:
    
    AmazonopensearchserviceS3BackupMode
  - s3BackupModeAsString
```
public final String s3BackupModeAsString()
```
    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
    
    If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return AmazonopensearchserviceS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().
    
    Returns:
    
    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
    
    See Also:
    
    AmazonopensearchserviceS3BackupMode
  - s3Configuration
```
public final S3DestinationConfiguration s3Configuration()
```
    Returns the value of the S3Configuration property for this object.
    
    Returns:
    
    The value of the S3Configuration property for this object.
  - processingConfiguration
```
public final ProcessingConfiguration processingConfiguration()
```
    Returns the value of the ProcessingConfiguration property for this object.
    
    Returns:
    
    The value of the ProcessingConfiguration property for this object.
  - cloudWatchLoggingOptions
```
public final CloudWatchLoggingOptions cloudWatchLoggingOptions()
```
    Returns the value of the CloudWatchLoggingOptions property for this object.
    
    Returns:
    
    The value of the CloudWatchLoggingOptions property for this object.
  - vpcConfiguration
```
public final VpcConfiguration vpcConfiguration()
```
    Returns the value of the VpcConfiguration property for this object.
    
    Returns:
    
    The value of the VpcConfiguration property for this object.
  - 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 AmazonopensearchserviceDestinationConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AmazonopensearchserviceDestinationConfiguration.Builder,AmazonopensearchserviceDestinationConfiguration>
  - builder
```
public static AmazonopensearchserviceDestinationConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AmazonopensearchserviceDestinationConfiguration.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 AmazonopensearchserviceDestinationConfiguration

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

s3Configuration

processingConfiguration

cloudWatchLoggingOptions

vpcConfiguration

documentIdOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields