Interface HttpRetryPolicyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HttpRetryPolicy, HttpRetryPolicy.Builder

@Generated public interface HttpRetryPolicyOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    int
    Specifies the allowed number retries.
    Specifies a non-zero timeout per retry attempt.
    Specifies a non-zero timeout per retry attempt.
    getRetryConditions(int index)
    Specifies one or more conditions when this retry policy applies.
    com.google.protobuf.ByteString
    Specifies one or more conditions when this retry policy applies.
    int
    Specifies one or more conditions when this retry policy applies.
    Specifies one or more conditions when this retry policy applies.
    boolean
    Specifies the allowed number retries.
    boolean
    Specifies a non-zero timeout per retry attempt.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • hasNumRetries

      boolean hasNumRetries()
       Specifies the allowed number retries. This number must be > 0.
       If not specified, defaults to 1.
       
      optional uint32 num_retries = 251680141;
      Returns:
      Whether the numRetries field is set.
    • getNumRetries

      int getNumRetries()
       Specifies the allowed number retries. This number must be > 0.
       If not specified, defaults to 1.
       
      optional uint32 num_retries = 251680141;
      Returns:
      The numRetries.
    • hasPerTryTimeout

      boolean hasPerTryTimeout()
       Specifies a non-zero timeout per retry attempt.
      
       If not specified, will use the timeout set in theHttpRouteAction field.
       If timeout in the HttpRouteAction field is not set, this field
       uses the largest timeout
       among all backend services associated with the route.
      
       Not supported when the URL map is bound to a target gRPC proxy that
       has the validateForProxyless field set to true.
       
      optional .google.cloud.compute.v1.Duration per_try_timeout = 280041147;
      Returns:
      Whether the perTryTimeout field is set.
    • getPerTryTimeout

      Duration getPerTryTimeout()
       Specifies a non-zero timeout per retry attempt.
      
       If not specified, will use the timeout set in theHttpRouteAction field.
       If timeout in the HttpRouteAction field is not set, this field
       uses the largest timeout
       among all backend services associated with the route.
      
       Not supported when the URL map is bound to a target gRPC proxy that
       has the validateForProxyless field set to true.
       
      optional .google.cloud.compute.v1.Duration per_try_timeout = 280041147;
      Returns:
      The perTryTimeout.
    • getPerTryTimeoutOrBuilder

      DurationOrBuilder getPerTryTimeoutOrBuilder()
       Specifies a non-zero timeout per retry attempt.
      
       If not specified, will use the timeout set in theHttpRouteAction field.
       If timeout in the HttpRouteAction field is not set, this field
       uses the largest timeout
       among all backend services associated with the route.
      
       Not supported when the URL map is bound to a target gRPC proxy that
       has the validateForProxyless field set to true.
       
      optional .google.cloud.compute.v1.Duration per_try_timeout = 280041147;
    • getRetryConditionsList

      List<String> getRetryConditionsList()
       Specifies one or more conditions when this retry policy applies. Valid
       values are:
      
       - 5xx: retry is attempted if the instance or endpoint
       responds with any 5xx response code, or if the instance or
       endpoint does not respond at all. For example, disconnects, reset, read
       timeout, connection failure, and refused streams.
       - gateway-error: Similar to 5xx, but only
       applies to response codes 502, 503 or504.
       - connect-failure: a retry is attempted on failures
       connecting to the instance or endpoint. For example, connection
       timeouts.
       - retriable-4xx: a retry is attempted if the instance
       or endpoint responds with a 4xx response code.
       The only error that you can retry is error code 409.
       - refused-stream: a retry is attempted if the instance
       or endpoint resets the stream with a REFUSED_STREAM error
       code. This reset type indicates that it is safe to retry.
       - cancelled: a retry is attempted if the gRPC status
       code in the response header is set to cancelled.
       - deadline-exceeded: a retry is attempted if the gRPC
       status code in the response header is set todeadline-exceeded.
       - internal: a retry is attempted if the gRPC
       status code in the response header is set tointernal.
       - resource-exhausted: a retry is attempted if the gRPC
       status code in the response header is set toresource-exhausted.
       - unavailable: a retry is attempted if the gRPC
       status code in the response header is set tounavailable.
      
       Only the following codes are supported when the URL map is bound to
       target gRPC proxy that has validateForProxyless field set to true.
      
       - cancelled
       - deadline-exceeded
       - internal
       - resource-exhausted
       - unavailable
       
      repeated string retry_conditions = 28815535;
      Returns:
      A list containing the retryConditions.
    • getRetryConditionsCount

      int getRetryConditionsCount()
       Specifies one or more conditions when this retry policy applies. Valid
       values are:
      
       - 5xx: retry is attempted if the instance or endpoint
       responds with any 5xx response code, or if the instance or
       endpoint does not respond at all. For example, disconnects, reset, read
       timeout, connection failure, and refused streams.
       - gateway-error: Similar to 5xx, but only
       applies to response codes 502, 503 or504.
       - connect-failure: a retry is attempted on failures
       connecting to the instance or endpoint. For example, connection
       timeouts.
       - retriable-4xx: a retry is attempted if the instance
       or endpoint responds with a 4xx response code.
       The only error that you can retry is error code 409.
       - refused-stream: a retry is attempted if the instance
       or endpoint resets the stream with a REFUSED_STREAM error
       code. This reset type indicates that it is safe to retry.
       - cancelled: a retry is attempted if the gRPC status
       code in the response header is set to cancelled.
       - deadline-exceeded: a retry is attempted if the gRPC
       status code in the response header is set todeadline-exceeded.
       - internal: a retry is attempted if the gRPC
       status code in the response header is set tointernal.
       - resource-exhausted: a retry is attempted if the gRPC
       status code in the response header is set toresource-exhausted.
       - unavailable: a retry is attempted if the gRPC
       status code in the response header is set tounavailable.
      
       Only the following codes are supported when the URL map is bound to
       target gRPC proxy that has validateForProxyless field set to true.
      
       - cancelled
       - deadline-exceeded
       - internal
       - resource-exhausted
       - unavailable
       
      repeated string retry_conditions = 28815535;
      Returns:
      The count of retryConditions.
    • getRetryConditions

      String getRetryConditions(int index)
       Specifies one or more conditions when this retry policy applies. Valid
       values are:
      
       - 5xx: retry is attempted if the instance or endpoint
       responds with any 5xx response code, or if the instance or
       endpoint does not respond at all. For example, disconnects, reset, read
       timeout, connection failure, and refused streams.
       - gateway-error: Similar to 5xx, but only
       applies to response codes 502, 503 or504.
       - connect-failure: a retry is attempted on failures
       connecting to the instance or endpoint. For example, connection
       timeouts.
       - retriable-4xx: a retry is attempted if the instance
       or endpoint responds with a 4xx response code.
       The only error that you can retry is error code 409.
       - refused-stream: a retry is attempted if the instance
       or endpoint resets the stream with a REFUSED_STREAM error
       code. This reset type indicates that it is safe to retry.
       - cancelled: a retry is attempted if the gRPC status
       code in the response header is set to cancelled.
       - deadline-exceeded: a retry is attempted if the gRPC
       status code in the response header is set todeadline-exceeded.
       - internal: a retry is attempted if the gRPC
       status code in the response header is set tointernal.
       - resource-exhausted: a retry is attempted if the gRPC
       status code in the response header is set toresource-exhausted.
       - unavailable: a retry is attempted if the gRPC
       status code in the response header is set tounavailable.
      
       Only the following codes are supported when the URL map is bound to
       target gRPC proxy that has validateForProxyless field set to true.
      
       - cancelled
       - deadline-exceeded
       - internal
       - resource-exhausted
       - unavailable
       
      repeated string retry_conditions = 28815535;
      Parameters:
      index - The index of the element to return.
      Returns:
      The retryConditions at the given index.
    • getRetryConditionsBytes

      com.google.protobuf.ByteString getRetryConditionsBytes(int index)
       Specifies one or more conditions when this retry policy applies. Valid
       values are:
      
       - 5xx: retry is attempted if the instance or endpoint
       responds with any 5xx response code, or if the instance or
       endpoint does not respond at all. For example, disconnects, reset, read
       timeout, connection failure, and refused streams.
       - gateway-error: Similar to 5xx, but only
       applies to response codes 502, 503 or504.
       - connect-failure: a retry is attempted on failures
       connecting to the instance or endpoint. For example, connection
       timeouts.
       - retriable-4xx: a retry is attempted if the instance
       or endpoint responds with a 4xx response code.
       The only error that you can retry is error code 409.
       - refused-stream: a retry is attempted if the instance
       or endpoint resets the stream with a REFUSED_STREAM error
       code. This reset type indicates that it is safe to retry.
       - cancelled: a retry is attempted if the gRPC status
       code in the response header is set to cancelled.
       - deadline-exceeded: a retry is attempted if the gRPC
       status code in the response header is set todeadline-exceeded.
       - internal: a retry is attempted if the gRPC
       status code in the response header is set tointernal.
       - resource-exhausted: a retry is attempted if the gRPC
       status code in the response header is set toresource-exhausted.
       - unavailable: a retry is attempted if the gRPC
       status code in the response header is set tounavailable.
      
       Only the following codes are supported when the URL map is bound to
       target gRPC proxy that has validateForProxyless field set to true.
      
       - cancelled
       - deadline-exceeded
       - internal
       - resource-exhausted
       - unavailable
       
      repeated string retry_conditions = 28815535;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the retryConditions at the given index.