File Coverage

blib/lib/Paws/CloudDirectory/CreateFacet.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::CreateFacet;
3 1     1   370 use Moose;
  1         2  
  1         7  
4             has Attributes => (is => 'ro', isa => 'ArrayRef[Paws::CloudDirectory::FacetAttribute]');
5             has Name => (is => 'ro', isa => 'Str', required => 1);
6             has ObjectType => (is => 'ro', isa => 'Str', required => 1);
7             has SchemaArn => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-data-partition' , required => 1);
8              
9 1     1   5872 use MooseX::ClassAttribute;
  1         3  
  1         7  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateFacet');
12             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/amazonclouddirectory/2017-01-11/facet/create');
13             class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudDirectory::CreateFacetResponse');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::CloudDirectory::CreateFacet - Arguments for method CreateFacet on Paws::CloudDirectory
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method CreateFacet on the
27             Amazon CloudDirectory service. Use the attributes of this class
28             as arguments to method CreateFacet.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateFacet.
31              
32             As an example:
33              
34             $service_obj->CreateFacet(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 Attributes => ArrayRef[L<Paws::CloudDirectory::FacetAttribute>]
42              
43             The attributes that are associated with the Facet.
44              
45              
46              
47             =head2 B<REQUIRED> Name => Str
48              
49             The name of the Facet, which is unique for a given schema.
50              
51              
52              
53             =head2 B<REQUIRED> ObjectType => Str
54              
55             Specifies whether a given object created from this facet is of type
56             node, leaf node, policy or index.
57              
58             =over
59              
60             =item *
61              
62             Node: Can have multiple children but one parent.
63              
64             =back
65              
66             =over
67              
68             =item *
69              
70             Leaf node: Cannot have children but can have multiple parents.
71              
72             =back
73              
74             =over
75              
76             =item *
77              
78             Policy: Allows you to store a policy document and policy type. For more
79             information, see Policies.
80              
81             =back
82              
83             =over
84              
85             =item *
86              
87             Index: Can be created with the Index API.
88              
89             =back
90              
91              
92             Valid values are: C<"NODE">, C<"LEAF_NODE">, C<"POLICY">, C<"INDEX">
93              
94             =head2 B<REQUIRED> SchemaArn => Str
95              
96             The schema ARN in which the new Facet will be created. For more
97             information, see arns.
98              
99              
100              
101              
102             =head1 SEE ALSO
103              
104             This class forms part of L<Paws>, documenting arguments for method CreateFacet in L<Paws::CloudDirectory>
105              
106             =head1 BUGS and CONTRIBUTIONS
107              
108             The source code is located here: https://github.com/pplu/aws-sdk-perl
109              
110             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
111              
112             =cut
113