1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package xray
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/xray/types"
11	"github.com/aws/smithy-go/middleware"
12	smithyhttp "github.com/aws/smithy-go/transport/http"
13)
14
15// Retrieves a list of traces specified by ID. Each trace is a collection of
16// segment documents that originates from a single request. Use GetTraceSummaries
17// to get a list of trace IDs.
18func (c *Client) BatchGetTraces(ctx context.Context, params *BatchGetTracesInput, optFns ...func(*Options)) (*BatchGetTracesOutput, error) {
19	if params == nil {
20		params = &BatchGetTracesInput{}
21	}
22
23	result, metadata, err := c.invokeOperation(ctx, "BatchGetTraces", params, optFns, addOperationBatchGetTracesMiddlewares)
24	if err != nil {
25		return nil, err
26	}
27
28	out := result.(*BatchGetTracesOutput)
29	out.ResultMetadata = metadata
30	return out, nil
31}
32
33type BatchGetTracesInput struct {
34
35	// Specify the trace IDs of requests for which to retrieve segments.
36	//
37	// This member is required.
38	TraceIds []string
39
40	// Pagination token.
41	NextToken *string
42}
43
44type BatchGetTracesOutput struct {
45
46	// Pagination token.
47	NextToken *string
48
49	// Full traces for the specified requests.
50	Traces []types.Trace
51
52	// Trace IDs of requests that haven't been processed.
53	UnprocessedTraceIds []string
54
55	// Metadata pertaining to the operation's result.
56	ResultMetadata middleware.Metadata
57}
58
59func addOperationBatchGetTracesMiddlewares(stack *middleware.Stack, options Options) (err error) {
60	err = stack.Serialize.Add(&awsRestjson1_serializeOpBatchGetTraces{}, middleware.After)
61	if err != nil {
62		return err
63	}
64	err = stack.Deserialize.Add(&awsRestjson1_deserializeOpBatchGetTraces{}, middleware.After)
65	if err != nil {
66		return err
67	}
68	if err = addSetLoggerMiddleware(stack, options); err != nil {
69		return err
70	}
71	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
72		return err
73	}
74	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
75		return err
76	}
77	if err = addResolveEndpointMiddleware(stack, options); err != nil {
78		return err
79	}
80	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
81		return err
82	}
83	if err = addRetryMiddlewares(stack, options); err != nil {
84		return err
85	}
86	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
87		return err
88	}
89	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
90		return err
91	}
92	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
93		return err
94	}
95	if err = addClientUserAgent(stack); err != nil {
96		return err
97	}
98	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
99		return err
100	}
101	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
102		return err
103	}
104	if err = addOpBatchGetTracesValidationMiddleware(stack); err != nil {
105		return err
106	}
107	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opBatchGetTraces(options.Region), middleware.Before); err != nil {
108		return err
109	}
110	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
111		return err
112	}
113	if err = addResponseErrorMiddleware(stack); err != nil {
114		return err
115	}
116	if err = addRequestResponseLogging(stack, options); err != nil {
117		return err
118	}
119	return nil
120}
121
122// BatchGetTracesAPIClient is a client that implements the BatchGetTraces
123// operation.
124type BatchGetTracesAPIClient interface {
125	BatchGetTraces(context.Context, *BatchGetTracesInput, ...func(*Options)) (*BatchGetTracesOutput, error)
126}
127
128var _ BatchGetTracesAPIClient = (*Client)(nil)
129
130// BatchGetTracesPaginatorOptions is the paginator options for BatchGetTraces
131type BatchGetTracesPaginatorOptions struct {
132	// Set to true if pagination should stop if the service returns a pagination token
133	// that matches the most recent token provided to the service.
134	StopOnDuplicateToken bool
135}
136
137// BatchGetTracesPaginator is a paginator for BatchGetTraces
138type BatchGetTracesPaginator struct {
139	options   BatchGetTracesPaginatorOptions
140	client    BatchGetTracesAPIClient
141	params    *BatchGetTracesInput
142	nextToken *string
143	firstPage bool
144}
145
146// NewBatchGetTracesPaginator returns a new BatchGetTracesPaginator
147func NewBatchGetTracesPaginator(client BatchGetTracesAPIClient, params *BatchGetTracesInput, optFns ...func(*BatchGetTracesPaginatorOptions)) *BatchGetTracesPaginator {
148	if params == nil {
149		params = &BatchGetTracesInput{}
150	}
151
152	options := BatchGetTracesPaginatorOptions{}
153
154	for _, fn := range optFns {
155		fn(&options)
156	}
157
158	return &BatchGetTracesPaginator{
159		options:   options,
160		client:    client,
161		params:    params,
162		firstPage: true,
163	}
164}
165
166// HasMorePages returns a boolean indicating whether more pages are available
167func (p *BatchGetTracesPaginator) HasMorePages() bool {
168	return p.firstPage || p.nextToken != nil
169}
170
171// NextPage retrieves the next BatchGetTraces page.
172func (p *BatchGetTracesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*BatchGetTracesOutput, error) {
173	if !p.HasMorePages() {
174		return nil, fmt.Errorf("no more pages available")
175	}
176
177	params := *p.params
178	params.NextToken = p.nextToken
179
180	result, err := p.client.BatchGetTraces(ctx, &params, optFns...)
181	if err != nil {
182		return nil, err
183	}
184	p.firstPage = false
185
186	prevToken := p.nextToken
187	p.nextToken = result.NextToken
188
189	if p.options.StopOnDuplicateToken && prevToken != nil && p.nextToken != nil && *prevToken == *p.nextToken {
190		p.nextToken = nil
191	}
192
193	return result, nil
194}
195
196func newServiceMetadataMiddleware_opBatchGetTraces(region string) *awsmiddleware.RegisterServiceMetadata {
197	return &awsmiddleware.RegisterServiceMetadata{
198		Region:        region,
199		ServiceID:     ServiceID,
200		SigningName:   "xray",
201		OperationName: "BatchGetTraces",
202	}
203}
204