Debian Codegraph @

service/marketplaceagreement/marketplaceagreementiface/interface.go

raw
1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
2
3 // Package marketplaceagreementiface provides an interface to enable mocking the AWS Marketplace Agreement Service service client
4 // for testing your code.
5 //
6 // It is important to note that this interface will have breaking changes
7 // when the service model is updated and adds new API operations, paginators,
8 // and waiters.
9 package marketplaceagreementiface
10
11 import (
12 "github.com/aws/aws-sdk-go/aws"
13 "github.com/aws/aws-sdk-go/aws/request"
14 "github.com/aws/aws-sdk-go/service/marketplaceagreement"
15 )
16
17 // MarketplaceAgreementAPI provides an interface to enable mocking the
18 // marketplaceagreement.MarketplaceAgreement service client's API operation,
19 // paginators, and waiters. This make unit testing your code that calls out
20 // to the SDK's service client's calls easier.
21 //
22 // The best way to use this interface is so the SDK's service client's calls
23 // can be stubbed out for unit testing your code with the SDK without needing
24 // to inject custom request handlers into the SDK's request pipeline.
25 //
26 // // myFunc uses an SDK service client to make a request to
27 // // AWS Marketplace Agreement Service.
28 // func myFunc(svc marketplaceagreementiface.MarketplaceAgreementAPI) bool {
29 // // Make svc.DescribeAgreement request
30 // }
31 //
32 // func main() {
33 // sess := session.New()
34 // svc := marketplaceagreement.New(sess)
35 //
36 // myFunc(svc)
37 // }
38 //
39 // In your _test.go file:
40 //
41 // // Define a mock struct to be used in your unit tests of myFunc.
42 // type mockMarketplaceAgreementClient struct {
43 // marketplaceagreementiface.MarketplaceAgreementAPI
44 // }
45 // func (m *mockMarketplaceAgreementClient) DescribeAgreement(input *marketplaceagreement.DescribeAgreementInput) (*marketplaceagreement.DescribeAgreementOutput, error) {
46 // // mock response/functionality
47 // }
48 //
49 // func TestMyFunc(t *testing.T) {
50 // // Setup Test
51 // mockSvc := &mockMarketplaceAgreementClient{}
52 //
53 // myfunc(mockSvc)
54 //
55 // // Verify myFunc's functionality
56 // }
57 //
58 // It is important to note that this interface will have breaking changes
59 // when the service model is updated and adds new API operations, paginators,
60 // and waiters. Its suggested to use the pattern above for testing, or using
61 // tooling to generate mocks to satisfy the interfaces.
62 type MarketplaceAgreementAPI interface {
63 DescribeAgreement(*marketplaceagreement.DescribeAgreementInput) (*marketplaceagreement.DescribeAgreementOutput, error)
64 DescribeAgreementWithContext(aws.Context, *marketplaceagreement.DescribeAgreementInput, ...request.Option) (*marketplaceagreement.DescribeAgreementOutput, error)
65 DescribeAgreementRequest(*marketplaceagreement.DescribeAgreementInput) (*request.Request, *marketplaceagreement.DescribeAgreementOutput)
66
67 GetAgreementTerms(*marketplaceagreement.GetAgreementTermsInput) (*marketplaceagreement.GetAgreementTermsOutput, error)
68 GetAgreementTermsWithContext(aws.Context, *marketplaceagreement.GetAgreementTermsInput, ...request.Option) (*marketplaceagreement.GetAgreementTermsOutput, error)
69 GetAgreementTermsRequest(*marketplaceagreement.GetAgreementTermsInput) (*request.Request, *marketplaceagreement.GetAgreementTermsOutput)
70
71 GetAgreementTermsPages(*marketplaceagreement.GetAgreementTermsInput, func(*marketplaceagreement.GetAgreementTermsOutput, bool) bool) error
72 GetAgreementTermsPagesWithContext(aws.Context, *marketplaceagreement.GetAgreementTermsInput, func(*marketplaceagreement.GetAgreementTermsOutput, bool) bool, ...request.Option) error
73
74 SearchAgreements(*marketplaceagreement.SearchAgreementsInput) (*marketplaceagreement.SearchAgreementsOutput, error)
75 SearchAgreementsWithContext(aws.Context, *marketplaceagreement.SearchAgreementsInput, ...request.Option) (*marketplaceagreement.SearchAgreementsOutput, error)
76 SearchAgreementsRequest(*marketplaceagreement.SearchAgreementsInput) (*request.Request, *marketplaceagreement.SearchAgreementsOutput)
77
78 SearchAgreementsPages(*marketplaceagreement.SearchAgreementsInput, func(*marketplaceagreement.SearchAgreementsOutput, bool) bool) error
79 SearchAgreementsPagesWithContext(aws.Context, *marketplaceagreement.SearchAgreementsInput, func(*marketplaceagreement.SearchAgreementsOutput, bool) bool, ...request.Option) error
80 }
81
82 var _ MarketplaceAgreementAPI = (*marketplaceagreement.MarketplaceAgreement)(nil)