AmazonOpenSearchServerlessDestinationConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesisfirehose.model.AmazonOpenSearchServerlessDestinationConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonOpenSearchServerlessDestinationConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AmazonOpenSearchServerlessDestinationConfiguration()

Constructors
Constructor and Description
`AmazonOpenSearchServerlessDestinationConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AmazonOpenSearchServerlessDestinationConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`AmazonOpenSearchServerlessBufferingHints`	`getBufferingHints()` The buffering options.
`CloudWatchLoggingOptions`	`getCloudWatchLoggingOptions()`
`String`	`getCollectionEndpoint()` The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
`String`	`getIndexName()` The Serverless offering for Amazon OpenSearch Service index name.
`ProcessingConfiguration`	`getProcessingConfiguration()`
`AmazonOpenSearchServerlessRetryOptions`	`getRetryOptions()` The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
`String`	`getRoleARN()` 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.
`String`	`getS3BackupMode()` Defines how documents should be delivered to Amazon S3.
`S3DestinationConfiguration`	`getS3Configuration()`
`VpcConfiguration`	`getVpcConfiguration()`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBufferingHints(AmazonOpenSearchServerlessBufferingHints bufferingHints)` The buffering options.
`void`	`setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)`
`void`	`setCollectionEndpoint(String collectionEndpoint)` The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
`void`	`setIndexName(String indexName)` The Serverless offering for Amazon OpenSearch Service index name.
`void`	`setProcessingConfiguration(ProcessingConfiguration processingConfiguration)`
`void`	`setRetryOptions(AmazonOpenSearchServerlessRetryOptions retryOptions)` The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
`void`	`setRoleARN(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.
`void`	`setS3BackupMode(String s3BackupMode)` Defines how documents should be delivered to Amazon S3.
`void`	`setS3Configuration(S3DestinationConfiguration s3Configuration)`
`void`	`setVpcConfiguration(VpcConfiguration vpcConfiguration)`
`String`	`toString()` Returns a string representation of this object.
`AmazonOpenSearchServerlessDestinationConfiguration`	`withBufferingHints(AmazonOpenSearchServerlessBufferingHints bufferingHints)` The buffering options.
`AmazonOpenSearchServerlessDestinationConfiguration`	`withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)`
`AmazonOpenSearchServerlessDestinationConfiguration`	`withCollectionEndpoint(String collectionEndpoint)` The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
`AmazonOpenSearchServerlessDestinationConfiguration`	`withIndexName(String indexName)` The Serverless offering for Amazon OpenSearch Service index name.
`AmazonOpenSearchServerlessDestinationConfiguration`	`withProcessingConfiguration(ProcessingConfiguration processingConfiguration)`
`AmazonOpenSearchServerlessDestinationConfiguration`	`withRetryOptions(AmazonOpenSearchServerlessRetryOptions retryOptions)` The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
`AmazonOpenSearchServerlessDestinationConfiguration`	`withRoleARN(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.
`AmazonOpenSearchServerlessDestinationConfiguration`	`withS3BackupMode(AmazonOpenSearchServerlessS3BackupMode s3BackupMode)` Defines how documents should be delivered to Amazon S3.
`AmazonOpenSearchServerlessDestinationConfiguration`	`withS3BackupMode(String s3BackupMode)` Defines how documents should be delivered to Amazon S3.
`AmazonOpenSearchServerlessDestinationConfiguration`	`withS3Configuration(S3DestinationConfiguration s3Configuration)`
`AmazonOpenSearchServerlessDestinationConfiguration`	`withVpcConfiguration(VpcConfiguration vpcConfiguration)`

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

- Constructor Detail
  - AmazonOpenSearchServerlessDestinationConfiguration
```
public AmazonOpenSearchServerlessDestinationConfiguration()
```
- Method Detail
  - setRoleARN
```
public void setRoleARN(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.
    
    Parameters:
    
    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.
  - getRoleARN
```
public String getRoleARN()
```
    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.
  - withRoleARN
```
public AmazonOpenSearchServerlessDestinationConfiguration withRoleARN(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCollectionEndpoint
```
public void setCollectionEndpoint(String collectionEndpoint)
```
    The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
    
    Parameters:
    
    collectionEndpoint - The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
  - getCollectionEndpoint
```
public String getCollectionEndpoint()
```
    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.
  - withCollectionEndpoint
```
public AmazonOpenSearchServerlessDestinationConfiguration withCollectionEndpoint(String collectionEndpoint)
```
    The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
    
    Parameters:
    
    collectionEndpoint - The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIndexName
```
public void setIndexName(String indexName)
```
    The Serverless offering for Amazon OpenSearch Service index name.
    
    Parameters:
    
    indexName - The Serverless offering for Amazon OpenSearch Service index name.
  - getIndexName
```
public String getIndexName()
```
    The Serverless offering for Amazon OpenSearch Service index name.
    
    Returns:
    
    The Serverless offering for Amazon OpenSearch Service index name.
  - withIndexName
```
public AmazonOpenSearchServerlessDestinationConfiguration withIndexName(String indexName)
```
    The Serverless offering for Amazon OpenSearch Service index name.
    
    Parameters:
    
    indexName - The Serverless offering for Amazon OpenSearch Service index name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBufferingHints
```
public void setBufferingHints(AmazonOpenSearchServerlessBufferingHints bufferingHints)
```
    The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
    
    Parameters:
    
    bufferingHints - The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
  - getBufferingHints
```
public AmazonOpenSearchServerlessBufferingHints getBufferingHints()
```
    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.
  - withBufferingHints
```
public AmazonOpenSearchServerlessDestinationConfiguration withBufferingHints(AmazonOpenSearchServerlessBufferingHints bufferingHints)
```
    The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
    
    Parameters:
    
    bufferingHints - The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetryOptions
```
public void setRetryOptions(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).
    
    Parameters:
    
    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).
  - getRetryOptions
```
public AmazonOpenSearchServerlessRetryOptions getRetryOptions()
```
    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).
  - withRetryOptions
```
public AmazonOpenSearchServerlessDestinationConfiguration withRetryOptions(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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setS3BackupMode
```
public void setS3BackupMode(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    AmazonOpenSearchServerlessS3BackupMode
  - getS3BackupMode
```
public String getS3BackupMode()
```
    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.
    
    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
  - withS3BackupMode
```
public AmazonOpenSearchServerlessDestinationConfiguration withS3BackupMode(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AmazonOpenSearchServerlessS3BackupMode
  - withS3BackupMode
```
public AmazonOpenSearchServerlessDestinationConfiguration withS3BackupMode(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AmazonOpenSearchServerlessS3BackupMode
  - setS3Configuration
```
public void setS3Configuration(S3DestinationConfiguration s3Configuration)
```
    Parameters:
    
    s3Configuration -
  - getS3Configuration
```
public S3DestinationConfiguration getS3Configuration()
```
    Returns:
  - withS3Configuration
```
public AmazonOpenSearchServerlessDestinationConfiguration withS3Configuration(S3DestinationConfiguration s3Configuration)
```
    Parameters:
    
    s3Configuration -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProcessingConfiguration
```
public void setProcessingConfiguration(ProcessingConfiguration processingConfiguration)
```
    Parameters:
    
    processingConfiguration -
  - getProcessingConfiguration
```
public ProcessingConfiguration getProcessingConfiguration()
```
    Returns:
  - withProcessingConfiguration
```
public AmazonOpenSearchServerlessDestinationConfiguration withProcessingConfiguration(ProcessingConfiguration processingConfiguration)
```
    Parameters:
    
    processingConfiguration -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudWatchLoggingOptions
```
public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
```
    Parameters:
    
    cloudWatchLoggingOptions -
  - getCloudWatchLoggingOptions
```
public CloudWatchLoggingOptions getCloudWatchLoggingOptions()
```
    Returns:
  - withCloudWatchLoggingOptions
```
public AmazonOpenSearchServerlessDestinationConfiguration withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
```
    Parameters:
    
    cloudWatchLoggingOptions -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcConfiguration
```
public void setVpcConfiguration(VpcConfiguration vpcConfiguration)
```
    Parameters:
    
    vpcConfiguration -
  - getVpcConfiguration
```
public VpcConfiguration getVpcConfiguration()
```
    Returns:
  - withVpcConfiguration
```
public AmazonOpenSearchServerlessDestinationConfiguration withVpcConfiguration(VpcConfiguration vpcConfiguration)
```
    Parameters:
    
    vpcConfiguration -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AmazonOpenSearchServerlessDestinationConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class AmazonOpenSearchServerlessDestinationConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AmazonOpenSearchServerlessDestinationConfiguration

Method Detail

setRoleARN

getRoleARN

withRoleARN

setCollectionEndpoint

getCollectionEndpoint

withCollectionEndpoint

setIndexName

getIndexName

withIndexName

setBufferingHints

getBufferingHints

withBufferingHints

setRetryOptions

getRetryOptions

withRetryOptions

setS3BackupMode

getS3BackupMode

withS3BackupMode

withS3BackupMode

setS3Configuration

getS3Configuration

withS3Configuration

setProcessingConfiguration

getProcessingConfiguration

withProcessingConfiguration

setCloudWatchLoggingOptions

getCloudWatchLoggingOptions

withCloudWatchLoggingOptions

setVpcConfiguration

getVpcConfiguration

withVpcConfiguration

toString

equals

hashCode

clone

marshall