software.amazon.awssdk.services.databasemigration.model

Class ElasticsearchSettings

java.lang.Object

software.amazon.awssdk.services.databasemigration.model.ElasticsearchSettings

All Implemented Interfaces:

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

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

Provides information that defines an OpenSearch endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ElasticsearchSettings.Builder

Method Summary

Modifier and Type	Method and Description
static ElasticsearchSettings.Builder	builder()
String	endpointUri() The endpoint for the OpenSearch cluster.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	errorRetryDuration() The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
Integer	fullLoadErrorPercentage() The maximum percentage of records that can fail to be written before a full load operation stops.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ElasticsearchSettings.Builder>	serializableBuilderClass()
String	serviceAccessRoleArn() The Amazon Resource Name (ARN) used by the service to access the IAM role.
ElasticsearchSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	useNewMappingType() Set this option to true for DMS to migrate documentation using the documentation type _doc.

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

serviceAccessRoleArn

public final String serviceAccessRoleArn()

The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

Returns:

The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.

endpointUri

public final String endpointUri()

The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.

Returns:

The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.

fullLoadErrorPercentage

public final Integer fullLoadErrorPercentage()

The maximum percentage of records that can fail to be written before a full load operation stops.

To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.

Returns:

The maximum percentage of records that can fail to be written before a full load operation stops.

To avoid early failure, this counter is only effective after 1000 records are transferred. OpenSearch also has the concept of error monitoring during the last 10 minutes of an Observation Window. If transfer of all records fail in the last 10 minutes, the full load operation stops.

errorRetryDuration

public final Integer errorRetryDuration()

The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.

Returns:

The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.

useNewMappingType

public final Boolean useNewMappingType()

Set this option to true for DMS to migrate documentation using the documentation type _doc. OpenSearch and an Elasticsearch cluster only support the _doc documentation type in versions 7. x and later. The default value is false.

Returns:

Set this option to true for DMS to migrate documentation using the documentation type _doc. OpenSearch and an Elasticsearch cluster only support the _doc documentation type in versions 7. x and later. The default value is false.

toBuilder

public ElasticsearchSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ElasticsearchSettings.Builder,ElasticsearchSettings>

builder

public static ElasticsearchSettings.Builder builder()

serializableBuilderClass

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