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

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

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

Describes an update for a destination in Amazon OpenSearch Service.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AmazonopensearchserviceDestinationUpdate.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AmazonopensearchserviceBufferingHints`	`bufferingHints()`	The buffering options.
`static AmazonopensearchserviceDestinationUpdate.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 Amazon 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.
`S3DestinationUpdate`	`s3Update()`	Returns the value of the S3Update property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AmazonopensearchserviceDestinationUpdate.Builder>`	`serializableBuilderClass()`
`AmazonopensearchserviceDestinationUpdate.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`typeName()`	The Amazon OpenSearch Service type name.

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 DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
    
    Returns:
    
    The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM 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 Amazon OpenSearch Service index name.
    
    Returns:
    
    The Amazon 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 runtime.
    
    If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
    
    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 runtime.
    
    If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
  - indexRotationPeriod
```
public final AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod()
```
    The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to 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 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 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 IndexName to facilitate the expiration of old data.
    
    See Also:
    
    AmazonopensearchserviceIndexRotationPeriod
  - bufferingHints
```
public final AmazonopensearchserviceBufferingHints bufferingHints()
```
    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.
  - 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).
  - s3Update
```
public final S3DestinationUpdate s3Update()
```
    Returns the value of the S3Update property for this object.
    
    Returns:
    
    The value of the S3Update 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.
  - 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 AmazonopensearchserviceDestinationUpdate.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AmazonopensearchserviceDestinationUpdate.Builder,AmazonopensearchserviceDestinationUpdate>
  - builder
```
public static AmazonopensearchserviceDestinationUpdate.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AmazonopensearchserviceDestinationUpdate.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 AmazonopensearchserviceDestinationUpdate

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

s3Update

processingConfiguration

cloudWatchLoggingOptions

documentIdOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields