« blib/lib/Paws/CloudSearch/DomainNameMap.pm
↑ Summary
blib/lib/Paws/CloudSearch/DoubleArrayOptions.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CloudSearch::DomainStatus; | ||
| 3 | use Moose; | ||
| 4 | has ARN => (is => 'ro', isa => 'Str'); | ||
| 5 | has Created => (is => 'ro', isa => 'Bool'); | ||
| 6 | has Deleted => (is => 'ro', isa => 'Bool'); | ||
| 7 | has DocService => (is => 'ro', isa => 'Paws::CloudSearch::ServiceEndpoint'); | ||
| 8 | has DomainId => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has DomainName => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has Limits => (is => 'ro', isa => 'Paws::CloudSearch::Limits'); | ||
| 11 | has Processing => (is => 'ro', isa => 'Bool'); | ||
| 12 | has RequiresIndexDocuments => (is => 'ro', isa => 'Bool', required => 1); | ||
| 13 | has SearchInstanceCount => (is => 'ro', isa => 'Int'); | ||
| 14 | has SearchInstanceType => (is => 'ro', isa => 'Str'); | ||
| 15 | has SearchPartitionCount => (is => 'ro', isa => 'Int'); | ||
| 16 | has SearchService => (is => 'ro', isa => 'Paws::CloudSearch::ServiceEndpoint'); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::CloudSearch::DomainStatus | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::CloudSearch::DomainStatus object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { ARN => $value, ..., SearchService => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::CloudSearch::DomainStatus object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->ARN | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | The current status of the search domain. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 ARN => Str | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 Created => Bool | ||
| 59 | |||
| 60 | True if the search domain is created. It can take several minutes to | ||
| 61 | initialize a domain when CreateDomain is called. Newly created search | ||
| 62 | domains are returned from DescribeDomains with a false value for | ||
| 63 | Created until domain creation is complete. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 Deleted => Bool | ||
| 67 | |||
| 68 | True if the search domain has been deleted. The system must clean up | ||
| 69 | resources dedicated to the search domain when DeleteDomain is called. | ||
| 70 | Newly deleted search domains are returned from DescribeDomains with a | ||
| 71 | true value for IsDeleted for several minutes until resource cleanup is | ||
| 72 | complete. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 DocService => L<Paws::CloudSearch::ServiceEndpoint> | ||
| 76 | |||
| 77 | The service endpoint for updating documents in a search domain. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> DomainId => Str | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 B<REQUIRED> DomainName => Str | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 Limits => L<Paws::CloudSearch::Limits> | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head2 Processing => Bool | ||
| 96 | |||
| 97 | True if processing is being done to activate the current domain | ||
| 98 | configuration. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 B<REQUIRED> RequiresIndexDocuments => Bool | ||
| 102 | |||
| 103 | True if IndexDocuments needs to be called to activate the current | ||
| 104 | domain configuration. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 SearchInstanceCount => Int | ||
| 108 | |||
| 109 | The number of search instances that are available to process search | ||
| 110 | requests. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 SearchInstanceType => Str | ||
| 114 | |||
| 115 | The instance type that is being used to process search requests. | ||
| 116 | |||
| 117 | |||
| 118 | =head2 SearchPartitionCount => Int | ||
| 119 | |||
| 120 | The number of partitions across which the search index is spread. | ||
| 121 | |||
| 122 | |||
| 123 | =head2 SearchService => L<Paws::CloudSearch::ServiceEndpoint> | ||
| 124 | |||
| 125 | The service endpoint for requesting search results from a search | ||
| 126 | domain. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, describing an object used in L<Paws::CloudSearch> | ||
| 133 | |||
| 134 | =head1 BUGS and CONTRIBUTIONS | ||
| 135 | |||
| 136 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 137 | |||
| 138 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 139 | |||
| 140 | =cut | ||
| 141 |