Class HttpRetryPolicy

    • Method Detail

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

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)