File Coverage

blib/lib/Paws/RDS/DownloadDBLogFilePortion.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::RDS::DownloadDBLogFilePortion;
3 1     1   297 use Moose;
  1         3  
  1         6  
4             has DBInstanceIdentifier => (is => 'ro', isa => 'Str', required => 1);
5             has LogFileName => (is => 'ro', isa => 'Str', required => 1);
6             has Marker => (is => 'ro', isa => 'Str');
7             has NumberOfLines => (is => 'ro', isa => 'Int');
8              
9 1     1   5299 use MooseX::ClassAttribute;
  1         2  
  1         7  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DownloadDBLogFilePortion');
12             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RDS::DownloadDBLogFilePortionDetails');
13             class_has _result_key => (isa => 'Str', is => 'ro', default => 'DownloadDBLogFilePortionResult');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::RDS::DownloadDBLogFilePortion - Arguments for method DownloadDBLogFilePortion on Paws::RDS
21              
22             =head1 DESCRIPTION
23              
24             This class represents the parameters used for calling the method DownloadDBLogFilePortion on the
25             Amazon Relational Database Service service. Use the attributes of this class
26             as arguments to method DownloadDBLogFilePortion.
27              
28             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DownloadDBLogFilePortion.
29              
30             As an example:
31              
32             $service_obj->DownloadDBLogFilePortion(Att1 => $value1, Att2 => $value2, ...);
33              
34             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.
35              
36             =head1 ATTRIBUTES
37              
38              
39             =head2 B<REQUIRED> DBInstanceIdentifier => Str
40              
41             The customer-assigned name of the DB instance that contains the log
42             files you want to list.
43              
44             Constraints:
45              
46             =over
47              
48             =item *
49              
50             Must contain from 1 to 63 alphanumeric characters or hyphens
51              
52             =item *
53              
54             First character must be a letter
55              
56             =item *
57              
58             Cannot end with a hyphen or contain two consecutive hyphens
59              
60             =back
61              
62              
63              
64              
65             =head2 B<REQUIRED> LogFileName => Str
66              
67             The name of the log file to be downloaded.
68              
69              
70              
71             =head2 Marker => Str
72              
73             The pagination token provided in the previous request or "0". If the
74             Marker parameter is specified the response includes only records beyond
75             the marker until the end of the file or up to NumberOfLines.
76              
77              
78              
79             =head2 NumberOfLines => Int
80              
81             The number of lines to download. If the number of lines specified
82             results in a file over 1 MB in size, the file will be truncated at 1 MB
83             in size.
84              
85             If the NumberOfLines parameter is specified, then the block of lines
86             returned can be from the beginning or the end of the log file,
87             depending on the value of the Marker parameter.
88              
89             =over
90              
91             =item *
92              
93             If neither Marker or NumberOfLines are specified, the entire log file
94             is returned up to a maximum of 10000 lines, starting with the most
95             recent log entries first.
96              
97             =item *
98              
99             If NumberOfLines is specified and Marker is not specified, then the
100             most recent lines from the end of the log file are returned.
101              
102             =item *
103              
104             If Marker is specified as "0", then the specified number of lines from
105             the beginning of the log file are returned.
106              
107             =item *
108              
109             You can download the log file in blocks of lines by specifying the size
110             of the block using the NumberOfLines parameter, and by specifying a
111             value of "0" for the Marker parameter in your first request. Include
112             the Marker value returned in the response as the Marker value for the
113             next request, continuing until the AdditionalDataPending response
114             element returns false.
115              
116             =back
117              
118              
119              
120              
121              
122             =head1 SEE ALSO
123              
124             This class forms part of L<Paws>, documenting arguments for method DownloadDBLogFilePortion in L<Paws::RDS>
125              
126             =head1 BUGS and CONTRIBUTIONS
127              
128             The source code is located here: https://github.com/pplu/aws-sdk-perl
129              
130             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
131              
132             =cut
133