forked from aws/aws-sdk-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
interface.go
128 lines (108 loc) · 7.63 KB
/
interface.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
// Package syntheticsiface provides an interface to enable mocking the Synthetics service client
// for testing your code.
//
// It is important to note that this interface will have breaking changes
// when the service model is updated and adds new API operations, paginators,
// and waiters.
package syntheticsiface
import (
"github.com/aavshr/aws-sdk-go/aws"
"github.com/aavshr/aws-sdk-go/aws/request"
"github.com/aavshr/aws-sdk-go/service/synthetics"
)
// SyntheticsAPI provides an interface to enable mocking the
// synthetics.Synthetics service client's API operation,
// paginators, and waiters. This make unit testing your code that calls out
// to the SDK's service client's calls easier.
//
// The best way to use this interface is so the SDK's service client's calls
// can be stubbed out for unit testing your code with the SDK without needing
// to inject custom request handlers into the SDK's request pipeline.
//
// // myFunc uses an SDK service client to make a request to
// // Synthetics.
// func myFunc(svc syntheticsiface.SyntheticsAPI) bool {
// // Make svc.CreateCanary request
// }
//
// func main() {
// sess := session.New()
// svc := synthetics.New(sess)
//
// myFunc(svc)
// }
//
// In your _test.go file:
//
// // Define a mock struct to be used in your unit tests of myFunc.
// type mockSyntheticsClient struct {
// syntheticsiface.SyntheticsAPI
// }
// func (m *mockSyntheticsClient) CreateCanary(input *synthetics.CreateCanaryInput) (*synthetics.CreateCanaryOutput, error) {
// // mock response/functionality
// }
//
// func TestMyFunc(t *testing.T) {
// // Setup Test
// mockSvc := &mockSyntheticsClient{}
//
// myfunc(mockSvc)
//
// // Verify myFunc's functionality
// }
//
// It is important to note that this interface will have breaking changes
// when the service model is updated and adds new API operations, paginators,
// and waiters. Its suggested to use the pattern above for testing, or using
// tooling to generate mocks to satisfy the interfaces.
type SyntheticsAPI interface {
CreateCanary(*synthetics.CreateCanaryInput) (*synthetics.CreateCanaryOutput, error)
CreateCanaryWithContext(aws.Context, *synthetics.CreateCanaryInput, ...request.Option) (*synthetics.CreateCanaryOutput, error)
CreateCanaryRequest(*synthetics.CreateCanaryInput) (*request.Request, *synthetics.CreateCanaryOutput)
DeleteCanary(*synthetics.DeleteCanaryInput) (*synthetics.DeleteCanaryOutput, error)
DeleteCanaryWithContext(aws.Context, *synthetics.DeleteCanaryInput, ...request.Option) (*synthetics.DeleteCanaryOutput, error)
DeleteCanaryRequest(*synthetics.DeleteCanaryInput) (*request.Request, *synthetics.DeleteCanaryOutput)
DescribeCanaries(*synthetics.DescribeCanariesInput) (*synthetics.DescribeCanariesOutput, error)
DescribeCanariesWithContext(aws.Context, *synthetics.DescribeCanariesInput, ...request.Option) (*synthetics.DescribeCanariesOutput, error)
DescribeCanariesRequest(*synthetics.DescribeCanariesInput) (*request.Request, *synthetics.DescribeCanariesOutput)
DescribeCanariesPages(*synthetics.DescribeCanariesInput, func(*synthetics.DescribeCanariesOutput, bool) bool) error
DescribeCanariesPagesWithContext(aws.Context, *synthetics.DescribeCanariesInput, func(*synthetics.DescribeCanariesOutput, bool) bool, ...request.Option) error
DescribeCanariesLastRun(*synthetics.DescribeCanariesLastRunInput) (*synthetics.DescribeCanariesLastRunOutput, error)
DescribeCanariesLastRunWithContext(aws.Context, *synthetics.DescribeCanariesLastRunInput, ...request.Option) (*synthetics.DescribeCanariesLastRunOutput, error)
DescribeCanariesLastRunRequest(*synthetics.DescribeCanariesLastRunInput) (*request.Request, *synthetics.DescribeCanariesLastRunOutput)
DescribeCanariesLastRunPages(*synthetics.DescribeCanariesLastRunInput, func(*synthetics.DescribeCanariesLastRunOutput, bool) bool) error
DescribeCanariesLastRunPagesWithContext(aws.Context, *synthetics.DescribeCanariesLastRunInput, func(*synthetics.DescribeCanariesLastRunOutput, bool) bool, ...request.Option) error
DescribeRuntimeVersions(*synthetics.DescribeRuntimeVersionsInput) (*synthetics.DescribeRuntimeVersionsOutput, error)
DescribeRuntimeVersionsWithContext(aws.Context, *synthetics.DescribeRuntimeVersionsInput, ...request.Option) (*synthetics.DescribeRuntimeVersionsOutput, error)
DescribeRuntimeVersionsRequest(*synthetics.DescribeRuntimeVersionsInput) (*request.Request, *synthetics.DescribeRuntimeVersionsOutput)
DescribeRuntimeVersionsPages(*synthetics.DescribeRuntimeVersionsInput, func(*synthetics.DescribeRuntimeVersionsOutput, bool) bool) error
DescribeRuntimeVersionsPagesWithContext(aws.Context, *synthetics.DescribeRuntimeVersionsInput, func(*synthetics.DescribeRuntimeVersionsOutput, bool) bool, ...request.Option) error
GetCanary(*synthetics.GetCanaryInput) (*synthetics.GetCanaryOutput, error)
GetCanaryWithContext(aws.Context, *synthetics.GetCanaryInput, ...request.Option) (*synthetics.GetCanaryOutput, error)
GetCanaryRequest(*synthetics.GetCanaryInput) (*request.Request, *synthetics.GetCanaryOutput)
GetCanaryRuns(*synthetics.GetCanaryRunsInput) (*synthetics.GetCanaryRunsOutput, error)
GetCanaryRunsWithContext(aws.Context, *synthetics.GetCanaryRunsInput, ...request.Option) (*synthetics.GetCanaryRunsOutput, error)
GetCanaryRunsRequest(*synthetics.GetCanaryRunsInput) (*request.Request, *synthetics.GetCanaryRunsOutput)
GetCanaryRunsPages(*synthetics.GetCanaryRunsInput, func(*synthetics.GetCanaryRunsOutput, bool) bool) error
GetCanaryRunsPagesWithContext(aws.Context, *synthetics.GetCanaryRunsInput, func(*synthetics.GetCanaryRunsOutput, bool) bool, ...request.Option) error
ListTagsForResource(*synthetics.ListTagsForResourceInput) (*synthetics.ListTagsForResourceOutput, error)
ListTagsForResourceWithContext(aws.Context, *synthetics.ListTagsForResourceInput, ...request.Option) (*synthetics.ListTagsForResourceOutput, error)
ListTagsForResourceRequest(*synthetics.ListTagsForResourceInput) (*request.Request, *synthetics.ListTagsForResourceOutput)
StartCanary(*synthetics.StartCanaryInput) (*synthetics.StartCanaryOutput, error)
StartCanaryWithContext(aws.Context, *synthetics.StartCanaryInput, ...request.Option) (*synthetics.StartCanaryOutput, error)
StartCanaryRequest(*synthetics.StartCanaryInput) (*request.Request, *synthetics.StartCanaryOutput)
StopCanary(*synthetics.StopCanaryInput) (*synthetics.StopCanaryOutput, error)
StopCanaryWithContext(aws.Context, *synthetics.StopCanaryInput, ...request.Option) (*synthetics.StopCanaryOutput, error)
StopCanaryRequest(*synthetics.StopCanaryInput) (*request.Request, *synthetics.StopCanaryOutput)
TagResource(*synthetics.TagResourceInput) (*synthetics.TagResourceOutput, error)
TagResourceWithContext(aws.Context, *synthetics.TagResourceInput, ...request.Option) (*synthetics.TagResourceOutput, error)
TagResourceRequest(*synthetics.TagResourceInput) (*request.Request, *synthetics.TagResourceOutput)
UntagResource(*synthetics.UntagResourceInput) (*synthetics.UntagResourceOutput, error)
UntagResourceWithContext(aws.Context, *synthetics.UntagResourceInput, ...request.Option) (*synthetics.UntagResourceOutput, error)
UntagResourceRequest(*synthetics.UntagResourceInput) (*request.Request, *synthetics.UntagResourceOutput)
UpdateCanary(*synthetics.UpdateCanaryInput) (*synthetics.UpdateCanaryOutput, error)
UpdateCanaryWithContext(aws.Context, *synthetics.UpdateCanaryInput, ...request.Option) (*synthetics.UpdateCanaryOutput, error)
UpdateCanaryRequest(*synthetics.UpdateCanaryInput) (*request.Request, *synthetics.UpdateCanaryOutput)
}
var _ SyntheticsAPI = (*synthetics.Synthetics)(nil)