github.com/aavshr/aws-sdk-go@v1.41.3/service/signer/signeriface/interface.go (about) 1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. 2 3 // Package signeriface provides an interface to enable mocking the AWS Signer 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 signeriface 10 11 import ( 12 "github.com/aavshr/aws-sdk-go/aws" 13 "github.com/aavshr/aws-sdk-go/aws/request" 14 "github.com/aavshr/aws-sdk-go/service/signer" 15 ) 16 17 // SignerAPI provides an interface to enable mocking the 18 // signer.Signer 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 Signer. 28 // func myFunc(svc signeriface.SignerAPI) bool { 29 // // Make svc.AddProfilePermission request 30 // } 31 // 32 // func main() { 33 // sess := session.New() 34 // svc := signer.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 mockSignerClient struct { 43 // signeriface.SignerAPI 44 // } 45 // func (m *mockSignerClient) AddProfilePermission(input *signer.AddProfilePermissionInput) (*signer.AddProfilePermissionOutput, error) { 46 // // mock response/functionality 47 // } 48 // 49 // func TestMyFunc(t *testing.T) { 50 // // Setup Test 51 // mockSvc := &mockSignerClient{} 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 SignerAPI interface { 63 AddProfilePermission(*signer.AddProfilePermissionInput) (*signer.AddProfilePermissionOutput, error) 64 AddProfilePermissionWithContext(aws.Context, *signer.AddProfilePermissionInput, ...request.Option) (*signer.AddProfilePermissionOutput, error) 65 AddProfilePermissionRequest(*signer.AddProfilePermissionInput) (*request.Request, *signer.AddProfilePermissionOutput) 66 67 CancelSigningProfile(*signer.CancelSigningProfileInput) (*signer.CancelSigningProfileOutput, error) 68 CancelSigningProfileWithContext(aws.Context, *signer.CancelSigningProfileInput, ...request.Option) (*signer.CancelSigningProfileOutput, error) 69 CancelSigningProfileRequest(*signer.CancelSigningProfileInput) (*request.Request, *signer.CancelSigningProfileOutput) 70 71 DescribeSigningJob(*signer.DescribeSigningJobInput) (*signer.DescribeSigningJobOutput, error) 72 DescribeSigningJobWithContext(aws.Context, *signer.DescribeSigningJobInput, ...request.Option) (*signer.DescribeSigningJobOutput, error) 73 DescribeSigningJobRequest(*signer.DescribeSigningJobInput) (*request.Request, *signer.DescribeSigningJobOutput) 74 75 GetSigningPlatform(*signer.GetSigningPlatformInput) (*signer.GetSigningPlatformOutput, error) 76 GetSigningPlatformWithContext(aws.Context, *signer.GetSigningPlatformInput, ...request.Option) (*signer.GetSigningPlatformOutput, error) 77 GetSigningPlatformRequest(*signer.GetSigningPlatformInput) (*request.Request, *signer.GetSigningPlatformOutput) 78 79 GetSigningProfile(*signer.GetSigningProfileInput) (*signer.GetSigningProfileOutput, error) 80 GetSigningProfileWithContext(aws.Context, *signer.GetSigningProfileInput, ...request.Option) (*signer.GetSigningProfileOutput, error) 81 GetSigningProfileRequest(*signer.GetSigningProfileInput) (*request.Request, *signer.GetSigningProfileOutput) 82 83 ListProfilePermissions(*signer.ListProfilePermissionsInput) (*signer.ListProfilePermissionsOutput, error) 84 ListProfilePermissionsWithContext(aws.Context, *signer.ListProfilePermissionsInput, ...request.Option) (*signer.ListProfilePermissionsOutput, error) 85 ListProfilePermissionsRequest(*signer.ListProfilePermissionsInput) (*request.Request, *signer.ListProfilePermissionsOutput) 86 87 ListSigningJobs(*signer.ListSigningJobsInput) (*signer.ListSigningJobsOutput, error) 88 ListSigningJobsWithContext(aws.Context, *signer.ListSigningJobsInput, ...request.Option) (*signer.ListSigningJobsOutput, error) 89 ListSigningJobsRequest(*signer.ListSigningJobsInput) (*request.Request, *signer.ListSigningJobsOutput) 90 91 ListSigningJobsPages(*signer.ListSigningJobsInput, func(*signer.ListSigningJobsOutput, bool) bool) error 92 ListSigningJobsPagesWithContext(aws.Context, *signer.ListSigningJobsInput, func(*signer.ListSigningJobsOutput, bool) bool, ...request.Option) error 93 94 ListSigningPlatforms(*signer.ListSigningPlatformsInput) (*signer.ListSigningPlatformsOutput, error) 95 ListSigningPlatformsWithContext(aws.Context, *signer.ListSigningPlatformsInput, ...request.Option) (*signer.ListSigningPlatformsOutput, error) 96 ListSigningPlatformsRequest(*signer.ListSigningPlatformsInput) (*request.Request, *signer.ListSigningPlatformsOutput) 97 98 ListSigningPlatformsPages(*signer.ListSigningPlatformsInput, func(*signer.ListSigningPlatformsOutput, bool) bool) error 99 ListSigningPlatformsPagesWithContext(aws.Context, *signer.ListSigningPlatformsInput, func(*signer.ListSigningPlatformsOutput, bool) bool, ...request.Option) error 100 101 ListSigningProfiles(*signer.ListSigningProfilesInput) (*signer.ListSigningProfilesOutput, error) 102 ListSigningProfilesWithContext(aws.Context, *signer.ListSigningProfilesInput, ...request.Option) (*signer.ListSigningProfilesOutput, error) 103 ListSigningProfilesRequest(*signer.ListSigningProfilesInput) (*request.Request, *signer.ListSigningProfilesOutput) 104 105 ListSigningProfilesPages(*signer.ListSigningProfilesInput, func(*signer.ListSigningProfilesOutput, bool) bool) error 106 ListSigningProfilesPagesWithContext(aws.Context, *signer.ListSigningProfilesInput, func(*signer.ListSigningProfilesOutput, bool) bool, ...request.Option) error 107 108 ListTagsForResource(*signer.ListTagsForResourceInput) (*signer.ListTagsForResourceOutput, error) 109 ListTagsForResourceWithContext(aws.Context, *signer.ListTagsForResourceInput, ...request.Option) (*signer.ListTagsForResourceOutput, error) 110 ListTagsForResourceRequest(*signer.ListTagsForResourceInput) (*request.Request, *signer.ListTagsForResourceOutput) 111 112 PutSigningProfile(*signer.PutSigningProfileInput) (*signer.PutSigningProfileOutput, error) 113 PutSigningProfileWithContext(aws.Context, *signer.PutSigningProfileInput, ...request.Option) (*signer.PutSigningProfileOutput, error) 114 PutSigningProfileRequest(*signer.PutSigningProfileInput) (*request.Request, *signer.PutSigningProfileOutput) 115 116 RemoveProfilePermission(*signer.RemoveProfilePermissionInput) (*signer.RemoveProfilePermissionOutput, error) 117 RemoveProfilePermissionWithContext(aws.Context, *signer.RemoveProfilePermissionInput, ...request.Option) (*signer.RemoveProfilePermissionOutput, error) 118 RemoveProfilePermissionRequest(*signer.RemoveProfilePermissionInput) (*request.Request, *signer.RemoveProfilePermissionOutput) 119 120 RevokeSignature(*signer.RevokeSignatureInput) (*signer.RevokeSignatureOutput, error) 121 RevokeSignatureWithContext(aws.Context, *signer.RevokeSignatureInput, ...request.Option) (*signer.RevokeSignatureOutput, error) 122 RevokeSignatureRequest(*signer.RevokeSignatureInput) (*request.Request, *signer.RevokeSignatureOutput) 123 124 RevokeSigningProfile(*signer.RevokeSigningProfileInput) (*signer.RevokeSigningProfileOutput, error) 125 RevokeSigningProfileWithContext(aws.Context, *signer.RevokeSigningProfileInput, ...request.Option) (*signer.RevokeSigningProfileOutput, error) 126 RevokeSigningProfileRequest(*signer.RevokeSigningProfileInput) (*request.Request, *signer.RevokeSigningProfileOutput) 127 128 StartSigningJob(*signer.StartSigningJobInput) (*signer.StartSigningJobOutput, error) 129 StartSigningJobWithContext(aws.Context, *signer.StartSigningJobInput, ...request.Option) (*signer.StartSigningJobOutput, error) 130 StartSigningJobRequest(*signer.StartSigningJobInput) (*request.Request, *signer.StartSigningJobOutput) 131 132 TagResource(*signer.TagResourceInput) (*signer.TagResourceOutput, error) 133 TagResourceWithContext(aws.Context, *signer.TagResourceInput, ...request.Option) (*signer.TagResourceOutput, error) 134 TagResourceRequest(*signer.TagResourceInput) (*request.Request, *signer.TagResourceOutput) 135 136 UntagResource(*signer.UntagResourceInput) (*signer.UntagResourceOutput, error) 137 UntagResourceWithContext(aws.Context, *signer.UntagResourceInput, ...request.Option) (*signer.UntagResourceOutput, error) 138 UntagResourceRequest(*signer.UntagResourceInput) (*request.Request, *signer.UntagResourceOutput) 139 140 WaitUntilSuccessfulSigningJob(*signer.DescribeSigningJobInput) error 141 WaitUntilSuccessfulSigningJobWithContext(aws.Context, *signer.DescribeSigningJobInput, ...request.WaiterOption) error 142 } 143 144 var _ SignerAPI = (*signer.Signer)(nil)