-
Notifications
You must be signed in to change notification settings - Fork 626
/
api_op_ListJobTemplates.go
261 lines (219 loc) · 8.41 KB
/
api_op_ListJobTemplates.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
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package mediaconvert
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
"github.com/aws/aws-sdk-go-v2/private/protocol"
)
// You can send list job templates requests with an empty body. Optionally,
// you can filter the response by category by specifying it in your request
// body. You can also optionally specify the maximum number, up to twenty, of
// job templates to be returned.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconvert-2017-08-29/ListJobTemplatesRequest
type ListJobTemplatesInput struct {
_ struct{} `type:"structure"`
// Optionally, specify a job template category to limit responses to only job
// templates from that category.
Category *string `location:"querystring" locationName:"category" type:"string"`
// Optional. When you request a list of job templates, you can choose to list
// them alphabetically by NAME or chronologically by CREATION_DATE. If you don't
// specify, the service will list them by name.
ListBy JobTemplateListBy `location:"querystring" locationName:"listBy" type:"string" enum:"true"`
// Optional. Number of job templates, up to twenty, that will be returned at
// one time.
MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`
// Use this string, provided with the response to a previous request, to request
// the next batch of job templates.
NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
// When you request lists of resources, you can optionally specify whether they
// are sorted in ASCENDING or DESCENDING order. Default varies by resource.
Order Order `location:"querystring" locationName:"order" type:"string" enum:"true"`
}
// String returns the string representation
func (s ListJobTemplatesInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *ListJobTemplatesInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "ListJobTemplatesInput"}
if s.MaxResults != nil && *s.MaxResults < 1 {
invalidParams.Add(aws.NewErrParamMinValue("MaxResults", 1))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s ListJobTemplatesInput) MarshalFields(e protocol.FieldEncoder) error {
e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/json"), protocol.Metadata{})
if s.Category != nil {
v := *s.Category
metadata := protocol.Metadata{}
e.SetValue(protocol.QueryTarget, "category", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if len(s.ListBy) > 0 {
v := s.ListBy
metadata := protocol.Metadata{}
e.SetValue(protocol.QueryTarget, "listBy", protocol.QuotedValue{ValueMarshaler: v}, metadata)
}
if s.MaxResults != nil {
v := *s.MaxResults
metadata := protocol.Metadata{}
e.SetValue(protocol.QueryTarget, "maxResults", protocol.Int64Value(v), metadata)
}
if s.NextToken != nil {
v := *s.NextToken
metadata := protocol.Metadata{}
e.SetValue(protocol.QueryTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
if len(s.Order) > 0 {
v := s.Order
metadata := protocol.Metadata{}
e.SetValue(protocol.QueryTarget, "order", protocol.QuotedValue{ValueMarshaler: v}, metadata)
}
return nil
}
// Successful list job templates requests return a JSON array of job templates.
// If you don't specify how they are ordered, you will receive them in alphabetical
// order by name.
// Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconvert-2017-08-29/ListJobTemplatesResponse
type ListJobTemplatesOutput struct {
_ struct{} `type:"structure"`
// List of Job templates.
JobTemplates []JobTemplate `locationName:"jobTemplates" type:"list"`
// Use this string to request the next batch of job templates.
NextToken *string `locationName:"nextToken" type:"string"`
}
// String returns the string representation
func (s ListJobTemplatesOutput) String() string {
return awsutil.Prettify(s)
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s ListJobTemplatesOutput) MarshalFields(e protocol.FieldEncoder) error {
if s.JobTemplates != nil {
v := s.JobTemplates
metadata := protocol.Metadata{}
ls0 := e.List(protocol.BodyTarget, "jobTemplates", metadata)
ls0.Start()
for _, v1 := range v {
ls0.ListAddFields(v1)
}
ls0.End()
}
if s.NextToken != nil {
v := *s.NextToken
metadata := protocol.Metadata{}
e.SetValue(protocol.BodyTarget, "nextToken", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
const opListJobTemplates = "ListJobTemplates"
// ListJobTemplatesRequest returns a request value for making API operation for
// AWS Elemental MediaConvert.
//
// Retrieve a JSON array of up to twenty of your job templates. This will return
// the templates themselves, not just a list of them. To retrieve the next twenty
// templates, use the nextToken string returned with the array
//
// // Example sending a request using ListJobTemplatesRequest.
// req := client.ListJobTemplatesRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/mediaconvert-2017-08-29/ListJobTemplates
func (c *Client) ListJobTemplatesRequest(input *ListJobTemplatesInput) ListJobTemplatesRequest {
op := &aws.Operation{
Name: opListJobTemplates,
HTTPMethod: "GET",
HTTPPath: "/2017-08-29/jobTemplates",
Paginator: &aws.Paginator{
InputTokens: []string{"NextToken"},
OutputTokens: []string{"NextToken"},
LimitToken: "MaxResults",
TruncationToken: "",
},
}
if input == nil {
input = &ListJobTemplatesInput{}
}
req := c.newRequest(op, input, &ListJobTemplatesOutput{})
return ListJobTemplatesRequest{Request: req, Input: input, Copy: c.ListJobTemplatesRequest}
}
// ListJobTemplatesRequest is the request type for the
// ListJobTemplates API operation.
type ListJobTemplatesRequest struct {
*aws.Request
Input *ListJobTemplatesInput
Copy func(*ListJobTemplatesInput) ListJobTemplatesRequest
}
// Send marshals and sends the ListJobTemplates API request.
func (r ListJobTemplatesRequest) Send(ctx context.Context) (*ListJobTemplatesResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &ListJobTemplatesResponse{
ListJobTemplatesOutput: r.Request.Data.(*ListJobTemplatesOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// NewListJobTemplatesRequestPaginator returns a paginator for ListJobTemplates.
// Use Next method to get the next page, and CurrentPage to get the current
// response page from the paginator. Next will return false, if there are
// no more pages, or an error was encountered.
//
// Note: This operation can generate multiple requests to a service.
//
// // Example iterating over pages.
// req := client.ListJobTemplatesRequest(input)
// p := mediaconvert.NewListJobTemplatesRequestPaginator(req)
//
// for p.Next(context.TODO()) {
// page := p.CurrentPage()
// }
//
// if err := p.Err(); err != nil {
// return err
// }
//
func NewListJobTemplatesPaginator(req ListJobTemplatesRequest) ListJobTemplatesPaginator {
return ListJobTemplatesPaginator{
Pager: aws.Pager{
NewRequest: func(ctx context.Context) (*aws.Request, error) {
var inCpy *ListJobTemplatesInput
if req.Input != nil {
tmp := *req.Input
inCpy = &tmp
}
newReq := req.Copy(inCpy)
newReq.SetContext(ctx)
return newReq.Request, nil
},
},
}
}
// ListJobTemplatesPaginator is used to paginate the request. This can be done by
// calling Next and CurrentPage.
type ListJobTemplatesPaginator struct {
aws.Pager
}
func (p *ListJobTemplatesPaginator) CurrentPage() *ListJobTemplatesOutput {
return p.Pager.CurrentPage().(*ListJobTemplatesOutput)
}
// ListJobTemplatesResponse is the response type for the
// ListJobTemplates API operation.
type ListJobTemplatesResponse struct {
*ListJobTemplatesOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// ListJobTemplates request.
func (r *ListJobTemplatesResponse) SDKResponseMetdata() *aws.Response {
return r.response
}