HttpRetryPolicy (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.appmesh.model.HttpRetryPolicy

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HttpRetryPolicy
extends Object
implements Serializable, Cloneable, StructuredPojo

An object that represents a retry policy.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

HttpRetryPolicy()

Constructors
Constructor and Description
`HttpRetryPolicy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpRetryPolicy`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getHttpRetryEvents()` Specify at least one of the following values.
`Long`	`getMaxRetries()` The maximum number of retry attempts.
`Duration`	`getPerRetryTimeout()` An object that represents the retry duration.
`List<String>`	`getTcpRetryEvents()` Specify a valid value.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setHttpRetryEvents(Collection<String> httpRetryEvents)` Specify at least one of the following values.
`void`	`setMaxRetries(Long maxRetries)` The maximum number of retry attempts.
`void`	`setPerRetryTimeout(Duration perRetryTimeout)` An object that represents the retry duration.
`void`	`setTcpRetryEvents(Collection<String> tcpRetryEvents)` Specify a valid value.
`String`	`toString()` Returns a string representation of this object.
`HttpRetryPolicy`	`withHttpRetryEvents(Collection<String> httpRetryEvents)` Specify at least one of the following values.
`HttpRetryPolicy`	`withHttpRetryEvents(String... httpRetryEvents)` Specify at least one of the following values.
`HttpRetryPolicy`	`withMaxRetries(Long maxRetries)` The maximum number of retry attempts.
`HttpRetryPolicy`	`withPerRetryTimeout(Duration perRetryTimeout)` An object that represents the retry duration.
`HttpRetryPolicy`	`withTcpRetryEvents(Collection<String> tcpRetryEvents)` Specify a valid value.
`HttpRetryPolicy`	`withTcpRetryEvents(String... tcpRetryEvents)` Specify a valid value.
`HttpRetryPolicy`	`withTcpRetryEvents(TcpRetryPolicyEvent... tcpRetryEvents)` Specify a valid value.

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

- Constructor Detail
  - HttpRetryPolicy
```
public HttpRetryPolicy()
```
- Method Detail
  - getHttpRetryEvents
```
public List<String> getHttpRetryEvents()
```
    Specify at least one of the following values.
    - server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
    - gateway-error – HTTP status codes 502, 503, and 504
    - client-error – HTTP status code 409
    - stream-error – Retry on refused stream
    Returns:
    Specify at least one of the following values.
    
    server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
    
    gateway-error – HTTP status codes 502, 503, and 504
    
    client-error – HTTP status code 409
    
    stream-error – Retry on refused stream
  - setHttpRetryEvents
```
public void setHttpRetryEvents(Collection<String> httpRetryEvents)
```
    Specify at least one of the following values.
    - server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
    - gateway-error – HTTP status codes 502, 503, and 504
    - client-error – HTTP status code 409
    - stream-error – Retry on refused stream
    Parameters:
    httpRetryEvents - Specify at least one of the following values.
    
    server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
    
    gateway-error – HTTP status codes 502, 503, and 504
    
    client-error – HTTP status code 409
    
    stream-error – Retry on refused stream
  - withHttpRetryEvents
```
public HttpRetryPolicy withHttpRetryEvents(String... httpRetryEvents)
```
    Specify at least one of the following values.
    - server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
    - gateway-error – HTTP status codes 502, 503, and 504
    - client-error – HTTP status code 409
    - stream-error – Retry on refused stream
    NOTE: This method appends the values to the existing list (if any). Use setHttpRetryEvents(java.util.Collection) or withHttpRetryEvents(java.util.Collection) if you want to override the existing values.
    Parameters:
    httpRetryEvents - Specify at least one of the following values.
    
    server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
    
    gateway-error – HTTP status codes 502, 503, and 504
    
    client-error – HTTP status code 409
    
    stream-error – Retry on refused stream
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withHttpRetryEvents
```
public HttpRetryPolicy withHttpRetryEvents(Collection<String> httpRetryEvents)
```
    Specify at least one of the following values.
    - server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
    - gateway-error – HTTP status codes 502, 503, and 504
    - client-error – HTTP status code 409
    - stream-error – Retry on refused stream
    Parameters:
    httpRetryEvents - Specify at least one of the following values.
    
    server-error – HTTP status codes 500, 501, 502, 503, 504, 505, 506, 507, 508, 510, and 511
    
    gateway-error – HTTP status codes 502, 503, and 504
    
    client-error – HTTP status code 409
    
    stream-error – Retry on refused stream
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxRetries
```
public void setMaxRetries(Long maxRetries)
```
    The maximum number of retry attempts. If no value is specified, the default is 1.
    
    Parameters:
    
    maxRetries - The maximum number of retry attempts. If no value is specified, the default is 1.
  - getMaxRetries
```
public Long getMaxRetries()
```
    The maximum number of retry attempts. If no value is specified, the default is 1.
    
    Returns:
    
    The maximum number of retry attempts. If no value is specified, the default is 1.
  - withMaxRetries
```
public HttpRetryPolicy withMaxRetries(Long maxRetries)
```
    The maximum number of retry attempts. If no value is specified, the default is 1.
    
    Parameters:
    
    maxRetries - The maximum number of retry attempts. If no value is specified, the default is 1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPerRetryTimeout
```
public void setPerRetryTimeout(Duration perRetryTimeout)
```
    An object that represents the retry duration.
    
    Parameters:
    
    perRetryTimeout - An object that represents the retry duration.
  - getPerRetryTimeout
```
public Duration getPerRetryTimeout()
```
    An object that represents the retry duration.
    
    Returns:
    
    An object that represents the retry duration.
  - withPerRetryTimeout
```
public HttpRetryPolicy withPerRetryTimeout(Duration perRetryTimeout)
```
    An object that represents the retry duration.
    
    Parameters:
    
    perRetryTimeout - An object that represents the retry duration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTcpRetryEvents
```
public List<String> getTcpRetryEvents()
```
    Specify a valid value.
    
    Returns:
    
    Specify a valid value.
    
    See Also:
    
    TcpRetryPolicyEvent
  - setTcpRetryEvents
```
public void setTcpRetryEvents(Collection<String> tcpRetryEvents)
```
    Specify a valid value.
    
    Parameters:
    
    tcpRetryEvents - Specify a valid value.
    
    See Also:
    
    TcpRetryPolicyEvent
  - withTcpRetryEvents
```
public HttpRetryPolicy withTcpRetryEvents(String... tcpRetryEvents)
```
    Specify a valid value.
    
    NOTE: This method appends the values to the existing list (if any). Use setTcpRetryEvents(java.util.Collection) or withTcpRetryEvents(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tcpRetryEvents - Specify a valid value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TcpRetryPolicyEvent
  - withTcpRetryEvents
```
public HttpRetryPolicy withTcpRetryEvents(Collection<String> tcpRetryEvents)
```
    Specify a valid value.
    
    Parameters:
    
    tcpRetryEvents - Specify a valid value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TcpRetryPolicyEvent
  - withTcpRetryEvents
```
public HttpRetryPolicy withTcpRetryEvents(TcpRetryPolicyEvent... tcpRetryEvents)
```
    Specify a valid value.
    
    Parameters:
    
    tcpRetryEvents - Specify a valid value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TcpRetryPolicyEvent
  - 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 HttpRetryPolicy 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 HttpRetryPolicy

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HttpRetryPolicy

Method Detail

getHttpRetryEvents

setHttpRetryEvents

withHttpRetryEvents

withHttpRetryEvents

setMaxRetries

getMaxRetries

withMaxRetries

setPerRetryTimeout

getPerRetryTimeout

withPerRetryTimeout

getTcpRetryEvents

setTcpRetryEvents

withTcpRetryEvents

withTcpRetryEvents

withTcpRetryEvents

toString

equals

hashCode

clone

marshall