Debian Codegraph @

service/transcribestreamingservice/transcribestreamingserviceiface/interface.go

raw
1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
2
3 // Package transcribestreamingserviceiface provides an interface to enable mocking the Amazon Transcribe Streaming 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 transcribestreamingserviceiface
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/transcribestreamingservice"
15 )
16
17 // TranscribeStreamingServiceAPI provides an interface to enable mocking the
18 // transcribestreamingservice.TranscribeStreamingService 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 Transcribe Streaming Service.
28 // func myFunc(svc transcribestreamingserviceiface.TranscribeStreamingServiceAPI) bool {
29 // // Make svc.StartCallAnalyticsStreamTranscription request
30 // }
31 //
32 // func main() {
33 // sess := session.New()
34 // svc := transcribestreamingservice.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 mockTranscribeStreamingServiceClient struct {
43 // transcribestreamingserviceiface.TranscribeStreamingServiceAPI
44 // }
45 // func (m *mockTranscribeStreamingServiceClient) StartCallAnalyticsStreamTranscription(input *transcribestreamingservice.StartCallAnalyticsStreamTranscriptionInput) (*transcribestreamingservice.StartCallAnalyticsStreamTranscriptionOutput, error) {
46 // // mock response/functionality
47 // }
48 //
49 // func TestMyFunc(t *testing.T) {
50 // // Setup Test
51 // mockSvc := &mockTranscribeStreamingServiceClient{}
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 TranscribeStreamingServiceAPI interface {
63 StartCallAnalyticsStreamTranscription(*transcribestreamingservice.StartCallAnalyticsStreamTranscriptionInput) (*transcribestreamingservice.StartCallAnalyticsStreamTranscriptionOutput, error)
64 StartCallAnalyticsStreamTranscriptionWithContext(aws.Context, *transcribestreamingservice.StartCallAnalyticsStreamTranscriptionInput, ...request.Option) (*transcribestreamingservice.StartCallAnalyticsStreamTranscriptionOutput, error)
65 StartCallAnalyticsStreamTranscriptionRequest(*transcribestreamingservice.StartCallAnalyticsStreamTranscriptionInput) (*request.Request, *transcribestreamingservice.StartCallAnalyticsStreamTranscriptionOutput)
66
67 StartMedicalStreamTranscription(*transcribestreamingservice.StartMedicalStreamTranscriptionInput) (*transcribestreamingservice.StartMedicalStreamTranscriptionOutput, error)
68 StartMedicalStreamTranscriptionWithContext(aws.Context, *transcribestreamingservice.StartMedicalStreamTranscriptionInput, ...request.Option) (*transcribestreamingservice.StartMedicalStreamTranscriptionOutput, error)
69 StartMedicalStreamTranscriptionRequest(*transcribestreamingservice.StartMedicalStreamTranscriptionInput) (*request.Request, *transcribestreamingservice.StartMedicalStreamTranscriptionOutput)
70
71 StartStreamTranscription(*transcribestreamingservice.StartStreamTranscriptionInput) (*transcribestreamingservice.StartStreamTranscriptionOutput, error)
72 StartStreamTranscriptionWithContext(aws.Context, *transcribestreamingservice.StartStreamTranscriptionInput, ...request.Option) (*transcribestreamingservice.StartStreamTranscriptionOutput, error)
73 StartStreamTranscriptionRequest(*transcribestreamingservice.StartStreamTranscriptionInput) (*request.Request, *transcribestreamingservice.StartStreamTranscriptionOutput)
74 }
75
76 var _ TranscribeStreamingServiceAPI = (*transcribestreamingservice.TranscribeStreamingService)(nil)