File: api_op_ListLineageNodeHistory.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.30.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 662,428 kB
  • sloc: java: 16,875; makefile: 432; sh: 175
file content (285 lines) | stat: -rw-r--r-- 9,131 bytes parent folder | download
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
280
281
282
283
284
285
// Code generated by smithy-go-codegen DO NOT EDIT.

package datazone

import (
	"context"
	"fmt"
	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
	"github.com/aws/aws-sdk-go-v2/service/datazone/types"
	"github.com/aws/smithy-go/middleware"
	smithyhttp "github.com/aws/smithy-go/transport/http"
	"time"
)

// Lists the history of the specified data lineage node.
func (c *Client) ListLineageNodeHistory(ctx context.Context, params *ListLineageNodeHistoryInput, optFns ...func(*Options)) (*ListLineageNodeHistoryOutput, error) {
	if params == nil {
		params = &ListLineageNodeHistoryInput{}
	}

	result, metadata, err := c.invokeOperation(ctx, "ListLineageNodeHistory", params, optFns, c.addOperationListLineageNodeHistoryMiddlewares)
	if err != nil {
		return nil, err
	}

	out := result.(*ListLineageNodeHistoryOutput)
	out.ResultMetadata = metadata
	return out, nil
}

type ListLineageNodeHistoryInput struct {

	// The ID of the domain where you want to list the history of the specified data
	// lineage node.
	//
	// This member is required.
	DomainIdentifier *string

	// The ID of the data lineage node whose history you want to list.
	//
	// This member is required.
	Identifier *string

	// The direction of the data lineage node refers to the lineage node having
	// neighbors in that direction. For example, if direction is UPSTREAM , the
	// ListLineageNodeHistory API responds with historical versions with upstream
	// neighbors only.
	Direction types.EdgeDirection

	// Specifies whether the action is to return data lineage node history from the
	// time after the event timestamp.
	EventTimestampGTE *time.Time

	// Specifies whether the action is to return data lineage node history from the
	// time prior of the event timestamp.
	EventTimestampLTE *time.Time

	// The maximum number of history items to return in a single call to
	// ListLineageNodeHistory. When the number of memberships to be listed is greater
	// than the value of MaxResults, the response contains a NextToken value that you
	// can use in a subsequent call to ListLineageNodeHistory to list the next set of
	// items.
	MaxResults *int32

	// When the number of history items is greater than the default value for the
	// MaxResults parameter, or if you explicitly specify a value for MaxResults that
	// is less than the number of items, the response includes a pagination token named
	// NextToken. You can specify this NextToken value in a subsequent call to
	// ListLineageNodeHistory to list the next set of items.
	NextToken *string

	// The order by which you want data lineage node history to be sorted.
	SortOrder types.SortOrder

	noSmithyDocumentSerde
}

type ListLineageNodeHistoryOutput struct {

	// When the number of history items is greater than the default value for the
	// MaxResults parameter, or if you explicitly specify a value for MaxResults that
	// is less than the number of items, the response includes a pagination token named
	// NextToken. You can specify this NextToken value in a subsequent call to
	// ListLineageNodeHistory to list the next set of items.
	NextToken *string

	// The nodes returned by the ListLineageNodeHistory action.
	Nodes []types.LineageNodeSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata

	noSmithyDocumentSerde
}

func (c *Client) addOperationListLineageNodeHistoryMiddlewares(stack *middleware.Stack, options Options) (err error) {
	if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
		return err
	}
	err = stack.Serialize.Add(&awsRestjson1_serializeOpListLineageNodeHistory{}, middleware.After)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpListLineageNodeHistory{}, middleware.After)
	if err != nil {
		return err
	}
	if err := addProtocolFinalizerMiddlewares(stack, options, "ListLineageNodeHistory"); err != nil {
		return fmt.Errorf("add protocol finalizers: %v", err)
	}

	if err = addlegacyEndpointContextSetter(stack, options); err != nil {
		return err
	}
	if err = addSetLoggerMiddleware(stack, options); err != nil {
		return err
	}
	if err = addClientRequestID(stack); err != nil {
		return err
	}
	if err = addComputeContentLength(stack); err != nil {
		return err
	}
	if err = addResolveEndpointMiddleware(stack, options); err != nil {
		return err
	}
	if err = addComputePayloadSHA256(stack); err != nil {
		return err
	}
	if err = addRetry(stack, options); err != nil {
		return err
	}
	if err = addRawResponseToMetadata(stack); err != nil {
		return err
	}
	if err = addRecordResponseTiming(stack); err != nil {
		return err
	}
	if err = addClientUserAgent(stack, options); err != nil {
		return err
	}
	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
		return err
	}
	if err = addTimeOffsetBuild(stack, c); err != nil {
		return err
	}
	if err = addUserAgentRetryMode(stack, options); err != nil {
		return err
	}
	if err = addOpListLineageNodeHistoryValidationMiddleware(stack); err != nil {
		return err
	}
	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opListLineageNodeHistory(options.Region), middleware.Before); err != nil {
		return err
	}
	if err = addRecursionDetection(stack); 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
	}
	if err = addDisableHTTPSMiddleware(stack, options); err != nil {
		return err
	}
	return nil
}

