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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package iotdataplaneiface provides an interface to enable mocking the AWS IoT 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.
     9  package iotdataplaneiface
    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/iotdataplane"
    15  )
    16  
    17  // IoTDataPlaneAPI provides an interface to enable mocking the
    18  // iotdataplane.IoTDataPlane 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 Data Plane.
    28  //    func myFunc(svc iotdataplaneiface.IoTDataPlaneAPI) bool {
    29  //        // Make svc.DeleteThingShadow request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := iotdataplane.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 mockIoTDataPlaneClient struct {
    43  //        iotdataplaneiface.IoTDataPlaneAPI
    44  //    }
    45  //    func (m *mockIoTDataPlaneClient) DeleteThingShadow(input *iotdataplane.DeleteThingShadowInput) (*iotdataplane.DeleteThingShadowOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockIoTDataPlaneClient{}
    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 IoTDataPlaneAPI interface {
    63  	DeleteThingShadow(*iotdataplane.DeleteThingShadowInput) (*iotdataplane.DeleteThingShadowOutput, error)
    64  	DeleteThingShadowWithContext(aws.Context, *iotdataplane.DeleteThingShadowInput, ...request.Option) (*iotdataplane.DeleteThingShadowOutput, error)
    65  	DeleteThingShadowRequest(*iotdataplane.DeleteThingShadowInput) (*request.Request, *iotdataplane.DeleteThingShadowOutput)
    66  
    67  	GetRetainedMessage(*iotdataplane.GetRetainedMessageInput) (*iotdataplane.GetRetainedMessageOutput, error)
    68  	GetRetainedMessageWithContext(aws.Context, *iotdataplane.GetRetainedMessageInput, ...request.Option) (*iotdataplane.GetRetainedMessageOutput, error)
    69  	GetRetainedMessageRequest(*iotdataplane.GetRetainedMessageInput) (*request.Request, *iotdataplane.GetRetainedMessageOutput)
    70  
    71  	GetThingShadow(*iotdataplane.GetThingShadowInput) (*iotdataplane.GetThingShadowOutput, error)
    72  	GetThingShadowWithContext(aws.Context, *iotdataplane.GetThingShadowInput, ...request.Option) (*iotdataplane.GetThingShadowOutput, error)
    73  	GetThingShadowRequest(*iotdataplane.GetThingShadowInput) (*request.Request, *iotdataplane.GetThingShadowOutput)
    74  
    75  	ListNamedShadowsForThing(*iotdataplane.ListNamedShadowsForThingInput) (*iotdataplane.ListNamedShadowsForThingOutput, error)
    76  	ListNamedShadowsForThingWithContext(aws.Context, *iotdataplane.ListNamedShadowsForThingInput, ...request.Option) (*iotdataplane.ListNamedShadowsForThingOutput, error)
    77  	ListNamedShadowsForThingRequest(*iotdataplane.ListNamedShadowsForThingInput) (*request.Request, *iotdataplane.ListNamedShadowsForThingOutput)
    78  
    79  	ListRetainedMessages(*iotdataplane.ListRetainedMessagesInput) (*iotdataplane.ListRetainedMessagesOutput, error)
    80  	ListRetainedMessagesWithContext(aws.Context, *iotdataplane.ListRetainedMessagesInput, ...request.Option) (*iotdataplane.ListRetainedMessagesOutput, error)
    81  	ListRetainedMessagesRequest(*iotdataplane.ListRetainedMessagesInput) (*request.Request, *iotdataplane.ListRetainedMessagesOutput)
    82  
    83  	ListRetainedMessagesPages(*iotdataplane.ListRetainedMessagesInput, func(*iotdataplane.ListRetainedMessagesOutput, bool) bool) error
    84  	ListRetainedMessagesPagesWithContext(aws.Context, *iotdataplane.ListRetainedMessagesInput, func(*iotdataplane.ListRetainedMessagesOutput, bool) bool, ...request.Option) error
    85  
    86  	Publish(*iotdataplane.PublishInput) (*iotdataplane.PublishOutput, error)
    87  	PublishWithContext(aws.Context, *iotdataplane.PublishInput, ...request.Option) (*iotdataplane.PublishOutput, error)
    88  	PublishRequest(*iotdataplane.PublishInput) (*request.Request, *iotdataplane.PublishOutput)
    89  
    90  	UpdateThingShadow(*iotdataplane.UpdateThingShadowInput) (*iotdataplane.UpdateThingShadowOutput, error)
    91  	UpdateThingShadowWithContext(aws.Context, *iotdataplane.UpdateThingShadowInput, ...request.Option) (*iotdataplane.UpdateThingShadowOutput, error)
    92  	UpdateThingShadowRequest(*iotdataplane.UpdateThingShadowInput) (*request.Request, *iotdataplane.UpdateThingShadowOutput)
    93  }
    94  
    95  var _ IoTDataPlaneAPI = (*iotdataplane.IoTDataPlane)(nil)