File Coverage

blib/lib/Paws/CloudWatchLogs/DescribeLogStreams.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CloudWatchLogs::DescribeLogStreams;
3 1     1   445 use Moose;
  1     2   4  
  1         7  
  2         914  
  2         5  
  2         15  
4             has Descending => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'descending' );
5             has Limit => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'limit' );
6             has LogGroupName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'logGroupName' , required => 1);
7             has LogStreamNamePrefix => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'logStreamNamePrefix' );
8             has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
9             has OrderBy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'orderBy' );
10              
11 1     1   6093 use MooseX::ClassAttribute;
  1     2   3  
  1         8  
  2         12488  
  2         4  
  2         16  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeLogStreams');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatchLogs::DescribeLogStreamsResponse');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::CloudWatchLogs::DescribeLogStreams - Arguments for method DescribeLogStreams on Paws::CloudWatchLogs
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method DescribeLogStreams on the
27             Amazon CloudWatch Logs service. Use the attributes of this class
28             as arguments to method DescribeLogStreams.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeLogStreams.
31              
32             As an example:
33              
34             $service_obj->DescribeLogStreams(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 Descending => Bool
42              
43             If the value is true, results are returned in descending order. If the
44             value is to false, results are returned in ascending order. The default
45             value is false.
46              
47              
48              
49             =head2 Limit => Int
50              
51             The maximum number of items returned. If you don't specify a value, the
52             default is up to 50 items.
53              
54              
55              
56             =head2 B<REQUIRED> LogGroupName => Str
57              
58             The name of the log group.
59              
60              
61              
62             =head2 LogStreamNamePrefix => Str
63              
64             The prefix to match.
65              
66             iIf C<orderBy> is C<LastEventTime>,you cannot specify this parameter.
67              
68              
69              
70             =head2 NextToken => Str
71              
72             The token for the next set of items to return. (You received this token
73             from a previous call.)
74              
75              
76              
77             =head2 OrderBy => Str
78              
79             If the value is C<LogStreamName>, the results are ordered by log stream
80             name. If the value is C<LastEventTime>, the results are ordered by the
81             event time. The default value is C<LogStreamName>.
82              
83             If you order the results by event time, you cannot specify the
84             C<logStreamNamePrefix> parameter.
85              
86             lastEventTimestamp represents the time of the most recent log event in
87             the log stream in CloudWatch Logs. This number is expressed as the
88             number of milliseconds after Jan 1, 1970 00:00:00 UTC.
89             lastEventTimeStamp updates on an eventual consistency basis. It
90             typically updates in less than an hour from ingestion, but may take
91             longer in some rare situations.
92              
93             Valid values are: C<"LogStreamName">, C<"LastEventTime">
94              
95              
96             =head1 SEE ALSO
97              
98             This class forms part of L<Paws>, documenting arguments for method DescribeLogStreams in L<Paws::CloudWatchLogs>
99              
100             =head1 BUGS and CONTRIBUTIONS
101              
102             The source code is located here: https://github.com/pplu/aws-sdk-perl
103              
104             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
105              
106             =cut
107