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

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

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

The destination description in Amazon OpenSearch Service.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AmazonopensearchserviceDestinationDescription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AmazonopensearchserviceBufferingHints`	`bufferingHints()`	The buffering options.
`static AmazonopensearchserviceDestinationDescription.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 Amazon OpenSearch Service retry options.
`String`	`roleARN()`	The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
`AmazonopensearchserviceS3BackupMode`	`s3BackupMode()`	The Amazon S3 backup mode.
`String`	`s3BackupModeAsString()`	The Amazon S3 backup mode.
`S3DestinationDescription`	`s3DestinationDescription()`	Returns the value of the S3DestinationDescription property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AmazonopensearchserviceDestinationDescription.Builder>`	`serializableBuilderClass()`
`AmazonopensearchserviceDestinationDescription.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`typeName()`	The Amazon OpenSearch Service type name.
`VpcConfigurationDescription`	`vpcConfigurationDescription()`	Returns the value of the VpcConfigurationDescription 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 Amazon Web Services credentials.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
  - domainARN
```
public final String domainARN()
```
    The ARN of the Amazon OpenSearch Service domain.
    
    Returns:
    
    The ARN of the Amazon OpenSearch Service domain.
  - clusterEndpoint
```
public final String clusterEndpoint()
```
    The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
    
    Returns:
    
    The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
  - 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. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
    
    Returns:
    
    The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
  - indexRotationPeriod
```
public final AmazonopensearchserviceIndexRotationPeriod indexRotationPeriod()
```
    The Amazon OpenSearch Service index rotation period
    
    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
    
    See Also:
    
    AmazonopensearchserviceIndexRotationPeriod
  - indexRotationPeriodAsString
```
public final String indexRotationPeriodAsString()
```
    The Amazon OpenSearch Service index rotation period
    
    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
    
    See Also:
    
    AmazonopensearchserviceIndexRotationPeriod
  - bufferingHints
```
public final AmazonopensearchserviceBufferingHints bufferingHints()
```
    The buffering options.
    
    Returns:
    
    The buffering options.
  - retryOptions
```
public final AmazonopensearchserviceRetryOptions retryOptions()
```
    The Amazon OpenSearch Service retry options.
    
    Returns:
    
    The Amazon OpenSearch Service retry options.
  - s3BackupMode
```
public final AmazonopensearchserviceS3BackupMode s3BackupMode()
```
    The Amazon S3 backup mode.
    
    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:
    
    The Amazon S3 backup mode.
    
    See Also:
    
    AmazonopensearchserviceS3BackupMode
  - s3BackupModeAsString
```
public final String s3BackupModeAsString()
```
    The Amazon S3 backup mode.
    
    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:
    
    The Amazon S3 backup mode.
    
    See Also:
    
    AmazonopensearchserviceS3BackupMode
  - s3DestinationDescription
```
public final S3DestinationDescription s3DestinationDescription()
```
    Returns the value of the S3DestinationDescription property for this object.
    
    Returns:
    
    The value of the S3DestinationDescription 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.
  - vpcConfigurationDescription
```
public final VpcConfigurationDescription vpcConfigurationDescription()
```
    Returns the value of the VpcConfigurationDescription property for this object.
    
    Returns:
    
    The value of the VpcConfigurationDescription 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 AmazonopensearchserviceDestinationDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AmazonopensearchserviceDestinationDescription.Builder,AmazonopensearchserviceDestinationDescription>
  - builder
```
public static AmazonopensearchserviceDestinationDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AmazonopensearchserviceDestinationDescription.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 AmazonopensearchserviceDestinationDescription

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

s3DestinationDescription

processingConfiguration

cloudWatchLoggingOptions

vpcConfigurationDescription

documentIdOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields