File Coverage

blib/lib/Paws/CloudDirectory/ListIndex.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::CloudDirectory::ListIndex;
3 1     1   265 use Moose;
  1         2  
  1         6  
4             has ConsistencyLevel => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-consistency-level' );
5             has DirectoryArn => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-data-partition' , required => 1);
6             has IndexReference => (is => 'ro', isa => 'Paws::CloudDirectory::ObjectReference', required => 1);
7             has MaxResults => (is => 'ro', isa => 'Int');
8             has NextToken => (is => 'ro', isa => 'Str');
9             has RangesOnIndexedValues => (is => 'ro', isa => 'ArrayRef[Paws::CloudDirectory::ObjectAttributeRange]');
10              
11 1     1   5221 use MooseX::ClassAttribute;
  1         2  
  1         6  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListIndex');
14             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/amazonclouddirectory/2017-01-11/index/targets');
15             class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudDirectory::ListIndexResponse');
17             class_has _result_key => (isa => 'Str', is => 'ro');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::CloudDirectory::ListIndex - Arguments for method ListIndex on Paws::CloudDirectory
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method ListIndex on the
29             Amazon CloudDirectory service. Use the attributes of this class
30             as arguments to method ListIndex.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListIndex.
33              
34             As an example:
35              
36             $service_obj->ListIndex(Att1 => $value1, Att2 => $value2, ...);
37              
38             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.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 ConsistencyLevel => Str
44              
45             The consistency level to execute the request at.
46              
47             Valid values are: C<"SERIALIZABLE">, C<"EVENTUAL">
48              
49             =head2 B<REQUIRED> DirectoryArn => Str
50              
51             The ARN of the directory that the index exists in.
52              
53              
54              
55             =head2 B<REQUIRED> IndexReference => L<Paws::CloudDirectory::ObjectReference>
56              
57             The reference to the index to list.
58              
59              
60              
61             =head2 MaxResults => Int
62              
63             The maximum number of results to retrieve from the index.
64              
65              
66              
67             =head2 NextToken => Str
68              
69             The pagination token.
70              
71              
72              
73             =head2 RangesOnIndexedValues => ArrayRef[L<Paws::CloudDirectory::ObjectAttributeRange>]
74              
75             Specifies the ranges of indexed values that you want to query.
76              
77              
78              
79              
80             =head1 SEE ALSO
81              
82             This class forms part of L<Paws>, documenting arguments for method ListIndex in L<Paws::CloudDirectory>
83              
84             =head1 BUGS and CONTRIBUTIONS
85              
86             The source code is located here: https://github.com/pplu/aws-sdk-perl
87              
88             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
89              
90             =cut
91