blib/lib/Paws/KinesisAnalyticsV2/CheckpointConfiguration.pm untested

filter: Statementstmt 0.0% 0 / 7 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 8 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::KinesisAnalyticsV2::CheckpointConfiguration;
3 use Moose;
4 has CheckpointingEnabled => (is => 'ro', isa => 'Bool');
5 has CheckpointInterval => (is => 'ro', isa => 'Int');
6 has ConfigurationType => (is => 'ro', isa => 'Str', required => 1);
7 has MinPauseBetweenCheckpoints => (is => 'ro', isa => 'Int');
8  
9 1;
10  
11 ### main pod documentation begin ###
12  
13 =head1 NAME
14  
15 Paws::KinesisAnalyticsV2::CheckpointConfiguration
16  
17 =head1 USAGE
18  
19 This class represents one of two things:
20  
21 =head3 Arguments in a call to a service
22  
23 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24 Each attribute should be used as a named argument in the calls that expect this type of object.
25  
26 As an example, if Att1 is expected to be a Paws::KinesisAnalyticsV2::CheckpointConfiguration object:
27  
28 $service_obj->Method(Att1 => { CheckpointingEnabled => $value, ..., MinPauseBetweenCheckpoints => $value });
29  
30 =head3 Results returned from an API call
31  
32 Use accessors for each attribute. If Att1 is expected to be an Paws::KinesisAnalyticsV2::CheckpointConfiguration object:
33  
34 $result = $service_obj->Method(...);
35 $result->Att1->CheckpointingEnabled
36  
37 =head1 DESCRIPTION
38  
39 Describes an application's checkpointing configuration. Checkpointing
40 is the process of persisting application state for fault tolerance. For
41 more information, see Checkpoints for Fault Tolerance
42 (https://ci.apache.org/projects/flink/flink-docs-release-1.8/concepts/programming-model.html#checkpoints-for-fault-tolerance)
43 in the Apache Flink Documentation
44 (https://ci.apache.org/projects/flink/flink-docs-release-1.8/).
45  
46 =head1 ATTRIBUTES
47  
48  
49 =head2 CheckpointingEnabled => Bool
50  
51 Describes whether checkpointing is enabled for a Flink-based Kinesis
52 Data Analytics application.
53  
54 If C<CheckpointConfiguration.ConfigurationType> is C<DEFAULT>, the
55 application will use a C<CheckpointingEnabled> value of C<true>, even
56 if this value is set to another value using this API or in application
57 code.
58  
59  
60 =head2 CheckpointInterval => Int
61  
62 Describes the interval in milliseconds between checkpoint operations.
63  
64 If C<CheckpointConfiguration.ConfigurationType> is C<DEFAULT>, the
65 application will use a C<CheckpointInterval> value of 60000, even if
66 this value is set to another value using this API or in application
67 code.
68  
69  
70 =head2 B<REQUIRED> ConfigurationType => Str
71  
72 Describes whether the application uses Kinesis Data Analytics' default
73 checkpointing behavior. You must set this property to C<CUSTOM> in
74 order to set the C<CheckpointingEnabled>, C<CheckpointInterval>, or
75 C<MinPauseBetweenCheckpoints> parameters.
76  
77 If this value is set to C<DEFAULT>, the application will use the
78 following values, even if they are set to other values using APIs or
79 application code:
80  
81 =over
82  
83 =item *
84  
85 B<CheckpointingEnabled:> true
86  
87 =item *
88  
89 B<CheckpointInterval:> 60000
90  
91 =item *
92  
93 B<MinPauseBetweenCheckpoints:> 5000
94  
95 =back
96  
97  
98  
99 =head2 MinPauseBetweenCheckpoints => Int
100  
101 Describes the minimum time in milliseconds after a checkpoint operation
102 completes that a new checkpoint operation can start. If a checkpoint
103 operation takes longer than the C<CheckpointInterval>, the application
104 otherwise performs continual checkpoint operations. For more
105 information, see Tuning Checkpointing
106 (https://ci.apache.org/projects/flink/flink-docs-release-1.8/ops/state/large_state_tuning.html#tuning-checkpointing)
107 in the Apache Flink Documentation
108 (https://ci.apache.org/projects/flink/flink-docs-release-1.8/).
109  
110 If C<CheckpointConfiguration.ConfigurationType> is C<DEFAULT>, the
111 application will use a C<MinPauseBetweenCheckpoints> value of 5000,
112 even if this value is set using this API or in application code.
113  
114  
115  
116 =head1 SEE ALSO
117  
118 This class forms part of L<Paws>, describing an object used in L<Paws::KinesisAnalyticsV2>
119  
120 =head1 BUGS and CONTRIBUTIONS
121  
122 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
123  
124 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
125  
126 =cut
127