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

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AmazonOpenSearchServerlessDestinationConfiguration.Builder,AmazonOpenSearchServerlessDestinationConfiguration>
```
@Generated("software.amazon.awssdk:codegen")
public final class AmazonOpenSearchServerlessDestinationConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AmazonOpenSearchServerlessDestinationConfiguration.Builder,AmazonOpenSearchServerlessDestinationConfiguration>
```
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AmazonOpenSearchServerlessDestinationConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AmazonOpenSearchServerlessBufferingHints`	`bufferingHints()`	The buffering options.
`static AmazonOpenSearchServerlessDestinationConfiguration.Builder`	`builder()`
`CloudWatchLoggingOptions`	`cloudWatchLoggingOptions()`	Returns the value of the CloudWatchLoggingOptions property for this object.
`String`	`collectionEndpoint()`	The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`indexName()`	The Serverless offering for Amazon OpenSearch Service index name.
`ProcessingConfiguration`	`processingConfiguration()`	Returns the value of the ProcessingConfiguration property for this object.
`AmazonOpenSearchServerlessRetryOptions`	`retryOptions()`	The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
`String`	`roleARN()`	The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
`AmazonOpenSearchServerlessS3BackupMode`	`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 AmazonOpenSearchServerlessDestinationConfiguration.Builder>`	`serializableBuilderClass()`
`AmazonOpenSearchServerlessDestinationConfiguration.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`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 Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
  - collectionEndpoint
```
public final String collectionEndpoint()
```
    The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
    
    Returns:
    
    The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
  - indexName
```
public final String indexName()
```
    The Serverless offering for Amazon OpenSearch Service index name.
    
    Returns:
    
    The Serverless offering for Amazon OpenSearch Service index name.
  - bufferingHints
```
public final AmazonOpenSearchServerlessBufferingHints 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 AmazonOpenSearchServerlessRetryOptions retryOptions()
```
    The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
    
    Returns:
    
    The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
  - s3BackupMode
```
public final AmazonOpenSearchServerlessS3BackupMode s3BackupMode()
```
    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, 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, 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 AmazonOpenSearchServerlessS3BackupMode.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, 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, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
    
    See Also:
    
    AmazonOpenSearchServerlessS3BackupMode
  - s3BackupModeAsString
```
public final String s3BackupModeAsString()
```
    Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, 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, 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 AmazonOpenSearchServerlessS3BackupMode.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, 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, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
    
    See Also:
    
    AmazonOpenSearchServerlessS3BackupMode
  - 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.
  - toBuilder
```
public AmazonOpenSearchServerlessDestinationConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AmazonOpenSearchServerlessDestinationConfiguration.Builder,AmazonOpenSearchServerlessDestinationConfiguration>
  - builder
```
public static AmazonOpenSearchServerlessDestinationConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AmazonOpenSearchServerlessDestinationConfiguration.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 AmazonOpenSearchServerlessDestinationConfiguration

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

collectionEndpoint

indexName

bufferingHints

retryOptions

s3BackupMode

s3BackupModeAsString

s3Configuration

processingConfiguration

cloudWatchLoggingOptions

vpcConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields