blib/lib/Paws/CloudWatchLogs/GetLogEvents.pm

filter: Statementstmt 100% 17 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 19 / 19 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/CloudWatchLogs/FilteredLogEvent.pm ↑ Summary blib/lib/Paws/CloudWatchLogs/GetLogEventsResponse.pm »
1  
2 package Paws::CloudWatchLogs::GetLogEvents;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has EndTime => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'endTime' );
5 1 has Limit => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'limit' );
6 1 has LogGroupName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'logGroupName' , required => 1);
7 1 has LogStreamName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'logStreamName' , required => 1);
8 1 has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
9 1 has StartFromHead => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'startFromHead' );
10 1 has StartTime => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'startTime' );
11  
12 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
13  
14 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetLogEvents');
15 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatchLogs::GetLogEventsResponse');
16 1 class_has _result_key => (isa => 'Str', is => 'ro');
17 1 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::CloudWatchLogs::GetLogEvents - Arguments for method GetLogEvents on L<Paws::CloudWatchLogs>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method GetLogEvents on the
28 L<Amazon CloudWatch Logs|Paws::CloudWatchLogs> service. Use the attributes of this class
29 as arguments to method GetLogEvents.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetLogEvents.
32  
33 =head1 SYNOPSIS
34  
35 my $logs = Paws->service('CloudWatchLogs');
36 my $GetLogEventsResponse = $logs->GetLogEvents(
37 LogGroupName => 'MyLogGroupName',
38 LogStreamName => 'MyLogStreamName',
39 EndTime => 1, # OPTIONAL
40 Limit => 1, # OPTIONAL
41 NextToken => 'MyNextToken', # OPTIONAL
42 StartFromHead => 1, # OPTIONAL
43 StartTime => 1, # OPTIONAL
44 );
45  
46 # Results:
47 my $Events = $GetLogEventsResponse->Events;
48 my $NextBackwardToken = $GetLogEventsResponse->NextBackwardToken;
49 my $NextForwardToken = $GetLogEventsResponse->NextForwardToken;
50  
51 # Returns a L<Paws::CloudWatchLogs::GetLogEventsResponse> object.
52  
53 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.
54 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/logs/GetLogEvents>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 EndTime => Int
60  
61 The end of the time range, expressed as the number of milliseconds
62 after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to or
63 later than this time are not included.
64  
65  
66  
67 =head2 Limit => Int
68  
69 The maximum number of log events returned. If you don't specify a
70 value, the maximum is as many log events as can fit in a response size
71 of 1 MB, up to 10,000 log events.
72  
73  
74  
75 =head2 B<REQUIRED> LogGroupName => Str
76  
77 The name of the log group.
78  
79  
80  
81 =head2 B<REQUIRED> LogStreamName => Str
82  
83 The name of the log stream.
84  
85  
86  
87 =head2 NextToken => Str
88  
89 The token for the next set of items to return. (You received this token
90 from a previous call.)
91  
92 Using this token works only when you specify C<true> for
93 C<startFromHead>.
94  
95  
96  
97 =head2 StartFromHead => Bool
98  
99 If the value is true, the earliest log events are returned first. If
100 the value is false, the latest log events are returned first. The
101 default value is false.
102  
103 If you are using C<nextToken> in this operation, you must specify
104 C<true> for C<startFromHead>.
105  
106  
107  
108 =head2 StartTime => Int
109  
110 The start of the time range, expressed as the number of milliseconds
111 after Jan 1, 1970 00:00:00 UTC. Events with a timestamp equal to this
112 time or later than this time are included. Events with a timestamp
113 earlier than this time are not included.
114  
115  
116  
117  
118 =head1 SEE ALSO
119  
120 This class forms part of L<Paws>, documenting arguments for method GetLogEvents in L<Paws::CloudWatchLogs>
121  
122 =head1 BUGS and CONTRIBUTIONS
123  
124 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
125  
126 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
127  
128 =cut
129  
« blib/lib/Paws/CloudWatchLogs/FilteredLogEvent.pm ↑ Summary blib/lib/Paws/CloudWatchLogs/GetLogEventsResponse.pm »