Class GrpcRetryPolicy
- java.lang.Object
-
- software.amazon.awssdk.services.appmesh.model.GrpcRetryPolicy
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<GrpcRetryPolicy.Builder,GrpcRetryPolicy>
@Generated("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 formaxRetries, and a value forperRetryTimeout. Bothserver-errorandgateway-errorunderhttpRetryEventsinclude the Envoyresetpolicy. For more information on theresetpolicy, see the Envoy documentation.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGrpcRetryPolicy.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GrpcRetryPolicy.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(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.booleanhasGrpcRetryEvents()For responses, this returns true if the service returned a value for the GrpcRetryEvents property.inthashCode()booleanhasHttpRetryEvents()For responses, this returns true if the service returned a value for the HttpRetryEvents property.booleanhasTcpRetryEvents()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.LongmaxRetries()The maximum number of retry attempts.DurationperRetryTimeout()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.BuildertoBuilder()StringtoString()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 theisEmpty()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 theisEmpty()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 theisEmpty()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:
toBuilderin interfaceToCopyableBuilder<GrpcRetryPolicy.Builder,GrpcRetryPolicy>
-
builder
public static GrpcRetryPolicy.Builder builder()
-
serializableBuilderClass
public static Class<? extends GrpcRetryPolicy.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-