GrpcRetryPolicy (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.appmesh.model.GrpcRetryPolicy

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GrpcRetryPolicy.Builder,GrpcRetryPolicy>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class GrpcRetryPolicy
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GrpcRetryPolicy.Builder,GrpcRetryPolicy>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GrpcRetryPolicy.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GrpcRetryPolicy.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GrpcRetryPolicy.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`List<GrpcRetryPolicyEvent>`	`grpcRetryEvents()` Specify at least one of the valid values.
`List<String>`	`grpcRetryEventsAsStrings()` Specify at least one of the valid values.
`boolean`	`hasGrpcRetryEvents()` For responses, this returns true if the service returned a value for the GrpcRetryEvents property.
`int`	`hashCode()`
`boolean`	`hasHttpRetryEvents()` For responses, this returns true if the service returned a value for the HttpRetryEvents property.
`boolean`	`hasTcpRetryEvents()` For responses, this returns true if the service returned a value for the TcpRetryEvents property.
`List<String>`	`httpRetryEvents()` Specify at least one of the following values.
`Long`	`maxRetries()` The maximum number of retry attempts.
`Duration`	`perRetryTimeout()` The timeout for each retry attempt.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GrpcRetryPolicy.Builder>`	`serializableBuilderClass()`
`List<TcpRetryPolicyEvent>`	`tcpRetryEvents()` Specify a valid value.
`List<String>`	`tcpRetryEventsAsStrings()` Specify a valid value.
`GrpcRetryPolicy.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - grpcRetryEvents
```
public final List<GrpcRetryPolicyEvent> grpcRetryEvents()
```
    Specify at least one of the valid values.
    
    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 hasGrpcRetryEvents() method.
    
    Returns:
    
    Specify at least one of the valid values.
  - hasGrpcRetryEvents
```
public final boolean hasGrpcRetryEvents()
```
    For responses, this returns true if the service returned a value for the GrpcRetryEvents 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.
  - grpcRetryEventsAsStrings
```
public final List<String> grpcRetryEventsAsStrings()
```
    Specify at least one of the valid values.
    
    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 hasGrpcRetryEvents() method.
    
    Returns:
    
    Specify at least one of the valid values.
  - 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 GrpcRetryPolicy.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GrpcRetryPolicy.Builder,GrpcRetryPolicy>
  - builder
```
public static GrpcRetryPolicy.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GrpcRetryPolicy.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class GrpcRetryPolicy

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

grpcRetryEvents

hasGrpcRetryEvents

grpcRetryEventsAsStrings

hasHttpRetryEvents

httpRetryEvents

maxRetries

perRetryTimeout

tcpRetryEvents

hasTcpRetryEvents

tcpRetryEventsAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields