Debian Codegraph @

service/polly/pollyiface/interface.go

raw
1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
2
3 // Package pollyiface provides an interface to enable mocking the Amazon Polly 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 pollyiface
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/polly"
15 )
16
17 // PollyAPI provides an interface to enable mocking the
18 // polly.Polly 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 // // Amazon Polly.
28 // func myFunc(svc pollyiface.PollyAPI) bool {
29 // // Make svc.DeleteLexicon request
30 // }
31 //
32 // func main() {
33 // sess := session.New()
34 // svc := polly.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 mockPollyClient struct {
43 // pollyiface.PollyAPI
44 // }
45 // func (m *mockPollyClient) DeleteLexicon(input *polly.DeleteLexiconInput) (*polly.DeleteLexiconOutput, error) {
46 // // mock response/functionality
47 // }
48 //
49 // func TestMyFunc(t *testing.T) {
50 // // Setup Test
51 // mockSvc := &mockPollyClient{}
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 PollyAPI interface {
63 DeleteLexicon(*polly.DeleteLexiconInput) (*polly.DeleteLexiconOutput, error)
64 DeleteLexiconWithContext(aws.Context, *polly.DeleteLexiconInput, ...request.Option) (*polly.DeleteLexiconOutput, error)
65 DeleteLexiconRequest(*polly.DeleteLexiconInput) (*request.Request, *polly.DeleteLexiconOutput)
66
67 DescribeVoices(*polly.DescribeVoicesInput) (*polly.DescribeVoicesOutput, error)
68 DescribeVoicesWithContext(aws.Context, *polly.DescribeVoicesInput, ...request.Option) (*polly.DescribeVoicesOutput, error)
69 DescribeVoicesRequest(*polly.DescribeVoicesInput) (*request.Request, *polly.DescribeVoicesOutput)
70
71 GetLexicon(*polly.GetLexiconInput) (*polly.GetLexiconOutput, error)
72 GetLexiconWithContext(aws.Context, *polly.GetLexiconInput, ...request.Option) (*polly.GetLexiconOutput, error)
73 GetLexiconRequest(*polly.GetLexiconInput) (*request.Request, *polly.GetLexiconOutput)
74
75 GetSpeechSynthesisTask(*polly.GetSpeechSynthesisTaskInput) (*polly.GetSpeechSynthesisTaskOutput, error)
76 GetSpeechSynthesisTaskWithContext(aws.Context, *polly.GetSpeechSynthesisTaskInput, ...request.Option) (*polly.GetSpeechSynthesisTaskOutput, error)
77 GetSpeechSynthesisTaskRequest(*polly.GetSpeechSynthesisTaskInput) (*request.Request, *polly.GetSpeechSynthesisTaskOutput)
78
79 ListLexicons(*polly.ListLexiconsInput) (*polly.ListLexiconsOutput, error)
80 ListLexiconsWithContext(aws.Context, *polly.ListLexiconsInput, ...request.Option) (*polly.ListLexiconsOutput, error)
81 ListLexiconsRequest(*polly.ListLexiconsInput) (*request.Request, *polly.ListLexiconsOutput)
82
83 ListSpeechSynthesisTasks(*polly.ListSpeechSynthesisTasksInput) (*polly.ListSpeechSynthesisTasksOutput, error)
84 ListSpeechSynthesisTasksWithContext(aws.Context, *polly.ListSpeechSynthesisTasksInput, ...request.Option) (*polly.ListSpeechSynthesisTasksOutput, error)
85 ListSpeechSynthesisTasksRequest(*polly.ListSpeechSynthesisTasksInput) (*request.Request, *polly.ListSpeechSynthesisTasksOutput)
86
87 ListSpeechSynthesisTasksPages(*polly.ListSpeechSynthesisTasksInput, func(*polly.ListSpeechSynthesisTasksOutput, bool) bool) error
88 ListSpeechSynthesisTasksPagesWithContext(aws.Context, *polly.ListSpeechSynthesisTasksInput, func(*polly.ListSpeechSynthesisTasksOutput, bool) bool, ...request.Option) error
89
90 PutLexicon(*polly.PutLexiconInput) (*polly.PutLexiconOutput, error)
91 PutLexiconWithContext(aws.Context, *polly.PutLexiconInput, ...request.Option) (*polly.PutLexiconOutput, error)
92 PutLexiconRequest(*polly.PutLexiconInput) (*request.Request, *polly.PutLexiconOutput)
93
94 StartSpeechSynthesisTask(*polly.StartSpeechSynthesisTaskInput) (*polly.StartSpeechSynthesisTaskOutput, error)
95 StartSpeechSynthesisTaskWithContext(aws.Context, *polly.StartSpeechSynthesisTaskInput, ...request.Option) (*polly.StartSpeechSynthesisTaskOutput, error)
96 StartSpeechSynthesisTaskRequest(*polly.StartSpeechSynthesisTaskInput) (*request.Request, *polly.StartSpeechSynthesisTaskOutput)
97
98 SynthesizeSpeech(*polly.SynthesizeSpeechInput) (*polly.SynthesizeSpeechOutput, error)
99 SynthesizeSpeechWithContext(aws.Context, *polly.SynthesizeSpeechInput, ...request.Option) (*polly.SynthesizeSpeechOutput, error)
100 SynthesizeSpeechRequest(*polly.SynthesizeSpeechInput) (*request.Request, *polly.SynthesizeSpeechOutput)
101 }
102
103 var _ PollyAPI = (*polly.Polly)(nil)