Package 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("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:

  • Method Details

    • 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()
      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<ElasticsearchSettings.Builder,ElasticsearchSettings>
      Returns:
      a builder for type T

    • 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)
      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.