File Coverage

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