AmazonOpenSearchServerlessDestinationUpdate (AWS Java SDK for Amazon Kinesis 1.12.513 API)

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

All Implemented Interfaces:

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AmazonOpenSearchServerlessDestinationUpdate()

Constructors
Constructor and Description
`AmazonOpenSearchServerlessDestinationUpdate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AmazonOpenSearchServerlessDestinationUpdate`	`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 Kinesis Data 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 Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
`S3DestinationUpdate`	`getS3Update()`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller 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 Kinesis Data 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 Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
`void`	`setS3Update(S3DestinationUpdate s3Update)`
`String`	`toString()` Returns a string representation of this object.
`AmazonOpenSearchServerlessDestinationUpdate`	`withBufferingHints(AmazonOpenSearchServerlessBufferingHints bufferingHints)` The buffering options.
`AmazonOpenSearchServerlessDestinationUpdate`	`withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)`
`AmazonOpenSearchServerlessDestinationUpdate`	`withCollectionEndpoint(String collectionEndpoint)` The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
`AmazonOpenSearchServerlessDestinationUpdate`	`withIndexName(String indexName)` The Serverless offering for Amazon OpenSearch Service index name.
`AmazonOpenSearchServerlessDestinationUpdate`	`withProcessingConfiguration(ProcessingConfiguration processingConfiguration)`
`AmazonOpenSearchServerlessDestinationUpdate`	`withRetryOptions(AmazonOpenSearchServerlessRetryOptions retryOptions)` The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
`AmazonOpenSearchServerlessDestinationUpdate`	`withRoleARN(String roleARN)` The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
`AmazonOpenSearchServerlessDestinationUpdate`	`withS3Update(S3DestinationUpdate s3Update)`

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

- Constructor Detail
  - AmazonOpenSearchServerlessDestinationUpdate
```
public AmazonOpenSearchServerlessDestinationUpdate()
```
- Method Detail
  - setRoleARN
```
public void setRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data 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 Kinesis Data 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 Kinesis Data 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 Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
  - withRoleARN
```
public AmazonOpenSearchServerlessDestinationUpdate withRoleARN(String roleARN)
```
    The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data 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 Kinesis Data 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 AmazonOpenSearchServerlessDestinationUpdate 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 AmazonOpenSearchServerlessDestinationUpdate 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, AmazonopensearchBufferingHints object default values are used.
    
    Parameters:
    
    bufferingHints - The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
  - getBufferingHints
```
public AmazonOpenSearchServerlessBufferingHints getBufferingHints()
```
    The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
    
    Returns:
    
    The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
  - withBufferingHints
```
public AmazonOpenSearchServerlessDestinationUpdate withBufferingHints(AmazonOpenSearchServerlessBufferingHints bufferingHints)
```
    The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
    
    Parameters:
    
    bufferingHints - The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values 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 Kinesis Data 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 Kinesis Data 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 Kinesis Data 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 Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
  - withRetryOptions
```
public AmazonOpenSearchServerlessDestinationUpdate withRetryOptions(AmazonOpenSearchServerlessRetryOptions retryOptions)
```
    The retry behavior in case Kinesis Data 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 Kinesis Data 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.
  - setS3Update
```
public void setS3Update(S3DestinationUpdate s3Update)
```
    Parameters:
    
    s3Update -
  - getS3Update
```
public S3DestinationUpdate getS3Update()
```
    Returns:
  - withS3Update
```
public AmazonOpenSearchServerlessDestinationUpdate withS3Update(S3DestinationUpdate s3Update)
```
    Parameters:
    
    s3Update -
    
    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 AmazonOpenSearchServerlessDestinationUpdate 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 AmazonOpenSearchServerlessDestinationUpdate withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)
```
    Parameters:
    
    cloudWatchLoggingOptions -
    
    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 AmazonOpenSearchServerlessDestinationUpdate clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class AmazonOpenSearchServerlessDestinationUpdate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AmazonOpenSearchServerlessDestinationUpdate

Method Detail

setRoleARN

getRoleARN

withRoleARN

setCollectionEndpoint

getCollectionEndpoint

withCollectionEndpoint

setIndexName

getIndexName

withIndexName

setBufferingHints

getBufferingHints

withBufferingHints

setRetryOptions

getRetryOptions

withRetryOptions

setS3Update

getS3Update

withS3Update

setProcessingConfiguration

getProcessingConfiguration

withProcessingConfiguration

setCloudWatchLoggingOptions

getCloudWatchLoggingOptions

withCloudWatchLoggingOptions

toString

equals

hashCode

clone

marshall