github.com/aavshr/aws-sdk-go@v1.41.3/service/iot1clickdevicesservice/iot1clickdevicesserviceiface/interface.go (about) 1 // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. 2 3 // Package iot1clickdevicesserviceiface provides an interface to enable mocking the AWS IoT 1-Click Devices 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 iot1clickdevicesserviceiface 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/iot1clickdevicesservice" 15 ) 16 17 // IoT1ClickDevicesServiceAPI provides an interface to enable mocking the 18 // iot1clickdevicesservice.IoT1ClickDevicesService 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 IoT 1-Click Devices Service. 28 // func myFunc(svc iot1clickdevicesserviceiface.IoT1ClickDevicesServiceAPI) bool { 29 // // Make svc.ClaimDevicesByClaimCode request 30 // } 31 // 32 // func main() { 33 // sess := session.New() 34 // svc := iot1clickdevicesservice.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 mockIoT1ClickDevicesServiceClient struct { 43 // iot1clickdevicesserviceiface.IoT1ClickDevicesServiceAPI 44 // } 45 // func (m *mockIoT1ClickDevicesServiceClient) ClaimDevicesByClaimCode(input *iot1clickdevicesservice.ClaimDevicesByClaimCodeInput) (*iot1clickdevicesservice.ClaimDevicesByClaimCodeOutput, error) { 46 // // mock response/functionality 47 // } 48 // 49 // func TestMyFunc(t *testing.T) { 50 // // Setup Test 51 // mockSvc := &mockIoT1ClickDevicesServiceClient{} 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 IoT1ClickDevicesServiceAPI interface { 63 ClaimDevicesByClaimCode(*iot1clickdevicesservice.ClaimDevicesByClaimCodeInput) (*iot1clickdevicesservice.ClaimDevicesByClaimCodeOutput, error) 64 ClaimDevicesByClaimCodeWithContext(aws.Context, *iot1clickdevicesservice.ClaimDevicesByClaimCodeInput, ...request.Option) (*iot1clickdevicesservice.ClaimDevicesByClaimCodeOutput, error) 65 ClaimDevicesByClaimCodeRequest(*iot1clickdevicesservice.ClaimDevicesByClaimCodeInput) (*request.Request, *iot1clickdevicesservice.ClaimDevicesByClaimCodeOutput) 66 67 DescribeDevice(*iot1clickdevicesservice.DescribeDeviceInput) (*iot1clickdevicesservice.DescribeDeviceOutput, error) 68 DescribeDeviceWithContext(aws.Context, *iot1clickdevicesservice.DescribeDeviceInput, ...request.Option) (*iot1clickdevicesservice.DescribeDeviceOutput, error) 69 DescribeDeviceRequest(*iot1clickdevicesservice.DescribeDeviceInput) (*request.Request, *iot1clickdevicesservice.DescribeDeviceOutput) 70 71 FinalizeDeviceClaim(*iot1clickdevicesservice.FinalizeDeviceClaimInput) (*iot1clickdevicesservice.FinalizeDeviceClaimOutput, error) 72 FinalizeDeviceClaimWithContext(aws.Context, *iot1clickdevicesservice.FinalizeDeviceClaimInput, ...request.Option) (*iot1clickdevicesservice.FinalizeDeviceClaimOutput, error) 73 FinalizeDeviceClaimRequest(*iot1clickdevicesservice.FinalizeDeviceClaimInput) (*request.Request, *iot1clickdevicesservice.FinalizeDeviceClaimOutput) 74 75 GetDeviceMethods(*iot1clickdevicesservice.GetDeviceMethodsInput) (*iot1clickdevicesservice.GetDeviceMethodsOutput, error) 76 GetDeviceMethodsWithContext(aws.Context, *iot1clickdevicesservice.GetDeviceMethodsInput, ...request.Option) (*iot1clickdevicesservice.GetDeviceMethodsOutput, error) 77 GetDeviceMethodsRequest(*iot1clickdevicesservice.GetDeviceMethodsInput) (*request.Request, *iot1clickdevicesservice.GetDeviceMethodsOutput) 78 79 InitiateDeviceClaim(*iot1clickdevicesservice.InitiateDeviceClaimInput) (*iot1clickdevicesservice.InitiateDeviceClaimOutput, error) 80 InitiateDeviceClaimWithContext(aws.Context, *iot1clickdevicesservice.InitiateDeviceClaimInput, ...request.Option) (*iot1clickdevicesservice.InitiateDeviceClaimOutput, error) 81 InitiateDeviceClaimRequest(*iot1clickdevicesservice.InitiateDeviceClaimInput) (*request.Request, *iot1clickdevicesservice.InitiateDeviceClaimOutput) 82 83 InvokeDeviceMethod(*iot1clickdevicesservice.InvokeDeviceMethodInput) (*iot1clickdevicesservice.InvokeDeviceMethodOutput, error) 84 InvokeDeviceMethodWithContext(aws.Context, *iot1clickdevicesservice.InvokeDeviceMethodInput, ...request.Option) (*iot1clickdevicesservice.InvokeDeviceMethodOutput, error) 85 InvokeDeviceMethodRequest(*iot1clickdevicesservice.InvokeDeviceMethodInput) (*request.Request, *iot1clickdevicesservice.InvokeDeviceMethodOutput) 86 87 ListDeviceEvents(*iot1clickdevicesservice.ListDeviceEventsInput) (*iot1clickdevicesservice.ListDeviceEventsOutput, error) 88 ListDeviceEventsWithContext(aws.Context, *iot1clickdevicesservice.ListDeviceEventsInput, ...request.Option) (*iot1clickdevicesservice.ListDeviceEventsOutput, error) 89 ListDeviceEventsRequest(*iot1clickdevicesservice.ListDeviceEventsInput) (*request.Request, *iot1clickdevicesservice.ListDeviceEventsOutput) 90 91 ListDevices(*iot1clickdevicesservice.ListDevicesInput) (*iot1clickdevicesservice.ListDevicesOutput, error) 92 ListDevicesWithContext(aws.Context, *iot1clickdevicesservice.ListDevicesInput, ...request.Option) (*iot1clickdevicesservice.ListDevicesOutput, error) 93 ListDevicesRequest(*iot1clickdevicesservice.ListDevicesInput) (*request.Request, *iot1clickdevicesservice.ListDevicesOutput) 94 95 ListTagsForResource(*iot1clickdevicesservice.ListTagsForResourceInput) (*iot1clickdevicesservice.ListTagsForResourceOutput, error) 96 ListTagsForResourceWithContext(aws.Context, *iot1clickdevicesservice.ListTagsForResourceInput, ...request.Option) (*iot1clickdevicesservice.ListTagsForResourceOutput, error) 97 ListTagsForResourceRequest(*iot1clickdevicesservice.ListTagsForResourceInput) (*request.Request, *iot1clickdevicesservice.ListTagsForResourceOutput) 98 99 TagResource(*iot1clickdevicesservice.TagResourceInput) (*iot1clickdevicesservice.TagResourceOutput, error) 100 TagResourceWithContext(aws.Context, *iot1clickdevicesservice.TagResourceInput, ...request.Option) (*iot1clickdevicesservice.TagResourceOutput, error) 101 TagResourceRequest(*iot1clickdevicesservice.TagResourceInput) (*request.Request, *iot1clickdevicesservice.TagResourceOutput) 102 103 UnclaimDevice(*iot1clickdevicesservice.UnclaimDeviceInput) (*iot1clickdevicesservice.UnclaimDeviceOutput, error) 104 UnclaimDeviceWithContext(aws.Context, *iot1clickdevicesservice.UnclaimDeviceInput, ...request.Option) (*iot1clickdevicesservice.UnclaimDeviceOutput, error) 105 UnclaimDeviceRequest(*iot1clickdevicesservice.UnclaimDeviceInput) (*request.Request, *iot1clickdevicesservice.UnclaimDeviceOutput) 106 107 UntagResource(*iot1clickdevicesservice.UntagResourceInput) (*iot1clickdevicesservice.UntagResourceOutput, error) 108 UntagResourceWithContext(aws.Context, *iot1clickdevicesservice.UntagResourceInput, ...request.Option) (*iot1clickdevicesservice.UntagResourceOutput, error) 109 UntagResourceRequest(*iot1clickdevicesservice.UntagResourceInput) (*request.Request, *iot1clickdevicesservice.UntagResourceOutput) 110 111 UpdateDeviceState(*iot1clickdevicesservice.UpdateDeviceStateInput) (*iot1clickdevicesservice.UpdateDeviceStateOutput, error) 112 UpdateDeviceStateWithContext(aws.Context, *iot1clickdevicesservice.UpdateDeviceStateInput, ...request.Option) (*iot1clickdevicesservice.UpdateDeviceStateOutput, error) 113 UpdateDeviceStateRequest(*iot1clickdevicesservice.UpdateDeviceStateInput) (*request.Request, *iot1clickdevicesservice.UpdateDeviceStateOutput) 114 } 115 116 var _ IoT1ClickDevicesServiceAPI = (*iot1clickdevicesservice.IoT1ClickDevicesService)(nil)