File Coverage

blib/lib/Paws/CloudDirectory/BatchCreateIndex.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::CloudDirectory::BatchCreateIndex;
2 1     1   563 use Moose;
  1         4  
  1         8  
3             has BatchReferenceName => (is => 'ro', isa => 'Str');
4             has IsUnique => (is => 'ro', isa => 'Bool', required => 1);
5             has LinkName => (is => 'ro', isa => 'Str');
6             has OrderedIndexedAttributeList => (is => 'ro', isa => 'ArrayRef[Paws::CloudDirectory::AttributeKey]', required => 1);
7             has ParentReference => (is => 'ro', isa => 'Paws::CloudDirectory::ObjectReference');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::CloudDirectory::BatchCreateIndex
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::CloudDirectory::BatchCreateIndex object:
26              
27             $service_obj->Method(Att1 => { BatchReferenceName => $value, ..., ParentReference => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::CloudDirectory::BatchCreateIndex object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->BatchReferenceName
35              
36             =head1 DESCRIPTION
37              
38             Creates an index object inside of a BatchRead operation. For more
39             information, see CreateIndex and BatchReadRequest$Operations.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 BatchReferenceName => Str
45              
46             The batch reference name. See Batches for more information.
47              
48              
49             =head2 B<REQUIRED> IsUnique => Bool
50              
51             Indicates whether the attribute that is being indexed has unique values
52             or not.
53              
54              
55             =head2 LinkName => Str
56              
57             The name of the link between the parent object and the index object.
58              
59              
60             =head2 B<REQUIRED> OrderedIndexedAttributeList => ArrayRef[L<Paws::CloudDirectory::AttributeKey>]
61              
62             Specifies the attributes that should be indexed on. Currently only a
63             single attribute is supported.
64              
65              
66             =head2 ParentReference => L<Paws::CloudDirectory::ObjectReference>
67              
68             A reference to the parent object that contains the index object.
69              
70              
71              
72             =head1 SEE ALSO
73              
74             This class forms part of L<Paws>, describing an object used in L<Paws::CloudDirectory>
75              
76             =head1 BUGS and CONTRIBUTIONS
77              
78             The source code is located here: https://github.com/pplu/aws-sdk-perl
79              
80             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
81              
82             =cut
83