Package software.amazon.awssdk.services.firehose.model

Class ElasticsearchDestinationDescription

java.lang.Object

software.amazon.awssdk.services.firehose.model.ElasticsearchDestinationDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ElasticsearchDestinationDescription.Builder,ElasticsearchDestinationDescription>

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

The destination description in Amazon ES.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ElasticsearchDestinationDescription.Builder

Method Summary

Modifier and Type	Method	Description
final ElasticsearchBufferingHints	bufferingHints()	The buffering options.
static ElasticsearchDestinationDescription.Builder	builder()
final CloudWatchLoggingOptions	cloudWatchLoggingOptions()	The Amazon CloudWatch logging options.
final String	clusterEndpoint()	The endpoint to use when communicating with the cluster.
final DocumentIdOptions	documentIdOptions()	Indicates the method for setting up document ID.
final String	domainARN()	The ARN of the Amazon ES domain.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	indexName()	The Elasticsearch index name.
final ElasticsearchIndexRotationPeriod	indexRotationPeriod()	The Elasticsearch index rotation period
final String	indexRotationPeriodAsString()	The Elasticsearch index rotation period
final ProcessingConfiguration	processingConfiguration()	The data processing configuration.
final ElasticsearchRetryOptions	retryOptions()	The Amazon ES retry options.
final String	roleARN()	The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
final ElasticsearchS3BackupMode	s3BackupMode()	The Amazon S3 backup mode.
final String	s3BackupModeAsString()	The Amazon S3 backup mode.
final S3DestinationDescription	s3DestinationDescription()	The Amazon S3 destination.
final List<SdkField<?>>	sdkFields()
static Class<? extends ElasticsearchDestinationDescription.Builder>	serializableBuilderClass()
ElasticsearchDestinationDescription.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final String	typeName()	The Elasticsearch type name.
final VpcConfigurationDescription	vpcConfigurationDescription()	The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

roleARN

public final String roleARN()

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Returns:

The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

domainARN

public final String domainARN()

The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.

Returns:

The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.

clusterEndpoint

public final String clusterEndpoint()

The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.

Returns:

The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon ES.

indexName

public final String indexName()

The Elasticsearch index name.

Returns:

The Elasticsearch index name.

typeName

public final String typeName()

The Elasticsearch 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 Elasticsearch 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 ElasticsearchIndexRotationPeriod indexRotationPeriod()

The Elasticsearch index rotation period

If the service returns an enum value that is not available in the current SDK version, indexRotationPeriod will return ElasticsearchIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexRotationPeriodAsString().

Returns:

The Elasticsearch index rotation period

See Also:

• ElasticsearchIndexRotationPeriod

indexRotationPeriodAsString

public final String indexRotationPeriodAsString()

The Elasticsearch index rotation period

If the service returns an enum value that is not available in the current SDK version, indexRotationPeriod will return ElasticsearchIndexRotationPeriod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from indexRotationPeriodAsString().

Returns:

The Elasticsearch index rotation period

See Also:

• ElasticsearchIndexRotationPeriod

bufferingHints

public final ElasticsearchBufferingHints bufferingHints()

The buffering options.

Returns:

The buffering options.

retryOptions

public final ElasticsearchRetryOptions retryOptions()

The Amazon ES retry options.

Returns:

The Amazon ES retry options.

s3BackupMode

public final ElasticsearchS3BackupMode 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 ElasticsearchS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

Returns:

The Amazon S3 backup mode.

See Also:

• ElasticsearchS3BackupMode

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 ElasticsearchS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

Returns:

The Amazon S3 backup mode.

See Also:

• ElasticsearchS3BackupMode

s3DestinationDescription

public final S3DestinationDescription s3DestinationDescription()

The Amazon S3 destination.

Returns:

The Amazon S3 destination.

processingConfiguration

public final ProcessingConfiguration processingConfiguration()

The data processing configuration.

Returns:

The data processing configuration.

cloudWatchLoggingOptions

public final CloudWatchLoggingOptions cloudWatchLoggingOptions()

The Amazon CloudWatch logging options.

Returns:

The Amazon CloudWatch logging options.

vpcConfigurationDescription

public final VpcConfigurationDescription vpcConfigurationDescription()

The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.

Returns:

The details of the VPC of the Amazon OpenSearch or the Amazon OpenSearch Serverless destination.

documentIdOptions

public final DocumentIdOptions documentIdOptions()

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

Returns:

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

toBuilder

public ElasticsearchDestinationDescription.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ElasticsearchDestinationDescription.Builder,ElasticsearchDestinationDescription>

Returns:

a builder for type T

builder

public static ElasticsearchDestinationDescription.Builder builder()

serializableBuilderClass

public static Class<? extends ElasticsearchDestinationDescription.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.