1// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. 2 3// Package iotjobsdataplaneiface provides an interface to enable mocking the AWS IoT Jobs Data Plane 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. 9package iotjobsdataplaneiface 10 11import ( 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/iotjobsdataplane" 15) 16 17// IoTJobsDataPlaneAPI provides an interface to enable mocking the 18// iotjobsdataplane.IoTJobsDataPlane 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 Jobs Data Plane. 28// func myFunc(svc iotjobsdataplaneiface.IoTJobsDataPlaneAPI) bool { 29// // Make svc.DescribeJobExecution request 30// } 31// 32// func main() { 33// sess := session.New() 34// svc := iotjobsdataplane.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 mockIoTJobsDataPlaneClient struct { 43// iotjobsdataplaneiface.IoTJobsDataPlaneAPI 44// } 45// func (m *mockIoTJobsDataPlaneClient) DescribeJobExecution(input *iotjobsdataplane.DescribeJobExecutionInput) (*iotjobsdataplane.DescribeJobExecutionOutput, error) { 46// // mock response/functionality 47// } 48// 49// func TestMyFunc(t *testing.T) { 50// // Setup Test 51// mockSvc := &mockIoTJobsDataPlaneClient{} 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. 62type IoTJobsDataPlaneAPI interface { 63 DescribeJobExecution(*iotjobsdataplane.DescribeJobExecutionInput) (*iotjobsdataplane.DescribeJobExecutionOutput, error) 64 DescribeJobExecutionWithContext(aws.Context, *iotjobsdataplane.DescribeJobExecutionInput, ...request.Option) (*iotjobsdataplane.DescribeJobExecutionOutput, error) 65 DescribeJobExecutionRequest(*iotjobsdataplane.DescribeJobExecutionInput) (*request.Request, *iotjobsdataplane.DescribeJobExecutionOutput) 66 67 GetPendingJobExecutions(*iotjobsdataplane.GetPendingJobExecutionsInput) (*iotjobsdataplane.GetPendingJobExecutionsOutput, error) 68 GetPendingJobExecutionsWithContext(aws.Context, *iotjobsdataplane.GetPendingJobExecutionsInput, ...request.Option) (*iotjobsdataplane.GetPendingJobExecutionsOutput, error) 69 GetPendingJobExecutionsRequest(*iotjobsdataplane.GetPendingJobExecutionsInput) (*request.Request, *iotjobsdataplane.GetPendingJobExecutionsOutput) 70 71 StartNextPendingJobExecution(*iotjobsdataplane.StartNextPendingJobExecutionInput) (*iotjobsdataplane.StartNextPendingJobExecutionOutput, error) 72 StartNextPendingJobExecutionWithContext(aws.Context, *iotjobsdataplane.StartNextPendingJobExecutionInput, ...request.Option) (*iotjobsdataplane.StartNextPendingJobExecutionOutput, error) 73 StartNextPendingJobExecutionRequest(*iotjobsdataplane.StartNextPendingJobExecutionInput) (*request.Request, *iotjobsdataplane.StartNextPendingJobExecutionOutput) 74 75 UpdateJobExecution(*iotjobsdataplane.UpdateJobExecutionInput) (*iotjobsdataplane.UpdateJobExecutionOutput, error) 76 UpdateJobExecutionWithContext(aws.Context, *iotjobsdataplane.UpdateJobExecutionInput, ...request.Option) (*iotjobsdataplane.UpdateJobExecutionOutput, error) 77 UpdateJobExecutionRequest(*iotjobsdataplane.UpdateJobExecutionInput) (*request.Request, *iotjobsdataplane.UpdateJobExecutionOutput) 78} 79 80var _ IoTJobsDataPlaneAPI = (*iotjobsdataplane.IoTJobsDataPlane)(nil) 81