github.com/aavshr/aws-sdk-go@v1.41.3/service/iotfleethub/iotfleethubiface/interface.go (about)

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package iotfleethubiface provides an interface to enable mocking the AWS IoT Fleet Hub 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 iotfleethubiface
    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/iotfleethub"
    15  )
    16  
    17  // IoTFleetHubAPI provides an interface to enable mocking the
    18  // iotfleethub.IoTFleetHub 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 Fleet Hub.
    28  //    func myFunc(svc iotfleethubiface.IoTFleetHubAPI) bool {
    29  //        // Make svc.CreateApplication request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := iotfleethub.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 mockIoTFleetHubClient struct {
    43  //        iotfleethubiface.IoTFleetHubAPI
    44  //    }
    45  //    func (m *mockIoTFleetHubClient) CreateApplication(input *iotfleethub.CreateApplicationInput) (*iotfleethub.CreateApplicationOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockIoTFleetHubClient{}
    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 IoTFleetHubAPI interface {
    63  	CreateApplication(*iotfleethub.CreateApplicationInput) (*iotfleethub.CreateApplicationOutput, error)
    64  	CreateApplicationWithContext(aws.Context, *iotfleethub.CreateApplicationInput, ...request.Option) (*iotfleethub.CreateApplicationOutput, error)
    65  	CreateApplicationRequest(*iotfleethub.CreateApplicationInput) (*request.Request, *iotfleethub.CreateApplicationOutput)
    66  
    67  	DeleteApplication(*iotfleethub.DeleteApplicationInput) (*iotfleethub.DeleteApplicationOutput, error)
    68  	DeleteApplicationWithContext(aws.Context, *iotfleethub.DeleteApplicationInput, ...request.Option) (*iotfleethub.DeleteApplicationOutput, error)
    69  	DeleteApplicationRequest(*iotfleethub.DeleteApplicationInput) (*request.Request, *iotfleethub.DeleteApplicationOutput)
    70  
    71  	DescribeApplication(*iotfleethub.DescribeApplicationInput) (*iotfleethub.DescribeApplicationOutput, error)
    72  	DescribeApplicationWithContext(aws.Context, *iotfleethub.DescribeApplicationInput, ...request.Option) (*iotfleethub.DescribeApplicationOutput, error)
    73  	DescribeApplicationRequest(*iotfleethub.DescribeApplicationInput) (*request.Request, *iotfleethub.DescribeApplicationOutput)
    74  
    75  	ListApplications(*iotfleethub.ListApplicationsInput) (*iotfleethub.ListApplicationsOutput, error)
    76  	ListApplicationsWithContext(aws.Context, *iotfleethub.ListApplicationsInput, ...request.Option) (*iotfleethub.ListApplicationsOutput, error)
    77  	ListApplicationsRequest(*iotfleethub.ListApplicationsInput) (*request.Request, *iotfleethub.ListApplicationsOutput)
    78  
    79  	ListApplicationsPages(*iotfleethub.ListApplicationsInput, func(*iotfleethub.ListApplicationsOutput, bool) bool) error
    80  	ListApplicationsPagesWithContext(aws.Context, *iotfleethub.ListApplicationsInput, func(*iotfleethub.ListApplicationsOutput, bool) bool, ...request.Option) error
    81  
    82  	ListTagsForResource(*iotfleethub.ListTagsForResourceInput) (*iotfleethub.ListTagsForResourceOutput, error)
    83  	ListTagsForResourceWithContext(aws.Context, *iotfleethub.ListTagsForResourceInput, ...request.Option) (*iotfleethub.ListTagsForResourceOutput, error)
    84  	ListTagsForResourceRequest(*iotfleethub.ListTagsForResourceInput) (*request.Request, *iotfleethub.ListTagsForResourceOutput)
    85  
    86  	TagResource(*iotfleethub.TagResourceInput) (*iotfleethub.TagResourceOutput, error)
    87  	TagResourceWithContext(aws.Context, *iotfleethub.TagResourceInput, ...request.Option) (*iotfleethub.TagResourceOutput, error)
    88  	TagResourceRequest(*iotfleethub.TagResourceInput) (*request.Request, *iotfleethub.TagResourceOutput)
    89  
    90  	UntagResource(*iotfleethub.UntagResourceInput) (*iotfleethub.UntagResourceOutput, error)
    91  	UntagResourceWithContext(aws.Context, *iotfleethub.UntagResourceInput, ...request.Option) (*iotfleethub.UntagResourceOutput, error)
    92  	UntagResourceRequest(*iotfleethub.UntagResourceInput) (*request.Request, *iotfleethub.UntagResourceOutput)
    93  
    94  	UpdateApplication(*iotfleethub.UpdateApplicationInput) (*iotfleethub.UpdateApplicationOutput, error)
    95  	UpdateApplicationWithContext(aws.Context, *iotfleethub.UpdateApplicationInput, ...request.Option) (*iotfleethub.UpdateApplicationOutput, error)
    96  	UpdateApplicationRequest(*iotfleethub.UpdateApplicationInput) (*request.Request, *iotfleethub.UpdateApplicationOutput)
    97  }
    98  
    99  var _ IoTFleetHubAPI = (*iotfleethub.IoTFleetHub)(nil)