Debian Codegraph @

service/kinesisvideoarchivedmedia/kinesisvideoarchivedmediaiface/interface.go

raw
1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
2
3 // Package kinesisvideoarchivedmediaiface provides an interface to enable mocking the Amazon Kinesis Video Streams Archived Media 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 kinesisvideoarchivedmediaiface
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/kinesisvideoarchivedmedia"
15 )
16
17 // KinesisVideoArchivedMediaAPI provides an interface to enable mocking the
18 // kinesisvideoarchivedmedia.KinesisVideoArchivedMedia 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 Kinesis Video Streams Archived Media.
28 // func myFunc(svc kinesisvideoarchivedmediaiface.KinesisVideoArchivedMediaAPI) bool {
29 // // Make svc.GetClip request
30 // }
31 //
32 // func main() {
33 // sess := session.New()
34 // svc := kinesisvideoarchivedmedia.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 mockKinesisVideoArchivedMediaClient struct {
43 // kinesisvideoarchivedmediaiface.KinesisVideoArchivedMediaAPI
44 // }
45 // func (m *mockKinesisVideoArchivedMediaClient) GetClip(input *kinesisvideoarchivedmedia.GetClipInput) (*kinesisvideoarchivedmedia.GetClipOutput, error) {
46 // // mock response/functionality
47 // }
48 //
49 // func TestMyFunc(t *testing.T) {
50 // // Setup Test
51 // mockSvc := &mockKinesisVideoArchivedMediaClient{}
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 KinesisVideoArchivedMediaAPI interface {
63 GetClip(*kinesisvideoarchivedmedia.GetClipInput) (*kinesisvideoarchivedmedia.GetClipOutput, error)
64 GetClipWithContext(aws.Context, *kinesisvideoarchivedmedia.GetClipInput, ...request.Option) (*kinesisvideoarchivedmedia.GetClipOutput, error)
65 GetClipRequest(*kinesisvideoarchivedmedia.GetClipInput) (*request.Request, *kinesisvideoarchivedmedia.GetClipOutput)
66
67 GetDASHStreamingSessionURL(*kinesisvideoarchivedmedia.GetDASHStreamingSessionURLInput) (*kinesisvideoarchivedmedia.GetDASHStreamingSessionURLOutput, error)
68 GetDASHStreamingSessionURLWithContext(aws.Context, *kinesisvideoarchivedmedia.GetDASHStreamingSessionURLInput, ...request.Option) (*kinesisvideoarchivedmedia.GetDASHStreamingSessionURLOutput, error)
69 GetDASHStreamingSessionURLRequest(*kinesisvideoarchivedmedia.GetDASHStreamingSessionURLInput) (*request.Request, *kinesisvideoarchivedmedia.GetDASHStreamingSessionURLOutput)
70
71 GetHLSStreamingSessionURL(*kinesisvideoarchivedmedia.GetHLSStreamingSessionURLInput) (*kinesisvideoarchivedmedia.GetHLSStreamingSessionURLOutput, error)
72 GetHLSStreamingSessionURLWithContext(aws.Context, *kinesisvideoarchivedmedia.GetHLSStreamingSessionURLInput, ...request.Option) (*kinesisvideoarchivedmedia.GetHLSStreamingSessionURLOutput, error)
73 GetHLSStreamingSessionURLRequest(*kinesisvideoarchivedmedia.GetHLSStreamingSessionURLInput) (*request.Request, *kinesisvideoarchivedmedia.GetHLSStreamingSessionURLOutput)
74
75 GetImages(*kinesisvideoarchivedmedia.GetImagesInput) (*kinesisvideoarchivedmedia.GetImagesOutput, error)
76 GetImagesWithContext(aws.Context, *kinesisvideoarchivedmedia.GetImagesInput, ...request.Option) (*kinesisvideoarchivedmedia.GetImagesOutput, error)
77 GetImagesRequest(*kinesisvideoarchivedmedia.GetImagesInput) (*request.Request, *kinesisvideoarchivedmedia.GetImagesOutput)
78
79 GetImagesPages(*kinesisvideoarchivedmedia.GetImagesInput, func(*kinesisvideoarchivedmedia.GetImagesOutput, bool) bool) error
80 GetImagesPagesWithContext(aws.Context, *kinesisvideoarchivedmedia.GetImagesInput, func(*kinesisvideoarchivedmedia.GetImagesOutput, bool) bool, ...request.Option) error
81
82 GetMediaForFragmentList(*kinesisvideoarchivedmedia.GetMediaForFragmentListInput) (*kinesisvideoarchivedmedia.GetMediaForFragmentListOutput, error)
83 GetMediaForFragmentListWithContext(aws.Context, *kinesisvideoarchivedmedia.GetMediaForFragmentListInput, ...request.Option) (*kinesisvideoarchivedmedia.GetMediaForFragmentListOutput, error)
84 GetMediaForFragmentListRequest(*kinesisvideoarchivedmedia.GetMediaForFragmentListInput) (*request.Request, *kinesisvideoarchivedmedia.GetMediaForFragmentListOutput)
85
86 ListFragments(*kinesisvideoarchivedmedia.ListFragmentsInput) (*kinesisvideoarchivedmedia.ListFragmentsOutput, error)
87 ListFragmentsWithContext(aws.Context, *kinesisvideoarchivedmedia.ListFragmentsInput, ...request.Option) (*kinesisvideoarchivedmedia.ListFragmentsOutput, error)
88 ListFragmentsRequest(*kinesisvideoarchivedmedia.ListFragmentsInput) (*request.Request, *kinesisvideoarchivedmedia.ListFragmentsOutput)
89
90 ListFragmentsPages(*kinesisvideoarchivedmedia.ListFragmentsInput, func(*kinesisvideoarchivedmedia.ListFragmentsOutput, bool) bool) error
91 ListFragmentsPagesWithContext(aws.Context, *kinesisvideoarchivedmedia.ListFragmentsInput, func(*kinesisvideoarchivedmedia.ListFragmentsOutput, bool) bool, ...request.Option) error
92 }
93
94 var _ KinesisVideoArchivedMediaAPI = (*kinesisvideoarchivedmedia.KinesisVideoArchivedMedia)(nil)