File Coverage

blib/lib/Paws/CloudSearch/DescribeIndexFields.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CloudSearch::DescribeIndexFields;
3 1     1   533 use Moose;
  1         3  
  1         7  
4             has Deployed => (is => 'ro', isa => 'Bool');
5             has DomainName => (is => 'ro', isa => 'Str', required => 1);
6             has FieldNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7              
8 1     1   6682 use MooseX::ClassAttribute;
  1         3  
  1         8  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeIndexFields');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudSearch::DescribeIndexFieldsResponse');
12             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeIndexFieldsResult');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::CloudSearch::DescribeIndexFields - Arguments for method DescribeIndexFields on Paws::CloudSearch
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method DescribeIndexFields on the
24             Amazon CloudSearch service. Use the attributes of this class
25             as arguments to method DescribeIndexFields.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeIndexFields.
28              
29             As an example:
30              
31             $service_obj->DescribeIndexFields(Att1 => $value1, Att2 => $value2, ...);
32              
33             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 Deployed => Bool
39              
40             Whether to display the deployed configuration (C<true>) or include any
41             pending changes (C<false>). Defaults to C<false>.
42              
43              
44              
45             =head2 B<REQUIRED> DomainName => Str
46              
47             The name of the domain you want to describe.
48              
49              
50              
51             =head2 FieldNames => ArrayRef[Str|Undef]
52              
53             A list of the index fields you want to describe. If not specified,
54             information is returned for all configured index fields.
55              
56              
57              
58              
59             =head1 SEE ALSO
60              
61             This class forms part of L<Paws>, documenting arguments for method DescribeIndexFields in L<Paws::CloudSearch>
62              
63             =head1 BUGS and CONTRIBUTIONS
64              
65             The source code is located here: https://github.com/pplu/aws-sdk-perl
66              
67             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
68              
69             =cut
70