1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package apigateway
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/apigateway/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// Describes existing Models defined for a RestApi resource.
16func (c *Client) GetModels(ctx context.Context, params *GetModelsInput, optFns ...func(*Options)) (*GetModelsOutput, error) {
17	if params == nil {
18		params = &GetModelsInput{}
19	}
20
21	result, metadata, err := c.invokeOperation(ctx, "GetModels", params, optFns, addOperationGetModelsMiddlewares)
22	if err != nil {
23		return nil, err
24	}
25
26	out := result.(*GetModelsOutput)
27	out.ResultMetadata = metadata
28	return out, nil
29}
30
31// Request to list existing Models defined for a RestApi resource.
32type GetModelsInput struct {
33
34	// [Required] The string identifier of the associated RestApi.
35	//
36	// This member is required.
37	RestApiId *string
38
39	// The maximum number of returned results per page. The default value is 25 and the
40	// maximum value is 500.
41	Limit *int32
42
43	// The current pagination position in the paged result set.
44	Position *string
45}
46
47// Represents a collection of Model resources. Method, MethodResponse, Models and
48// Mappings
49// (https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html)
50type GetModelsOutput struct {
51
52	// The current page of elements from this collection.
53	Items []types.Model
54
55	// The current pagination position in the paged result set.
56	Position *string
57
58	// Metadata pertaining to the operation's result.
59	ResultMetadata middleware.Metadata
60}
61
62func addOperationGetModelsMiddlewares(stack *middleware.Stack, options Options) (err error) {
63	err = stack.Serialize.Add(&awsRestjson1_serializeOpGetModels{}, middleware.After)
64	if err != nil {
65		return err
66	}
67	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpGetModels{}, middleware.After)
68	if err != nil {
69		return err
70	}
71	if err = addSetLoggerMiddleware(stack, options); err != nil {
72		return err
73	}
74	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
75		return err
76	}
77	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
78		return err
79	}
80	if err = addResolveEndpointMiddleware(stack, options); err != nil {
81		return err
82	}
83	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
84		return err
85	}
86	if err = addRetryMiddlewares(stack, options); err != nil {
87		return err
88	}
89	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
90		return err
91	}
92	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
93		return err
94	}
95	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
96		return err
97	}
98	if err = addClientUserAgent(stack); err != nil {
99		return err
100	}
101	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
102		return err
103	}
104	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
105		return err
106	}
107	if err = addOpGetModelsValidationMiddleware(stack); err != nil {
108		return err
109	}
110	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opGetModels(options.Region), middleware.Before); err != nil {
111		return err
112	}
113	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
114		return err
115	}
116	if err = addResponseErrorMiddleware(stack); err != nil {
117		return err
118	}
119	if err = addAcceptHeader(stack); err != nil {
120		return err
121	}
122	if err = addRequestResponseLogging(stack, options); err != nil {
123		return err
124	}
125	return nil
126}
127
128// GetModelsAPIClient is a client that implements the GetModels operation.
129type GetModelsAPIClient interface {
130	GetModels(context.Context, *GetModelsInput, ...func(*Options)) (*GetModelsOutput, error)
131}
132
133var _ GetModelsAPIClient = (*Client)(nil)
134
135// GetModelsPaginatorOptions is the paginator options for GetModels
136type GetModelsPaginatorOptions struct {
137	// The maximum number of returned results per page. The default value is 25 and the
138	// maximum value is 500.
139	Limit int32
140
141	// Set to true if pagination should stop if the service returns a pagination token
142	// that matches the most recent token provided to the service.
143	StopOnDuplicateToken bool
144}
145
146// GetModelsPaginator is a paginator for GetModels
147type GetModelsPaginator struct {
148	options   GetModelsPaginatorOptions
149	client    GetModelsAPIClient
150	params    *GetModelsInput
151	nextToken *string
152	firstPage bool
153}
154
155// NewGetModelsPaginator returns a new GetModelsPaginator
156func NewGetModelsPaginator(client GetModelsAPIClient, params *GetModelsInput, optFns ...func(*GetModelsPaginatorOptions)) *GetModelsPaginator {
157	if params == nil {
158		params = &GetModelsInput{}
159	}
160
161	options := GetModelsPaginatorOptions{}
162	if params.Limit != nil {
163		options.Limit = *params.Limit
164	}
165
166	for _, fn := range optFns {
167		fn(&options)
168	}
169
170	return &GetModelsPaginator{
171		options:   options,
172		client:    client,
173		params:    params,
174		firstPage: true,
175	}
176}
177
178// HasMorePages returns a boolean indicating whether more pages are available
179func (p *GetModelsPaginator) HasMorePages() bool {
180	return p.firstPage || p.nextToken != nil
181}
182
183// NextPage retrieves the next GetModels page.
184func (p *GetModelsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*GetModelsOutput, error) {
185	if !p.HasMorePages() {
186		return nil, fmt.Errorf("no more pages available")
187	}
188
189	params := *p.params
190	params.Position = p.nextToken
191
192	var limit *int32
193	if p.options.Limit > 0 {
194		limit = &p.options.Limit
195	}
196	params.Limit = limit
197
198	result, err := p.client.GetModels(ctx, &params, optFns...)
199	if err != nil {
200		return nil, err
201	}
202	p.firstPage = false
203
204	prevToken := p.nextToken
205	p.nextToken = result.Position
206
207	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
208		p.nextToken = nil
209	}
210
211	return result, nil
212}
213
214func newServiceMetadataMiddleware_opGetModels(region string) *awsmiddleware.RegisterServiceMetadata {
215	return &awsmiddleware.RegisterServiceMetadata{
216		Region:        region,
217		ServiceID:     ServiceID,
218		SigningName:   "apigateway",
219		OperationName: "GetModels",
220	}
221}
222