Package software.amazon.awssdk.services.appmesh.model

Class HttpRetryPolicy

java.lang.Object
software.amazon.awssdk.services.appmesh.model.HttpRetryPolicy
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HttpRetryPolicy.Builder,HttpRetryPolicy>
@Generated("software.amazon.awssdk:codegen") public final class HttpRetryPolicy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HttpRetryPolicy.Builder,HttpRetryPolicy>

An object that represents a retry policy. Specify at least one value for at least one of the types of RetryEvents, a value for maxRetries, and a value for perRetryTimeout. Both server-error and gateway-error under httpRetryEvents include the Envoy reset policy. For more information on the reset policy, see the Envoy documentation.

See Also:

  • Method Details

    • hasHttpRetryEvents

      public final boolean hasHttpRetryEvents()
      For responses, this returns true if the service returned a value for the HttpRetryEvents property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • httpRetryEvents

      public final List<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

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasHttpRetryEvents() method.

      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

    • maxRetries

      public final Long maxRetries()

      The maximum number of retry attempts.

      Returns:
      The maximum number of retry attempts.

    • perRetryTimeout

      public final Duration perRetryTimeout()

      The timeout for each retry attempt.

      Returns:
      The timeout for each retry attempt.

    • tcpRetryEvents

      public final List<TcpRetryPolicyEvent> tcpRetryEvents()

      Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTcpRetryEvents() method.

      Returns:
      Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

    • hasTcpRetryEvents

      public final boolean hasTcpRetryEvents()
      For responses, this returns true if the service returned a value for the TcpRetryEvents property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tcpRetryEventsAsStrings

      public final List<String> tcpRetryEventsAsStrings()

      Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTcpRetryEvents() method.

      Returns:
      Specify a valid value. The event occurs before any processing of a request has started and is encountered when the upstream is temporarily or permanently unavailable.

    • toBuilder

      public HttpRetryPolicy.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<HttpRetryPolicy.Builder,HttpRetryPolicy>
      Returns:
      a builder for type T

    • builder

      public static HttpRetryPolicy.Builder builder()

    • serializableBuilderClass

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