1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package robomaker
4
5import (
6	"context"
7	"fmt"
8	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
9	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
10	"github.com/aws/aws-sdk-go-v2/service/robomaker/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// Lists world export jobs.
16func (c *Client) ListWorldExportJobs(ctx context.Context, params *ListWorldExportJobsInput, optFns ...func(*Options)) (*ListWorldExportJobsOutput, error) {
17	if params == nil {
18		params = &ListWorldExportJobsInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "ListWorldExportJobs", params, optFns, addOperationListWorldExportJobsMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*ListWorldExportJobsOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31type ListWorldExportJobsInput struct {
32
33	// Optional filters to limit results. You can use generationJobId and templateId.
34	Filters []types.Filter
35
36	// When this parameter is used, ListWorldExportJobs only returns maxResults results
37	// in a single page along with a nextToken response element. The remaining results
38	// of the initial request can be seen by sending another ListWorldExportJobs
39	// request with the returned nextToken value. This value can be between 1 and 100.
40	// If this parameter is not used, then ListWorldExportJobs returns up to 100
41	// results and a nextToken value if applicable.
42	MaxResults *int32
43
44	// If the previous paginated request did not return all of the remaining results,
45	// the response object's nextToken parameter value is set to a token. To retrieve
46	// the next set of results, call ListWorldExportJobs again and assign that token to
47	// the request object's nextToken parameter. If there are no remaining results, the
48	// previous response object's NextToken parameter is set to null.
49	NextToken *string
50}
51
52type ListWorldExportJobsOutput struct {
53
54	// Summary information for world export jobs.
55	//
56	// This member is required.
57	WorldExportJobSummaries []types.WorldExportJobSummary
58
59	// If the previous paginated request did not return all of the remaining results,
60	// the response object's nextToken parameter value is set to a token. To retrieve
61	// the next set of results, call ListWorldExportJobsRequest again and assign that
62	// token to the request object's nextToken parameter. If there are no remaining
63	// results, the previous response object's NextToken parameter is set to null.
64	NextToken *string
65
66	// Metadata pertaining to the operation's result.
67	ResultMetadata middleware.Metadata
68}
69
70func addOperationListWorldExportJobsMiddlewares(stack *middleware.Stack, options Options) (err error) {
71	err = stack.Serialize.Add(&awsRestjson1_serializeOpListWorldExportJobs{}, middleware.After)
72	if err != nil {
73		return err
74	}
75	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListWorldExportJobs{}, middleware.After)
76	if err != nil {
77		return err
78	}
79	if err = addSetLoggerMiddleware(stack, options); err != nil {
80		return err
81	}
82	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
83		return err
84	}
85	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
86		return err
87	}
88	if err = addResolveEndpointMiddleware(stack, options); err != nil {
89		return err
90	}
91	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
92		return err
93	}
94	if err = addRetryMiddlewares(stack, options); err != nil {
95		return err
96	}
97	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
98		return err
99	}
100	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
101		return err
102	}
103	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
104		return err
105	}
106	if err = addClientUserAgent(stack); err != nil {
107		return err
108	}
109	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
110		return err
111	}
112	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
113		return err
114	}
115	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListWorldExportJobs(options.Region), middleware.Before); err != nil {
116		return err
117	}
118	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
119		return err
120	}
121	if err = addResponseErrorMiddleware(stack); err != nil {
122		return err
123	}
124	if err = addRequestResponseLogging(stack, options); err != nil {
125		return err
126	}
127	return nil
128}
129
130// ListWorldExportJobsAPIClient is a client that implements the ListWorldExportJobs
131// operation.
132type ListWorldExportJobsAPIClient interface {
133	ListWorldExportJobs(context.Context, *ListWorldExportJobsInput, ...func(*Options)) (*ListWorldExportJobsOutput, error)
134}
135
136var _ ListWorldExportJobsAPIClient = (*Client)(nil)
137
138// ListWorldExportJobsPaginatorOptions is the paginator options for
139// ListWorldExportJobs
140type ListWorldExportJobsPaginatorOptions struct {
141	// When this parameter is used, ListWorldExportJobs only returns maxResults results
142	// in a single page along with a nextToken response element. The remaining results
143	// of the initial request can be seen by sending another ListWorldExportJobs
144	// request with the returned nextToken value. This value can be between 1 and 100.
145	// If this parameter is not used, then ListWorldExportJobs returns up to 100
146	// results and a nextToken value if applicable.
147	Limit int32
148
149	// Set to true if pagination should stop if the service returns a pagination token
150	// that matches the most recent token provided to the service.
151	StopOnDuplicateToken bool
152}
153
154// ListWorldExportJobsPaginator is a paginator for ListWorldExportJobs
155type ListWorldExportJobsPaginator struct {
156	options   ListWorldExportJobsPaginatorOptions
157	client    ListWorldExportJobsAPIClient
158	params    *ListWorldExportJobsInput
159	nextToken *string
160	firstPage bool
161}
162
163// NewListWorldExportJobsPaginator returns a new ListWorldExportJobsPaginator
164func NewListWorldExportJobsPaginator(client ListWorldExportJobsAPIClient, params *ListWorldExportJobsInput, optFns ...func(*ListWorldExportJobsPaginatorOptions)) *ListWorldExportJobsPaginator {
165	if params == nil {
166		params = &ListWorldExportJobsInput{}
167	}
168
169	options := ListWorldExportJobsPaginatorOptions{}
170	if params.MaxResults != nil {
171		options.Limit = *params.MaxResults
172	}
173
174	for _, fn := range optFns {
175		fn(&options)
176	}
177
178	return &ListWorldExportJobsPaginator{
179		options:   options,
180		client:    client,
181		params:    params,
182		firstPage: true,
183	}
184}
185
186// HasMorePages returns a boolean indicating whether more pages are available
187func (p *ListWorldExportJobsPaginator) HasMorePages() bool {
188	return p.firstPage || p.nextToken != nil
189}
190
191// NextPage retrieves the next ListWorldExportJobs page.
192func (p *ListWorldExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorldExportJobsOutput, error) {
193	if !p.HasMorePages() {
194		return nil, fmt.Errorf("no more pages available")
195	}
196
197	params := *p.params
198	params.NextToken = p.nextToken
199
200	var limit *int32
201	if p.options.Limit > 0 {
202		limit = &p.options.Limit
203	}
204	params.MaxResults = limit
205
206	result, err := p.client.ListWorldExportJobs(ctx, &params, optFns...)
207	if err != nil {
208		return nil, err
209	}
210	p.firstPage = false
211
212	prevToken := p.nextToken
213	p.nextToken = result.NextToken
214
215	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
216		p.nextToken = nil
217	}
218
219	return result, nil
220}
221
222func newServiceMetadataMiddleware_opListWorldExportJobs(region string) *awsmiddleware.RegisterServiceMetadata {
223	return &awsmiddleware.RegisterServiceMetadata{
224		Region:        region,
225		ServiceID:     ServiceID,
226		SigningName:   "robomaker",
227		OperationName: "ListWorldExportJobs",
228	}
229}
230