// ListLineageNodeHistoryPaginatorOptions is the paginator options for
// ListLineageNodeHistory
type ListLineageNodeHistoryPaginatorOptions struct {
	// The maximum number of history items to return in a single call to
	// ListLineageNodeHistory. When the number of memberships to be listed is greater
	// than the value of MaxResults, the response contains a NextToken value that you
	// can use in a subsequent call to ListLineageNodeHistory to list the next set of
	// items.
	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
}

// ListLineageNodeHistoryPaginator is a paginator for ListLineageNodeHistory
type ListLineageNodeHistoryPaginator struct {
	options   ListLineageNodeHistoryPaginatorOptions
	client    ListLineageNodeHistoryAPIClient
	params    *ListLineageNodeHistoryInput
	nextToken *string
	firstPage bool
}

// NewListLineageNodeHistoryPaginator returns a new ListLineageNodeHistoryPaginator
func NewListLineageNodeHistoryPaginator(client ListLineageNodeHistoryAPIClient, params *ListLineageNodeHistoryInput, optFns ...func(*ListLineageNodeHistoryPaginatorOptions)) *ListLineageNodeHistoryPaginator {
	if params == nil {
		params = &ListLineageNodeHistoryInput{}
	}

	options := ListLineageNodeHistoryPaginatorOptions{}
	if params.MaxResults != nil {
		options.Limit = *params.MaxResults
	}

	for _, fn := range optFns {
		fn(&options)
	}

	return &ListLineageNodeHistoryPaginator{
		options:   options,
		client:    client,
		params:    params,
		firstPage: true,
		nextToken: params.NextToken,
	}
}

// HasMorePages returns a boolean indicating whether more pages are available
func (p *ListLineageNodeHistoryPaginator) HasMorePages() bool {
	return p.firstPage || (p.nextToken != nil && len(*p.nextToken) != 0)
}

// NextPage retrieves the next ListLineageNodeHistory page.
func (p *ListLineageNodeHistoryPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLineageNodeHistoryOutput, error) {
	if !p.HasMorePages() {
		return nil, fmt.Errorf("no more pages available")
	}

	params := *p.params
	params.NextToken = p.nextToken

	var limit *int32
	if p.options.Limit > 0 {
		limit = &p.options.Limit
	}
	params.MaxResults = limit

	optFns = append([]func(*Options){
		addIsPaginatorUserAgent,
	}, optFns...)
	result, err := p.client.ListLineageNodeHistory(ctx, &params, optFns...)
	if err != nil {
		return nil, err
	}
	p.firstPage = false

	prevToken := p.nextToken
	p.nextToken = result.NextToken

	if p.options.StopOnDuplicateToken &&
		prevToken != nil &&
		p.nextToken != nil &&
		*prevToken == *p.nextToken {
		p.nextToken = nil
	}

	return result, nil
}

// ListLineageNodeHistoryAPIClient is a client that implements the
// ListLineageNodeHistory operation.
type ListLineageNodeHistoryAPIClient interface {
	ListLineageNodeHistory(context.Context, *ListLineageNodeHistoryInput, ...func(*Options)) (*ListLineageNodeHistoryOutput, error)
}

var _ ListLineageNodeHistoryAPIClient = (*Client)(nil)

func newServiceMetadataMiddleware_opListLineageNodeHistory(region string) *awsmiddleware.RegisterServiceMetadata {
	return &awsmiddleware.RegisterServiceMetadata{
		Region:        region,
		ServiceID:     ServiceID,
		OperationName: "ListLineageNodeHistory",
	}
}