File Coverage

blib/lib/Paws/CloudDirectory/CreateIndex.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::CreateIndex;
3 1     1   412 use Moose;
  1         3  
  1         8  
4             has DirectoryArn => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-data-partition', required => 1);
5             has IsUnique => (is => 'ro', isa => 'Bool', required => 1);
6             has LinkName => (is => 'ro', isa => 'Str');
7             has OrderedIndexedAttributeList => (is => 'ro', isa => 'ArrayRef[Paws::CloudDirectory::AttributeKey]', required => 1);
8             has ParentReference => (is => 'ro', isa => 'Paws::CloudDirectory::ObjectReference');
9              
10 1     1   6136 use MooseX::ClassAttribute;
  1         3  
  1         9  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateIndex');
13             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/amazonclouddirectory/2017-01-11/index');
14             class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
15             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudDirectory::CreateIndexResponse');
16             class_has _result_key => (isa => 'Str', is => 'ro');
17             1;
18              
19             ### main pod documentation begin ###
20              
21             =head1 NAME
22              
23             Paws::CloudDirectory::CreateIndex - Arguments for method CreateIndex on Paws::CloudDirectory
24              
25             =head1 DESCRIPTION
26              
27             This class represents the parameters used for calling the method CreateIndex on the
28             Amazon CloudDirectory service. Use the attributes of this class
29             as arguments to method CreateIndex.
30              
31             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateIndex.
32              
33             As an example:
34              
35             $service_obj->CreateIndex(Att1 => $value1, Att2 => $value2, ...);
36              
37             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.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 B<REQUIRED> DirectoryArn => Str
43              
44             The ARN of the directory where the index should be created.
45              
46              
47              
48             =head2 B<REQUIRED> IsUnique => Bool
49              
50             Indicates whether the attribute that is being indexed has unique values
51             or not.
52              
53              
54              
55             =head2 LinkName => Str
56              
57             The name of the link between the parent object and the index object.
58              
59              
60              
61             =head2 B<REQUIRED> OrderedIndexedAttributeList => ArrayRef[L<Paws::CloudDirectory::AttributeKey>]
62              
63             Specifies the attributes that should be indexed on. Currently only a
64             single attribute is supported.
65              
66              
67              
68             =head2 ParentReference => L<Paws::CloudDirectory::ObjectReference>
69              
70             A reference to the parent object that contains the index object.
71              
72              
73              
74              
75             =head1 SEE ALSO
76              
77             This class forms part of L<Paws>, documenting arguments for method CreateIndex in L<Paws::CloudDirectory>
78              
79             =head1 BUGS and CONTRIBUTIONS
80              
81             The source code is located here: https://github.com/pplu/aws-sdk-perl
82              
83             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
84              
85             =cut
86