ElasticsearchSettings (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.databasemigrationservice.model.ElasticsearchSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ElasticsearchSettings
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information that defines an OpenSearch endpoint.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ElasticsearchSettings()

Constructors
Constructor and Description
`ElasticsearchSettings()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ElasticsearchSettings`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getEndpointUri()` The endpoint for the OpenSearch cluster.
`Integer`	`getErrorRetryDuration()` The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
`Integer`	`getFullLoadErrorPercentage()` The maximum percentage of records that can fail to be written before a full load operation stops.
`String`	`getServiceAccessRoleArn()` The Amazon Resource Name (ARN) used by the service to access the IAM role.
`Boolean`	`getUseNewMappingType()` Set this option to `true` for DMS to migrate documentation using the documentation type `_doc`.
`int`	`hashCode()`
`Boolean`	`isUseNewMappingType()` Set this option to `true` for DMS to migrate documentation using the documentation type `_doc`.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEndpointUri(String endpointUri)` The endpoint for the OpenSearch cluster.
`void`	`setErrorRetryDuration(Integer errorRetryDuration)` The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
`void`	`setFullLoadErrorPercentage(Integer fullLoadErrorPercentage)` The maximum percentage of records that can fail to be written before a full load operation stops.
`void`	`setServiceAccessRoleArn(String serviceAccessRoleArn)` The Amazon Resource Name (ARN) used by the service to access the IAM role.
`void`	`setUseNewMappingType(Boolean useNewMappingType)` Set this option to `true` for DMS to migrate documentation using the documentation type `_doc`.
`String`	`toString()` Returns a string representation of this object.
`ElasticsearchSettings`	`withEndpointUri(String endpointUri)` The endpoint for the OpenSearch cluster.
`ElasticsearchSettings`	`withErrorRetryDuration(Integer errorRetryDuration)` The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
`ElasticsearchSettings`	`withFullLoadErrorPercentage(Integer fullLoadErrorPercentage)` The maximum percentage of records that can fail to be written before a full load operation stops.
`ElasticsearchSettings`	`withServiceAccessRoleArn(String serviceAccessRoleArn)` The Amazon Resource Name (ARN) used by the service to access the IAM role.
`ElasticsearchSettings`	`withUseNewMappingType(Boolean useNewMappingType)` Set this option to `true` for DMS to migrate documentation using the documentation type `_doc`.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ElasticsearchSettings
```
public ElasticsearchSettings()
```
- Method Detail
  - setServiceAccessRoleArn
```
public void setServiceAccessRoleArn(String serviceAccessRoleArn)
```
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
  - getServiceAccessRoleArn
```
public String getServiceAccessRoleArn()
```
    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.
  - withServiceAccessRoleArn
```
public ElasticsearchSettings withServiceAccessRoleArn(String serviceAccessRoleArn)
```
    The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) used by the service to access the IAM role. The role must allow the iam:PassRole action.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndpointUri
```
public void setEndpointUri(String endpointUri)
```
    The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.
    
    Parameters:
    
    endpointUri - The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.
  - getEndpointUri
```
public String getEndpointUri()
```
    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.
  - withEndpointUri
```
public ElasticsearchSettings withEndpointUri(String endpointUri)
```
    The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.
    
    Parameters:
    
    endpointUri - The endpoint for the OpenSearch cluster. DMS uses HTTPS if a transport protocol (http/https) is not specified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFullLoadErrorPercentage
```
public void setFullLoadErrorPercentage(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.
    
    Parameters:
    
    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.
  - getFullLoadErrorPercentage
```
public Integer getFullLoadErrorPercentage()
```
    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.
  - withFullLoadErrorPercentage
```
public ElasticsearchSettings withFullLoadErrorPercentage(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorRetryDuration
```
public void setErrorRetryDuration(Integer errorRetryDuration)
```
    The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
    
    Parameters:
    
    errorRetryDuration - The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
  - getErrorRetryDuration
```
public Integer getErrorRetryDuration()
```
    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.
  - withErrorRetryDuration
```
public ElasticsearchSettings withErrorRetryDuration(Integer errorRetryDuration)
```
    The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
    
    Parameters:
    
    errorRetryDuration - The maximum number of seconds for which DMS retries failed API requests to the OpenSearch cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUseNewMappingType
```
public void setUseNewMappingType(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.
    
    Parameters:
    
    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.
  - getUseNewMappingType
```
public Boolean getUseNewMappingType()
```
    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.
  - withUseNewMappingType
```
public ElasticsearchSettings withUseNewMappingType(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUseNewMappingType
```
public Boolean isUseNewMappingType()
```
    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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ElasticsearchSettings clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class ElasticsearchSettings

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ElasticsearchSettings

Method Detail

setServiceAccessRoleArn

getServiceAccessRoleArn

withServiceAccessRoleArn

setEndpointUri

getEndpointUri

withEndpointUri

setFullLoadErrorPercentage

getFullLoadErrorPercentage

withFullLoadErrorPercentage

setErrorRetryDuration

getErrorRetryDuration

withErrorRetryDuration

setUseNewMappingType

getUseNewMappingType

withUseNewMappingType

isUseNewMappingType

toString

equals

hashCode

clone

marshall