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 Elasticsearch 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 Elasticsearch cluster.
`Integer`	`getErrorRetryDuration()` The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch 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 service to access the IAM role.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEndpointUri(String endpointUri)` The endpoint for the Elasticsearch cluster.
`void`	`setErrorRetryDuration(Integer errorRetryDuration)` The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch 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 service to access the IAM role.
`String`	`toString()` Returns a string representation of this object.
`ElasticsearchSettings`	`withEndpointUri(String endpointUri)` The endpoint for the Elasticsearch cluster.
`ElasticsearchSettings`	`withErrorRetryDuration(Integer errorRetryDuration)` The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch 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 service to access the IAM role.

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 service to access the IAM role.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) used by service to access the IAM role.
  - getServiceAccessRoleArn
```
public String getServiceAccessRoleArn()
```
    The Amazon Resource Name (ARN) used by service to access the IAM role.
    
    Returns:
    
    The Amazon Resource Name (ARN) used by service to access the IAM role.
  - withServiceAccessRoleArn
```
public ElasticsearchSettings withServiceAccessRoleArn(String serviceAccessRoleArn)
```
    The Amazon Resource Name (ARN) used by service to access the IAM role.
    
    Parameters:
    
    serviceAccessRoleArn - The Amazon Resource Name (ARN) used by service to access the IAM role.
    
    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 Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.
    
    Parameters:
    
    endpointUri - The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.
  - getEndpointUri
```
public String getEndpointUri()
```
    The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.
    
    Returns:
    
    The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.
  - withEndpointUri
```
public ElasticsearchSettings withEndpointUri(String endpointUri)
```
    The endpoint for the Elasticsearch cluster. AWS DMS uses HTTPS if a transport protocol (http/https) is not specified.
    
    Parameters:
    
    endpointUri - The endpoint for the Elasticsearch cluster. AWS 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. Elasticsearch 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. Elasticsearch 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. Elasticsearch 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. Elasticsearch 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. Elasticsearch 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. Elasticsearch 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 Elasticsearch cluster.
    
    Parameters:
    
    errorRetryDuration - The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
  - getErrorRetryDuration
```
public Integer getErrorRetryDuration()
```
    The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
    
    Returns:
    
    The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
  - withErrorRetryDuration
```
public ElasticsearchSettings withErrorRetryDuration(Integer errorRetryDuration)
```
    The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
    
    Parameters:
    
    errorRetryDuration - The maximum number of seconds for which DMS retries failed API requests to the Elasticsearch cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.

Did this page help you?

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

toString

equals

hashCode

clone

marshall