1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package clouddirectory
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/clouddirectory/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// Lists parent objects that are associated with a given object in pagination
16// fashion.
17func (c *Client) ListObjectParents(ctx context.Context, params *ListObjectParentsInput, optFns ...func(*Options)) (*ListObjectParentsOutput, error) {
18	if params == nil {
19		params = &ListObjectParentsInput{}
20	}
21
22	result, metadata, err := c.invokeOperation(ctx, "ListObjectParents", params, optFns, c.addOperationListObjectParentsMiddlewares)
23	if err != nil {
24		return nil, err
25	}
26
27	out := result.(*ListObjectParentsOutput)
28	out.ResultMetadata = metadata
29	return out, nil
30}
31
32type ListObjectParentsInput struct {
33
34	// The Amazon Resource Name (ARN) that is associated with the Directory where the
35	// object resides. For more information, see arns.
36	//
37	// This member is required.
38	DirectoryArn *string
39
40	// The reference that identifies the object for which parent objects are being
41	// listed.
42	//
43	// This member is required.
44	ObjectReference *types.ObjectReference
45
46	// Represents the manner and timing in which the successful write or update of an
47	// object is reflected in a subsequent read operation of that same object.
48	ConsistencyLevel types.ConsistencyLevel
49
50	// When set to True, returns all ListObjectParentsResponse$ParentLinks. There could
51	// be multiple links between a parent-child pair.
52	IncludeAllLinksToEachParent bool
53
54	// The maximum number of items to be retrieved in a single call. This is an
55	// approximate number.
56	MaxResults *int32
57
58	// The pagination token.
59	NextToken *string
60
61	noSmithyDocumentSerde
62}
63
64type ListObjectParentsOutput struct {
65
66	// The pagination token.
67	NextToken *string
68
69	// Returns a list of parent reference and LinkName Tuples.
70	ParentLinks []types.ObjectIdentifierAndLinkNameTuple
71
72	// The parent structure, which is a map with key as the ObjectIdentifier and
73	// LinkName as the value.
74	Parents map[string]string
75
76	// Metadata pertaining to the operation's result.
77	ResultMetadata middleware.Metadata
78
79	noSmithyDocumentSerde
80}
81
82func (c *Client) addOperationListObjectParentsMiddlewares(stack *middleware.Stack, options Options) (err error) {
83	err = stack.Serialize.Add(&awsRestjson1_serializeOpListObjectParents{}, middleware.After)
84	if err != nil {
85		return err
86	}
87	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListObjectParents{}, middleware.After)
88	if err != nil {
89		return err
90	}
91	if err = addSetLoggerMiddleware(stack, options); err != nil {
92		return err
93	}
94	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
95		return err
96	}
97	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
98		return err
99	}
100	if err = addResolveEndpointMiddleware(stack, options); err != nil {
101		return err
102	}
103	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
104		return err
105	}
106	if err = addRetryMiddlewares(stack, options); err != nil {
107		return err
108	}
109	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
110		return err
111	}
112	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
113		return err
114	}
115	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
116		return err
117	}
118	if err = addClientUserAgent(stack); err != nil {
119		return err
120	}
121	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
122		return err
123	}
124	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
125		return err
126	}
127	if err = addOpListObjectParentsValidationMiddleware(stack); err != nil {
128		return err
129	}
130	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListObjectParents(options.Region), middleware.Before); err != nil {
131		return err
132	}
133	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
134		return err
135	}
136	if err = addResponseErrorMiddleware(stack); err != nil {
137		return err
138	}
139	if err = addRequestResponseLogging(stack, options); err != nil {
140		return err
141	}
142	return nil
143}
144
145// ListObjectParentsAPIClient is a client that implements the ListObjectParents
146// operation.
147type ListObjectParentsAPIClient interface {
148	ListObjectParents(context.Context, *ListObjectParentsInput, ...func(*Options)) (*ListObjectParentsOutput, error)
149}
150
151var _ ListObjectParentsAPIClient = (*Client)(nil)
152
153// ListObjectParentsPaginatorOptions is the paginator options for ListObjectParents
154type ListObjectParentsPaginatorOptions struct {
155	// The maximum number of items to be retrieved in a single call. This is an
156	// approximate number.
157	Limit int32
158
159	// Set to true if pagination should stop if the service returns a pagination token
160	// that matches the most recent token provided to the service.
161	StopOnDuplicateToken bool
162}
163
164// ListObjectParentsPaginator is a paginator for ListObjectParents
165type ListObjectParentsPaginator struct {
166	options   ListObjectParentsPaginatorOptions
167	client    ListObjectParentsAPIClient
168	params    *ListObjectParentsInput
169	nextToken *string
170	firstPage bool
171}
172
173// NewListObjectParentsPaginator returns a new ListObjectParentsPaginator
174func NewListObjectParentsPaginator(client ListObjectParentsAPIClient, params *ListObjectParentsInput, optFns ...func(*ListObjectParentsPaginatorOptions)) *ListObjectParentsPaginator {
175	if params == nil {
176		params = &ListObjectParentsInput{}
177	}
178
179	options := ListObjectParentsPaginatorOptions{}
180	if params.MaxResults != nil {
181		options.Limit = *params.MaxResults
182	}
183
184	for _, fn := range optFns {
185		fn(&options)
186	}
187
188	return &ListObjectParentsPaginator{
189		options:   options,
190		client:    client,
191		params:    params,
192		firstPage: true,
193	}
194}
195
196// HasMorePages returns a boolean indicating whether more pages are available
197func (p *ListObjectParentsPaginator) HasMorePages() bool {
198	return p.firstPage || p.nextToken != nil
199}
200
201// NextPage retrieves the next ListObjectParents page.
202func (p *ListObjectParentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListObjectParentsOutput, error) {
203	if !p.HasMorePages() {
204		return nil, fmt.Errorf("no more pages available")
205	}
206
207	params := *p.params
208	params.NextToken = p.nextToken
209
210	var limit *int32
211	if p.options.Limit > 0 {
212		limit = &p.options.Limit
213	}
214	params.MaxResults = limit
215
216	result, err := p.client.ListObjectParents(ctx, &params, optFns...)
217	if err != nil {
218		return nil, err
219	}
220	p.firstPage = false
221
222	prevToken := p.nextToken
223	p.nextToken = result.NextToken
224
225	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
226		p.nextToken = nil
227	}
228
229	return result, nil
230}
231
232func newServiceMetadataMiddleware_opListObjectParents(region string) *awsmiddleware.RegisterServiceMetadata {
233	return &awsmiddleware.RegisterServiceMetadata{
234		Region:        region,
235		ServiceID:     ServiceID,
236		SigningName:   "clouddirectory",
237		OperationName: "ListObjectParents",
238	}
239}
240