| 1 |
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. |
| 2 |
|
| 3 |
// Package sqsiface provides an interface to enable mocking the Amazon Simple Queue 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 sqsiface |
| 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/sqs" |
| 15 |
) |
| 16 |
|
| 17 |
// SQSAPI provides an interface to enable mocking the |
| 18 |
// sqs.SQS 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 Simple Queue Service. |
| 28 |
// func myFunc(svc sqsiface.SQSAPI) bool { |
| 29 |
// // Make svc.AddPermission request |
| 30 |
// } |
| 31 |
// |
| 32 |
// func main() { |
| 33 |
// sess := session.New() |
| 34 |
// svc := sqs.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 mockSQSClient struct { |
| 43 |
// sqsiface.SQSAPI |
| 44 |
// } |
| 45 |
// func (m *mockSQSClient) AddPermission(input *sqs.AddPermissionInput) (*sqs.AddPermissionOutput, error) { |
| 46 |
// // mock response/functionality |
| 47 |
// } |
| 48 |
// |
| 49 |
// func TestMyFunc(t *testing.T) { |
| 50 |
// // Setup Test |
| 51 |
// mockSvc := &mockSQSClient{} |
| 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 SQSAPI interface { |
| 63 |
AddPermission(*sqs.AddPermissionInput) (*sqs.AddPermissionOutput, error) |
| 64 |
AddPermissionWithContext(aws.Context, *sqs.AddPermissionInput, ...request.Option) (*sqs.AddPermissionOutput, error) |
| 65 |
AddPermissionRequest(*sqs.AddPermissionInput) (*request.Request, *sqs.AddPermissionOutput) |
| 66 |
|
| 67 |
CancelMessageMoveTask(*sqs.CancelMessageMoveTaskInput) (*sqs.CancelMessageMoveTaskOutput, error) |
| 68 |
CancelMessageMoveTaskWithContext(aws.Context, *sqs.CancelMessageMoveTaskInput, ...request.Option) (*sqs.CancelMessageMoveTaskOutput, error) |
| 69 |
CancelMessageMoveTaskRequest(*sqs.CancelMessageMoveTaskInput) (*request.Request, *sqs.CancelMessageMoveTaskOutput) |
| 70 |
|
| 71 |
ChangeMessageVisibility(*sqs.ChangeMessageVisibilityInput) (*sqs.ChangeMessageVisibilityOutput, error) |
| 72 |
ChangeMessageVisibilityWithContext(aws.Context, *sqs.ChangeMessageVisibilityInput, ...request.Option) (*sqs.ChangeMessageVisibilityOutput, error) |
| 73 |
ChangeMessageVisibilityRequest(*sqs.ChangeMessageVisibilityInput) (*request.Request, *sqs.ChangeMessageVisibilityOutput) |
| 74 |
|
| 75 |
ChangeMessageVisibilityBatch(*sqs.ChangeMessageVisibilityBatchInput) (*sqs.ChangeMessageVisibilityBatchOutput, error) |
| 76 |
ChangeMessageVisibilityBatchWithContext(aws.Context, *sqs.ChangeMessageVisibilityBatchInput, ...request.Option) (*sqs.ChangeMessageVisibilityBatchOutput, error) |
| 77 |
ChangeMessageVisibilityBatchRequest(*sqs.ChangeMessageVisibilityBatchInput) (*request.Request, *sqs.ChangeMessageVisibilityBatchOutput) |
| 78 |
|
| 79 |
CreateQueue(*sqs.CreateQueueInput) (*sqs.CreateQueueOutput, error) |
| 80 |
CreateQueueWithContext(aws.Context, *sqs.CreateQueueInput, ...request.Option) (*sqs.CreateQueueOutput, error) |
| 81 |
CreateQueueRequest(*sqs.CreateQueueInput) (*request.Request, *sqs.CreateQueueOutput) |
| 82 |
|
| 83 |
DeleteMessage(*sqs.DeleteMessageInput) (*sqs.DeleteMessageOutput, error) |
| 84 |
DeleteMessageWithContext(aws.Context, *sqs.DeleteMessageInput, ...request.Option) (*sqs.DeleteMessageOutput, error) |
| 85 |
DeleteMessageRequest(*sqs.DeleteMessageInput) (*request.Request, *sqs.DeleteMessageOutput) |
| 86 |
|
| 87 |
DeleteMessageBatch(*sqs.DeleteMessageBatchInput) (*sqs.DeleteMessageBatchOutput, error) |
| 88 |
DeleteMessageBatchWithContext(aws.Context, *sqs.DeleteMessageBatchInput, ...request.Option) (*sqs.DeleteMessageBatchOutput, error) |
| 89 |
DeleteMessageBatchRequest(*sqs.DeleteMessageBatchInput) (*request.Request, *sqs.DeleteMessageBatchOutput) |
| 90 |
|
| 91 |
DeleteQueue(*sqs.DeleteQueueInput) (*sqs.DeleteQueueOutput, error) |
| 92 |
DeleteQueueWithContext(aws.Context, *sqs.DeleteQueueInput, ...request.Option) (*sqs.DeleteQueueOutput, error) |
| 93 |
DeleteQueueRequest(*sqs.DeleteQueueInput) (*request.Request, *sqs.DeleteQueueOutput) |
| 94 |
|
| 95 |
GetQueueAttributes(*sqs.GetQueueAttributesInput) (*sqs.GetQueueAttributesOutput, error) |
| 96 |
GetQueueAttributesWithContext(aws.Context, *sqs.GetQueueAttributesInput, ...request.Option) (*sqs.GetQueueAttributesOutput, error) |
| 97 |
GetQueueAttributesRequest(*sqs.GetQueueAttributesInput) (*request.Request, *sqs.GetQueueAttributesOutput) |
| 98 |
|
| 99 |
GetQueueUrl(*sqs.GetQueueUrlInput) (*sqs.GetQueueUrlOutput, error) |
| 100 |
GetQueueUrlWithContext(aws.Context, *sqs.GetQueueUrlInput, ...request.Option) (*sqs.GetQueueUrlOutput, error) |
| 101 |
GetQueueUrlRequest(*sqs.GetQueueUrlInput) (*request.Request, *sqs.GetQueueUrlOutput) |
| 102 |
|
| 103 |
ListDeadLetterSourceQueues(*sqs.ListDeadLetterSourceQueuesInput) (*sqs.ListDeadLetterSourceQueuesOutput, error) |
| 104 |
ListDeadLetterSourceQueuesWithContext(aws.Context, *sqs.ListDeadLetterSourceQueuesInput, ...request.Option) (*sqs.ListDeadLetterSourceQueuesOutput, error) |
| 105 |
ListDeadLetterSourceQueuesRequest(*sqs.ListDeadLetterSourceQueuesInput) (*request.Request, *sqs.ListDeadLetterSourceQueuesOutput) |
| 106 |
|
| 107 |
ListDeadLetterSourceQueuesPages(*sqs.ListDeadLetterSourceQueuesInput, func(*sqs.ListDeadLetterSourceQueuesOutput, bool) bool) error |
| 108 |
ListDeadLetterSourceQueuesPagesWithContext(aws.Context, *sqs.ListDeadLetterSourceQueuesInput, func(*sqs.ListDeadLetterSourceQueuesOutput, bool) bool, ...request.Option) error |
| 109 |
|
| 110 |
ListMessageMoveTasks(*sqs.ListMessageMoveTasksInput) (*sqs.ListMessageMoveTasksOutput, error) |
| 111 |
ListMessageMoveTasksWithContext(aws.Context, *sqs.ListMessageMoveTasksInput, ...request.Option) (*sqs.ListMessageMoveTasksOutput, error) |
| 112 |
ListMessageMoveTasksRequest(*sqs.ListMessageMoveTasksInput) (*request.Request, *sqs.ListMessageMoveTasksOutput) |
| 113 |
|
| 114 |
ListQueueTags(*sqs.ListQueueTagsInput) (*sqs.ListQueueTagsOutput, error) |
| 115 |
ListQueueTagsWithContext(aws.Context, *sqs.ListQueueTagsInput, ...request.Option) (*sqs.ListQueueTagsOutput, error) |
| 116 |
ListQueueTagsRequest(*sqs.ListQueueTagsInput) (*request.Request, *sqs.ListQueueTagsOutput) |
| 117 |
|
| 118 |
ListQueues(*sqs.ListQueuesInput) (*sqs.ListQueuesOutput, error) |
| 119 |
ListQueuesWithContext(aws.Context, *sqs.ListQueuesInput, ...request.Option) (*sqs.ListQueuesOutput, error) |
| 120 |
ListQueuesRequest(*sqs.ListQueuesInput) (*request.Request, *sqs.ListQueuesOutput) |
| 121 |
|
| 122 |
ListQueuesPages(*sqs.ListQueuesInput, func(*sqs.ListQueuesOutput, bool) bool) error |
| 123 |
ListQueuesPagesWithContext(aws.Context, *sqs.ListQueuesInput, func(*sqs.ListQueuesOutput, bool) bool, ...request.Option) error |
| 124 |
|
| 125 |
PurgeQueue(*sqs.PurgeQueueInput) (*sqs.PurgeQueueOutput, error) |
| 126 |
PurgeQueueWithContext(aws.Context, *sqs.PurgeQueueInput, ...request.Option) (*sqs.PurgeQueueOutput, error) |
| 127 |
PurgeQueueRequest(*sqs.PurgeQueueInput) (*request.Request, *sqs.PurgeQueueOutput) |
| 128 |
|
| 129 |
ReceiveMessage(*sqs.ReceiveMessageInput) (*sqs.ReceiveMessageOutput, error) |
| 130 |
ReceiveMessageWithContext(aws.Context, *sqs.ReceiveMessageInput, ...request.Option) (*sqs.ReceiveMessageOutput, error) |
| 131 |
ReceiveMessageRequest(*sqs.ReceiveMessageInput) (*request.Request, *sqs.ReceiveMessageOutput) |
| 132 |
|
| 133 |
RemovePermission(*sqs.RemovePermissionInput) (*sqs.RemovePermissionOutput, error) |
| 134 |
RemovePermissionWithContext(aws.Context, *sqs.RemovePermissionInput, ...request.Option) (*sqs.RemovePermissionOutput, error) |
| 135 |
RemovePermissionRequest(*sqs.RemovePermissionInput) (*request.Request, *sqs.RemovePermissionOutput) |
| 136 |
|
| 137 |
SendMessage(*sqs.SendMessageInput) (*sqs.SendMessageOutput, error) |
| 138 |
SendMessageWithContext(aws.Context, *sqs.SendMessageInput, ...request.Option) (*sqs.SendMessageOutput, error) |
| 139 |
SendMessageRequest(*sqs.SendMessageInput) (*request.Request, *sqs.SendMessageOutput) |
| 140 |
|
| 141 |
SendMessageBatch(*sqs.SendMessageBatchInput) (*sqs.SendMessageBatchOutput, error) |
| 142 |
SendMessageBatchWithContext(aws.Context, *sqs.SendMessageBatchInput, ...request.Option) (*sqs.SendMessageBatchOutput, error) |
| 143 |
SendMessageBatchRequest(*sqs.SendMessageBatchInput) (*request.Request, *sqs.SendMessageBatchOutput) |
| 144 |
|
| 145 |
SetQueueAttributes(*sqs.SetQueueAttributesInput) (*sqs.SetQueueAttributesOutput, error) |
| 146 |
SetQueueAttributesWithContext(aws.Context, *sqs.SetQueueAttributesInput, ...request.Option) (*sqs.SetQueueAttributesOutput, error) |
| 147 |
SetQueueAttributesRequest(*sqs.SetQueueAttributesInput) (*request.Request, *sqs.SetQueueAttributesOutput) |
| 148 |
|
| 149 |
StartMessageMoveTask(*sqs.StartMessageMoveTaskInput) (*sqs.StartMessageMoveTaskOutput, error) |
| 150 |
StartMessageMoveTaskWithContext(aws.Context, *sqs.StartMessageMoveTaskInput, ...request.Option) (*sqs.StartMessageMoveTaskOutput, error) |
| 151 |
StartMessageMoveTaskRequest(*sqs.StartMessageMoveTaskInput) (*request.Request, *sqs.StartMessageMoveTaskOutput) |
| 152 |
|
| 153 |
TagQueue(*sqs.TagQueueInput) (*sqs.TagQueueOutput, error) |
| 154 |
TagQueueWithContext(aws.Context, *sqs.TagQueueInput, ...request.Option) (*sqs.TagQueueOutput, error) |
| 155 |
TagQueueRequest(*sqs.TagQueueInput) (*request.Request, *sqs.TagQueueOutput) |
| 156 |
|
| 157 |
UntagQueue(*sqs.UntagQueueInput) (*sqs.UntagQueueOutput, error) |
| 158 |
UntagQueueWithContext(aws.Context, *sqs.UntagQueueInput, ...request.Option) (*sqs.UntagQueueOutput, error) |
| 159 |
UntagQueueRequest(*sqs.UntagQueueInput) (*request.Request, *sqs.UntagQueueOutput) |
| 160 |
} |
| 161 |
|
| 162 |
var _ SQSAPI = (*sqs.SQS)(nil) |