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(value="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 and Description
static interface	ElasticsearchDestinationDescription.Builder

Method Summary

Modifier and Type	Method and Description
ElasticsearchBufferingHints	bufferingHints() The buffering options.
static ElasticsearchDestinationDescription.Builder	builder()
CloudWatchLoggingOptions	cloudWatchLoggingOptions() The Amazon CloudWatch logging options.
String	domainARN() The ARN of the Amazon ES domain.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexName() The Elasticsearch index name.
ElasticsearchIndexRotationPeriod	indexRotationPeriod() The Elasticsearch index rotation period
String	indexRotationPeriodAsString() The Elasticsearch index rotation period
ProcessingConfiguration	processingConfiguration() The data processing configuration.
ElasticsearchRetryOptions	retryOptions() The Amazon ES retry options.
String	roleARN() The Amazon Resource Name (ARN) of the AWS credentials.
ElasticsearchS3BackupMode	s3BackupMode() The Amazon S3 backup mode.
String	s3BackupModeAsString() The Amazon S3 backup mode.
S3DestinationDescription	s3DestinationDescription() The Amazon S3 destination.
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.
String	toString()
String	typeName() The Elasticsearch type name.

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 Detail

roleARN

public String roleARN()

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

Returns:

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

domainARN

public String domainARN()

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

Returns:

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

indexName

public String indexName()

The Elasticsearch index name.

Returns:

The Elasticsearch index name.

typeName

public String typeName()

The Elasticsearch type name.

Returns:

The Elasticsearch type name.

indexRotationPeriod

public 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 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 ElasticsearchBufferingHints bufferingHints()

The buffering options.

Returns:

The buffering options.

retryOptions

public ElasticsearchRetryOptions retryOptions()

The Amazon ES retry options.

Returns:

The Amazon ES retry options.

s3BackupMode

public 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 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 S3DestinationDescription s3DestinationDescription()

The Amazon S3 destination.

Returns:

The Amazon S3 destination.

processingConfiguration

public ProcessingConfiguration processingConfiguration()

The data processing configuration.

Returns:

The data processing configuration.

cloudWatchLoggingOptions

public CloudWatchLoggingOptions cloudWatchLoggingOptions()

The Amazon CloudWatch logging options.

Returns:

The Amazon CloudWatch logging options.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.