blib/lib/Paws/CloudWatchLogs/DescribeLogStreams.pm

filter: Statementstmt 100% 16 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 18 / 18 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/CloudWatchLogs/DescribeLogGroupsResponse.pm ↑ Summary blib/lib/Paws/CloudWatchLogs/DescribeLogStreamsResponse.pm »
1  
2 package Paws::CloudWatchLogs::DescribeLogStreams;
3 2 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 2 has Descending => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'descending' );
5 2 has Limit => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'limit' );
6 2 has LogGroupName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'logGroupName' , required => 1);
7 2 has LogStreamNamePrefix => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'logStreamNamePrefix' );
8 2 has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
9 2 has OrderBy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'orderBy' );
10  
11 2 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
12  
13 2 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeLogStreams');
14 2 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudWatchLogs::DescribeLogStreamsResponse');
15 2 class_has _result_key => (isa => 'Str', is => 'ro');
16 2 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::CloudWatchLogs::DescribeLogStreams - Arguments for method DescribeLogStreams on L<Paws::CloudWatchLogs>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method DescribeLogStreams on the
27 L<Amazon CloudWatch Logs|Paws::CloudWatchLogs> 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 =head1 SYNOPSIS
33  
34 my $logs = Paws->service('CloudWatchLogs');
35 my $DescribeLogStreamsResponse = $logs->DescribeLogStreams(
36 LogGroupName => 'MyLogGroupName',
37 Descending => 1, # OPTIONAL
38 Limit => 1, # OPTIONAL
39 LogStreamNamePrefix => 'MyLogStreamName', # OPTIONAL
40 NextToken => 'MyNextToken', # OPTIONAL
41 OrderBy => 'LogStreamName', # OPTIONAL
42 );
43  
44 # Results:
45 my $LogStreams = $DescribeLogStreamsResponse->LogStreams;
46 my $NextToken = $DescribeLogStreamsResponse->NextToken;
47  
48 # Returns a L<Paws::CloudWatchLogs::DescribeLogStreamsResponse> object.
49  
50 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.
51 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/logs/DescribeLogStreams>
52  
53 =head1 ATTRIBUTES
54  
55  
56 =head2 Descending => Bool
57  
58 If the value is true, results are returned in descending order. If the
59 value is to false, results are returned in ascending order. The default
60 value is false.
61  
62  
63  
64 =head2 Limit => Int
65  
66 The maximum number of items returned. If you don't specify a value, the
67 default is up to 50 items.
68  
69  
70  
71 =head2 B<REQUIRED> LogGroupName => Str
72  
73 The name of the log group.
74  
75  
76  
77 =head2 LogStreamNamePrefix => Str
78  
79 The prefix to match.
80  
81 If C<orderBy> is C<LastEventTime>, you cannot specify this parameter.
82  
83  
84  
85 =head2 NextToken => Str
86  
87 The token for the next set of items to return. (You received this token
88 from a previous call.)
89  
90  
91  
92 =head2 OrderBy => Str
93  
94 If the value is C<LogStreamName>, the results are ordered by log stream
95 name. If the value is C<LastEventTime>, the results are ordered by the
96 event time. The default value is C<LogStreamName>.
97  
98 If you order the results by event time, you cannot specify the
99 C<logStreamNamePrefix> parameter.
100  
101 C<lastEventTimestamp> represents the time of the most recent log event
102 in the log stream in CloudWatch Logs. This number is expressed as the
103 number of milliseconds after Jan 1, 1970 00:00:00 UTC.
104 C<lastEventTimestamp> updates on an eventual consistency basis. It
105 typically updates in less than an hour from ingestion, but in rare
106 situations might take longer.
107  
108 Valid values are: C<"LogStreamName">, C<"LastEventTime">
109  
110  
111 =head1 SEE ALSO
112  
113 This class forms part of L<Paws>, documenting arguments for method DescribeLogStreams in L<Paws::CloudWatchLogs>
114  
115 =head1 BUGS and CONTRIBUTIONS
116  
117 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
118  
119 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
120  
121 =cut
122  
« blib/lib/Paws/CloudWatchLogs/DescribeLogGroupsResponse.pm ↑ Summary blib/lib/Paws/CloudWatchLogs/DescribeLogStreamsResponse.pm »