blib/lib/Paws/IoTThingsGraph/SearchEntities.pm untested

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 21 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::IoTThingsGraph::SearchEntities;
3 use Moose;
4 has EntityTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'entityTypes' , required => 1);
5 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::IoTThingsGraph::EntityFilter]', traits => ['NameInRequest'], request_name => 'filters' );
6 has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' );
7 has NamespaceVersion => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'namespaceVersion' );
8 has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
9  
10 use MooseX::ClassAttribute;
11  
12 class_has _api_call => (isa => 'Str', is => 'ro', default => 'SearchEntities');
13 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoTThingsGraph::SearchEntitiesResponse');
14 class_has _result_key => (isa => 'Str', is => 'ro');
15 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::IoTThingsGraph::SearchEntities - Arguments for method SearchEntities on L<Paws::IoTThingsGraph>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method SearchEntities on the
26 L<AWS IoT Things Graph|Paws::IoTThingsGraph> service. Use the attributes of this class
27 as arguments to method SearchEntities.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SearchEntities.
30  
31 =head1 SYNOPSIS
32  
33 my $iotthingsgraph = Paws->service('IoTThingsGraph');
34 my $SearchEntitiesResponse = $iotthingsgraph->SearchEntities(
35 EntityTypes => [
36 'DEVICE',
37 ... # values: DEVICE, SERVICE, DEVICE_MODEL, CAPABILITY, STATE, ACTION, EVENT, PROPERTY, MAPPING, ENUM
38 ],
39 Filters => [
40 {
41 Name => 'NAME'
42 , # values: NAME, NAMESPACE, SEMANTIC_TYPE_PATH, REFERENCED_ENTITY_ID; OPTIONAL
43 Value => [ 'MyEntityFilterValue', ... ], # OPTIONAL
44 },
45 ...
46 ], # OPTIONAL
47 MaxResults => 1, # OPTIONAL
48 NamespaceVersion => 1, # OPTIONAL
49 NextToken => 'MyNextToken', # OPTIONAL
50 );
51  
52 # Results:
53 my $Descriptions = $SearchEntitiesResponse->Descriptions;
54 my $NextToken = $SearchEntitiesResponse->NextToken;
55  
56 # Returns a L<Paws::IoTThingsGraph::SearchEntitiesResponse> object.
57  
58 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.
59 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/iotthingsgraph/SearchEntities>
60  
61 =head1 ATTRIBUTES
62  
63  
64 =head2 B<REQUIRED> EntityTypes => ArrayRef[Str|Undef]
65  
66 The entity types for which to search.
67  
68  
69  
70 =head2 Filters => ArrayRef[L<Paws::IoTThingsGraph::EntityFilter>]
71  
72 Optional filter to apply to the search. Valid filters are C<NAME>
73 C<NAMESPACE>, C<SEMANTIC_TYPE_PATH> and C<REFERENCED_ENTITY_ID>.
74 C<REFERENCED_ENTITY_ID> filters on entities that are used by the entity
75 in the result set. For example, you can filter on the ID of a property
76 that is used in a state.
77  
78 Multiple filters function as OR criteria in the query. Multiple values
79 passed inside the filter function as AND criteria.
80  
81  
82  
83 =head2 MaxResults => Int
84  
85 The maximum number of results to return in the response.
86  
87  
88  
89 =head2 NamespaceVersion => Int
90  
91 The version of the user's namespace. Defaults to the latest version of
92 the user's namespace.
93  
94  
95  
96 =head2 NextToken => Str
97  
98 The string that specifies the next page of results. Use this when
99 you're paginating results.
100  
101  
102  
103  
104 =head1 SEE ALSO
105  
106 This class forms part of L<Paws>, documenting arguments for method SearchEntities in L<Paws::IoTThingsGraph>
107  
108 =head1 BUGS and CONTRIBUTIONS
109  
110 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
111  
112 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
113  
114 =cut
115