File Coverage

blib/lib/Paws/CloudSearch/OptionStatus.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CloudSearch::OptionStatus;
2 1     1   285 use Moose;
  1         3  
  1         5  
3             has CreationDate => (is => 'ro', isa => 'Str', required => 1);
4             has PendingDeletion => (is => 'ro', isa => 'Bool');
5             has State => (is => 'ro', isa => 'Str', required => 1);
6             has UpdateDate => (is => 'ro', isa => 'Str', required => 1);
7             has UpdateVersion => (is => 'ro', isa => 'Int');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::CloudSearch::OptionStatus
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::CloudSearch::OptionStatus object:
26              
27             $service_obj->Method(Att1 => { CreationDate => $value, ..., UpdateVersion => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudSearch::OptionStatus object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->CreationDate
35              
36             =head1 DESCRIPTION
37              
38             The status of domain configuration option.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 B<REQUIRED> CreationDate => Str
44              
45             A timestamp for when this option was created.
46              
47              
48             =head2 PendingDeletion => Bool
49              
50             Indicates that the option will be deleted once processing is complete.
51              
52              
53             =head2 B<REQUIRED> State => Str
54              
55             The state of processing a change to an option. Possible values:
56              
57             =over
58              
59             =item * C<RequiresIndexDocuments>: the option's latest value will not
60             be deployed until IndexDocuments has been called and indexing is
61             complete.
62              
63             =item * C<Processing>: the option's latest value is in the process of
64             being activated.
65              
66             =item * C<Active>: the option's latest value is completely deployed.
67              
68             =item * C<FailedToValidate>: the option value is not compatible with
69             the domain's data and cannot be used to index the data. You must either
70             modify the option value or update or remove the incompatible documents.
71              
72             =back
73              
74              
75              
76             =head2 B<REQUIRED> UpdateDate => Str
77              
78             A timestamp for when this option was last updated.
79              
80              
81             =head2 UpdateVersion => Int
82              
83             A unique integer that indicates when this option was last updated.
84              
85              
86              
87             =head1 SEE ALSO
88              
89             This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearch>
90              
91             =head1 BUGS and CONTRIBUTIONS
92              
93             The source code is located here: https://github.com/pplu/aws-sdk-perl
94              
95             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
96              
97             =cut
98