| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AppMesh::GrpcRetryPolicy; | ||
| 3 | use Moose; | ||
| 4 | has GrpcRetryEvents => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'grpcRetryEvents', traits => ['NameInRequest']); | ||
| 5 | has HttpRetryEvents => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'httpRetryEvents', traits => ['NameInRequest']); | ||
| 6 | has MaxRetries => (is => 'ro', isa => 'Int', request_name => 'maxRetries', traits => ['NameInRequest'], required => 1); | ||
| 7 | has PerRetryTimeout => (is => 'ro', isa => 'Paws::AppMesh::Duration', request_name => 'perRetryTimeout', traits => ['NameInRequest'], required => 1); | ||
| 8 | has TcpRetryEvents => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'tcpRetryEvents', traits => ['NameInRequest']); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::AppMesh::GrpcRetryPolicy | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::AppMesh::GrpcRetryPolicy object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { GrpcRetryEvents => $value, ..., TcpRetryEvents => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::AppMesh::GrpcRetryPolicy object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->GrpcRetryEvents | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | An object that represents a retry policy. Specify at least one value | ||
| 41 | for at least one of the types of C<RetryEvents>, a value for | ||
| 42 | C<maxRetries>, and a value for C<perRetryTimeout>. Both C<server-error> | ||
| 43 | and C<gateway-error> under C<httpRetryEvents> include the Envoy | ||
| 44 | C<reset> policy. For more information on the C<reset> policy, see the | ||
| 45 | Envoy documentation | ||
| 46 | (https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/router_filter#x-envoy-retry-on). | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 GrpcRetryEvents => ArrayRef[Str|Undef] | ||
| 52 | |||
| 53 | Specify at least one of the valid values. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 HttpRetryEvents => ArrayRef[Str|Undef] | ||
| 57 | |||
| 58 | Specify at least one of the following values. | ||
| 59 | |||
| 60 | =over | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | B<server-error> E<ndash> HTTP status codes 500, 501, 502, 503, 504, | ||
| 65 | 505, 506, 507, 508, 510, and 511 | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | B<gateway-error> E<ndash> HTTP status codes 502, 503, and 504 | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | B<client-error> E<ndash> HTTP status code 409 | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | B<stream-error> E<ndash> Retry on refused stream | ||
| 78 | |||
| 79 | =back | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head2 B<REQUIRED> MaxRetries => Int | ||
| 84 | |||
| 85 | The maximum number of retry attempts. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 B<REQUIRED> PerRetryTimeout => L<Paws::AppMesh::Duration> | ||
| 89 | |||
| 90 | The timeout for each retry attempt. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 TcpRetryEvents => ArrayRef[Str|Undef] | ||
| 94 | |||
| 95 | Specify a valid value. The event occurs before any processing of a | ||
| 96 | request has started and is encountered when the upstream is temporarily | ||
| 97 | or permanently unavailable. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, describing an object used in L<Paws::AppMesh> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |