blib/lib/Paws/CloudDirectory/ListIndex.pm untested

filter: Statementstmt 0.0% 0 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 20 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::CloudDirectory::ListIndex;
3 use Moose;
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 use MooseX::ClassAttribute;
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 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::CloudDirectory::ListIndex - Arguments for method ListIndex on L<Paws::CloudDirectory>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method ListIndex on the
28 L<Amazon CloudDirectory|Paws::CloudDirectory> service. Use the attributes of this class
29 as arguments to method ListIndex.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListIndex.
32  
33 =head1 SYNOPSIS
34  
35 my $clouddirectory = Paws->service('CloudDirectory');
36 my $ListIndexResponse = $clouddirectory->ListIndex(
37 DirectoryArn => 'MyArn',
38 IndexReference => {
39 Selector => 'MySelectorObjectReference', # OPTIONAL
40 },
41 ConsistencyLevel => 'SERIALIZABLE', # OPTIONAL
42 MaxResults => 1, # OPTIONAL
43 NextToken => 'MyNextToken', # OPTIONAL
44 RangesOnIndexedValues => [
45 {
46 AttributeKey => {
47 FacetName => 'MyFacetName', # min: 1, max: 64
48 Name => 'MyAttributeName', # min: 1, max: 230
49 SchemaArn => 'MyArn',
50  
51 }, # OPTIONAL
52 Range => {
53 EndMode => 'FIRST'
54 , # values: FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
55 StartMode => 'FIRST'
56 , # values: FIRST, LAST, LAST_BEFORE_MISSING_VALUES, INCLUSIVE, EXCLUSIVE
57 EndValue => {
58 BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL
59 BooleanValue => 1, # OPTIONAL
60 DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL
61 NumberValue => 'MyNumberAttributeValue', # OPTIONAL
62 StringValue => 'MyStringAttributeValue', # OPTIONAL
63 }, # OPTIONAL
64 StartValue => {
65 BinaryValue => 'BlobBinaryAttributeValue', # OPTIONAL
66 BooleanValue => 1, # OPTIONAL
67 DatetimeValue => '1970-01-01T01:00:00', # OPTIONAL
68 NumberValue => 'MyNumberAttributeValue', # OPTIONAL
69 StringValue => 'MyStringAttributeValue', # OPTIONAL
70 }, # OPTIONAL
71 }, # OPTIONAL
72 },
73 ...
74 ], # OPTIONAL
75 );
76  
77 # Results:
78 my $IndexAttachments = $ListIndexResponse->IndexAttachments;
79 my $NextToken = $ListIndexResponse->NextToken;
80  
81 # Returns a L<Paws::CloudDirectory::ListIndexResponse> object.
82  
83 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.
84 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/clouddirectory/ListIndex>
85  
86 =head1 ATTRIBUTES
87  
88  
89 =head2 ConsistencyLevel => Str
90  
91 The consistency level to execute the request at.
92  
93 Valid values are: C<"SERIALIZABLE">, C<"EVENTUAL">
94  
95 =head2 B<REQUIRED> DirectoryArn => Str
96  
97 The ARN of the directory that the index exists in.
98  
99  
100  
101 =head2 B<REQUIRED> IndexReference => L<Paws::CloudDirectory::ObjectReference>
102  
103 The reference to the index to list.
104  
105  
106  
107 =head2 MaxResults => Int
108  
109 The maximum number of objects in a single page to retrieve from the
110 index during a request. For more information, see Amazon Cloud
111 Directory Limits
112 (http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html).
113  
114  
115  
116 =head2 NextToken => Str
117  
118 The pagination token.
119  
120  
121  
122 =head2 RangesOnIndexedValues => ArrayRef[L<Paws::CloudDirectory::ObjectAttributeRange>]
123  
124 Specifies the ranges of indexed values that you want to query.
125  
126  
127  
128  
129 =head1 SEE ALSO
130  
131 This class forms part of L<Paws>, documenting arguments for method ListIndex in L<Paws::CloudDirectory>
132  
133 =head1 BUGS and CONTRIBUTIONS
134  
135 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
136  
137 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
138  
139 =cut
140