-
Notifications
You must be signed in to change notification settings - Fork 597
/
api_op_DownloadDBLogFilePortion.go
279 lines (243 loc) · 9.15 KB
/
api_op_DownloadDBLogFilePortion.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
// Code generated by smithy-go-codegen DO NOT EDIT.
package rds
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// Downloads all or a portion of the specified log file, up to 1 MB in size. This
// command doesn't apply to RDS Custom.
func (c *Client) DownloadDBLogFilePortion(ctx context.Context, params *DownloadDBLogFilePortionInput, optFns ...func(*Options)) (*DownloadDBLogFilePortionOutput, error) {
if params == nil {
params = &DownloadDBLogFilePortionInput{}
}
result, metadata, err := c.invokeOperation(ctx, "DownloadDBLogFilePortion", params, optFns, c.addOperationDownloadDBLogFilePortionMiddlewares)
if err != nil {
return nil, err
}
out := result.(*DownloadDBLogFilePortionOutput)
out.ResultMetadata = metadata
return out, nil
}
//
type DownloadDBLogFilePortionInput struct {
// The customer-assigned name of the DB instance that contains the log files you
// want to list. Constraints:
//
// * Must match the identifier of an existing
// DBInstance.
//
// This member is required.
DBInstanceIdentifier *string
// The name of the log file to be downloaded.
//
// This member is required.
LogFileName *string
// The pagination token provided in the previous request or "0". If the Marker
// parameter is specified the response includes only records beyond the marker
// until the end of the file or up to NumberOfLines.
Marker *string
// The number of lines to download. If the number of lines specified results in a
// file over 1 MB in size, the file is truncated at 1 MB in size. If the
// NumberOfLines parameter is specified, then the block of lines returned can be
// from the beginning or the end of the log file, depending on the value of the
// Marker parameter.
//
// * If neither Marker or NumberOfLines are specified, the
// entire log file is returned up to a maximum of 10000 lines, starting with the
// most recent log entries first.
//
// * If NumberOfLines is specified and Marker isn't
// specified, then the most recent lines from the end of the log file are
// returned.
//
// * If Marker is specified as "0", then the specified number of lines
// from the beginning of the log file are returned.
//
// * You can download the log
// file in blocks of lines by specifying the size of the block using the
// NumberOfLines parameter, and by specifying a value of "0" for the Marker
// parameter in your first request. Include the Marker value returned in the
// response as the Marker value for the next request, continuing until the
// AdditionalDataPending response element returns false.
NumberOfLines int32
noSmithyDocumentSerde
}
// This data type is used as a response element to DownloadDBLogFilePortion.
type DownloadDBLogFilePortionOutput struct {
// Boolean value that if true, indicates there is more data to be downloaded.
AdditionalDataPending bool
// Entries from the specified log file.
LogFileData *string
// A pagination token that can be used in a later DownloadDBLogFilePortion request.
Marker *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationDownloadDBLogFilePortionMiddlewares(stack *middleware.Stack, options Options) (err error) {
err = stack.Serialize.Add(&awsAwsquery_serializeOpDownloadDBLogFilePortion{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsquery_deserializeOpDownloadDBLogFilePortion{}, middleware.After)
if err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = addHTTPSignerV4Middleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addOpDownloadDBLogFilePortionValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opDownloadDBLogFilePortion(options.Region), middleware.Before); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
return nil
}
// DownloadDBLogFilePortionAPIClient is a client that implements the
// DownloadDBLogFilePortion operation.
type DownloadDBLogFilePortionAPIClient interface {
DownloadDBLogFilePortion(context.Context, *DownloadDBLogFilePortionInput, ...func(*Options)) (*DownloadDBLogFilePortionOutput, error)
}
var _ DownloadDBLogFilePortionAPIClient = (*Client)(nil)
// DownloadDBLogFilePortionPaginatorOptions is the paginator options for
// DownloadDBLogFilePortion
type DownloadDBLogFilePortionPaginatorOptions struct {
// The number of lines to download. If the number of lines specified results in a
// file over 1 MB in size, the file is truncated at 1 MB in size. If the
// NumberOfLines parameter is specified, then the block of lines returned can be
// from the beginning or the end of the log file, depending on the value of the
// Marker parameter.
//
// * If neither Marker or NumberOfLines are specified, the
// entire log file is returned up to a maximum of 10000 lines, starting with the
// most recent log entries first.
//
// * If NumberOfLines is specified and Marker isn't
// specified, then the most recent lines from the end of the log file are
// returned.
//
// * If Marker is specified as "0", then the specified number of lines
// from the beginning of the log file are returned.
//
// * You can download the log
// file in blocks of lines by specifying the size of the block using the
// NumberOfLines parameter, and by specifying a value of "0" for the Marker
// parameter in your first request. Include the Marker value returned in the
// response as the Marker value for the next request, continuing until the
// AdditionalDataPending response element returns false.
Limit int32
// Set to true if pagination should stop if the service returns a pagination token
// that matches the most recent token provided to the service.
StopOnDuplicateToken bool
}
// DownloadDBLogFilePortionPaginator is a paginator for DownloadDBLogFilePortion
type DownloadDBLogFilePortionPaginator struct {
options DownloadDBLogFilePortionPaginatorOptions
client DownloadDBLogFilePortionAPIClient
params *DownloadDBLogFilePortionInput
nextToken *string
firstPage bool
}
// NewDownloadDBLogFilePortionPaginator returns a new
// DownloadDBLogFilePortionPaginator
func NewDownloadDBLogFilePortionPaginator(client DownloadDBLogFilePortionAPIClient, params *DownloadDBLogFilePortionInput, optFns ...func(*DownloadDBLogFilePortionPaginatorOptions)) *DownloadDBLogFilePortionPaginator {
if params == nil {
params = &DownloadDBLogFilePortionInput{}
}
options := DownloadDBLogFilePortionPaginatorOptions{}
if params.NumberOfLines != 0 {
options.Limit = params.NumberOfLines
}
for _, fn := range optFns {
fn(&options)
}
return &DownloadDBLogFilePortionPaginator{
options: options,
client: client,
params: params,
firstPage: true,
nextToken: params.Marker,
}
}
// HasMorePages returns a boolean indicating whether more pages are available
func (p *DownloadDBLogFilePortionPaginator) HasMorePages() bool {
return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}
// NextPage retrieves the next DownloadDBLogFilePortion page.
func (p *DownloadDBLogFilePortionPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DownloadDBLogFilePortionOutput, error) {
if !p.HasMorePages() {
return nil, fmt.Errorf("no more pages available")
}
params := *p.params
params.Marker = p.nextToken
params.NumberOfLines = p.options.Limit
result, err := p.client.DownloadDBLogFilePortion(ctx, ¶ms, optFns...)
if err != nil {
return nil, err
}
p.firstPage = false
prevToken := p.nextToken
p.nextToken = result.Marker
if p.options.StopOnDuplicateToken &&
prevToken != nil &&
p.nextToken != nil &&
*prevToken == *p.nextToken {
p.nextToken = nil
}
return result, nil
}
func newServiceMetadataMiddleware_opDownloadDBLogFilePortion(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
SigningName: "rds",
OperationName: "DownloadDBLogFilePortion",
}
}