« blib/lib/Paws/CloudSearch/LiteralOptions.pm
↑ Summary
blib/lib/Paws/CloudSearch/ScalingParameters.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudSearch::OptionStatus; | ||
| 3 | use Moose; | ||
| 4 | has CreationDate => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has PendingDeletion => (is => 'ro', isa => 'Bool'); | ||
| 6 | has State => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has UpdateDate => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has UpdateVersion => (is => 'ro', isa => 'Int'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::CloudSearch::OptionStatus | ||
| 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::CloudSearch::OptionStatus object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { CreationDate => $value, ..., UpdateVersion => $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::CloudSearch::OptionStatus object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->CreationDate | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | The status of domain configuration option. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 B<REQUIRED> CreationDate => Str | ||
| 46 | |||
| 47 | A timestamp for when this option was created. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 PendingDeletion => Bool | ||
| 51 | |||
| 52 | Indicates that the option will be deleted once processing is complete. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 B<REQUIRED> State => Str | ||
| 56 | |||
| 57 | The state of processing a change to an option. Possible values: | ||
| 58 | |||
| 59 | =over | ||
| 60 | |||
| 61 | =item * C<RequiresIndexDocuments>: the option's latest value will not | ||
| 62 | be deployed until IndexDocuments has been called and indexing is | ||
| 63 | complete. | ||
| 64 | |||
| 65 | =item * C<Processing>: the option's latest value is in the process of | ||
| 66 | being activated. | ||
| 67 | |||
| 68 | =item * C<Active>: the option's latest value is completely deployed. | ||
| 69 | |||
| 70 | =item * C<FailedToValidate>: the option value is not compatible with | ||
| 71 | the domain's data and cannot be used to index the data. You must either | ||
| 72 | modify the option value or update or remove the incompatible documents. | ||
| 73 | |||
| 74 | =back | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 B<REQUIRED> UpdateDate => Str | ||
| 79 | |||
| 80 | A timestamp for when this option was last updated. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 UpdateVersion => Int | ||
| 84 | |||
| 85 | A unique integer that indicates when this option was last updated. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearch> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |