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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package ioteventsdataiface provides an interface to enable mocking the AWS IoT Events Data 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 ioteventsdataiface
    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/ioteventsdata"
    15  )
    16  
    17  // IoTEventsDataAPI provides an interface to enable mocking the
    18  // ioteventsdata.IoTEventsData 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 Events Data.
    28  //    func myFunc(svc ioteventsdataiface.IoTEventsDataAPI) bool {
    29  //        // Make svc.BatchAcknowledgeAlarm request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := ioteventsdata.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 mockIoTEventsDataClient struct {
    43  //        ioteventsdataiface.IoTEventsDataAPI
    44  //    }
    45  //    func (m *mockIoTEventsDataClient) BatchAcknowledgeAlarm(input *ioteventsdata.BatchAcknowledgeAlarmInput) (*ioteventsdata.BatchAcknowledgeAlarmOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockIoTEventsDataClient{}
    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 IoTEventsDataAPI interface {
    63  	BatchAcknowledgeAlarm(*ioteventsdata.BatchAcknowledgeAlarmInput) (*ioteventsdata.BatchAcknowledgeAlarmOutput, error)
    64  	BatchAcknowledgeAlarmWithContext(aws.Context, *ioteventsdata.BatchAcknowledgeAlarmInput, ...request.Option) (*ioteventsdata.BatchAcknowledgeAlarmOutput, error)
    65  	BatchAcknowledgeAlarmRequest(*ioteventsdata.BatchAcknowledgeAlarmInput) (*request.Request, *ioteventsdata.BatchAcknowledgeAlarmOutput)
    66  
    67  	BatchDisableAlarm(*ioteventsdata.BatchDisableAlarmInput) (*ioteventsdata.BatchDisableAlarmOutput, error)
    68  	BatchDisableAlarmWithContext(aws.Context, *ioteventsdata.BatchDisableAlarmInput, ...request.Option) (*ioteventsdata.BatchDisableAlarmOutput, error)
    69  	BatchDisableAlarmRequest(*ioteventsdata.BatchDisableAlarmInput) (*request.Request, *ioteventsdata.BatchDisableAlarmOutput)
    70  
    71  	BatchEnableAlarm(*ioteventsdata.BatchEnableAlarmInput) (*ioteventsdata.BatchEnableAlarmOutput, error)
    72  	BatchEnableAlarmWithContext(aws.Context, *ioteventsdata.BatchEnableAlarmInput, ...request.Option) (*ioteventsdata.BatchEnableAlarmOutput, error)
    73  	BatchEnableAlarmRequest(*ioteventsdata.BatchEnableAlarmInput) (*request.Request, *ioteventsdata.BatchEnableAlarmOutput)
    74  
    75  	BatchPutMessage(*ioteventsdata.BatchPutMessageInput) (*ioteventsdata.BatchPutMessageOutput, error)
    76  	BatchPutMessageWithContext(aws.Context, *ioteventsdata.BatchPutMessageInput, ...request.Option) (*ioteventsdata.BatchPutMessageOutput, error)
    77  	BatchPutMessageRequest(*ioteventsdata.BatchPutMessageInput) (*request.Request, *ioteventsdata.BatchPutMessageOutput)
    78  
    79  	BatchResetAlarm(*ioteventsdata.BatchResetAlarmInput) (*ioteventsdata.BatchResetAlarmOutput, error)
    80  	BatchResetAlarmWithContext(aws.Context, *ioteventsdata.BatchResetAlarmInput, ...request.Option) (*ioteventsdata.BatchResetAlarmOutput, error)
    81  	BatchResetAlarmRequest(*ioteventsdata.BatchResetAlarmInput) (*request.Request, *ioteventsdata.BatchResetAlarmOutput)
    82  
    83  	BatchSnoozeAlarm(*ioteventsdata.BatchSnoozeAlarmInput) (*ioteventsdata.BatchSnoozeAlarmOutput, error)
    84  	BatchSnoozeAlarmWithContext(aws.Context, *ioteventsdata.BatchSnoozeAlarmInput, ...request.Option) (*ioteventsdata.BatchSnoozeAlarmOutput, error)
    85  	BatchSnoozeAlarmRequest(*ioteventsdata.BatchSnoozeAlarmInput) (*request.Request, *ioteventsdata.BatchSnoozeAlarmOutput)
    86  
    87  	BatchUpdateDetector(*ioteventsdata.BatchUpdateDetectorInput) (*ioteventsdata.BatchUpdateDetectorOutput, error)
    88  	BatchUpdateDetectorWithContext(aws.Context, *ioteventsdata.BatchUpdateDetectorInput, ...request.Option) (*ioteventsdata.BatchUpdateDetectorOutput, error)
    89  	BatchUpdateDetectorRequest(*ioteventsdata.BatchUpdateDetectorInput) (*request.Request, *ioteventsdata.BatchUpdateDetectorOutput)
    90  
    91  	DescribeAlarm(*ioteventsdata.DescribeAlarmInput) (*ioteventsdata.DescribeAlarmOutput, error)
    92  	DescribeAlarmWithContext(aws.Context, *ioteventsdata.DescribeAlarmInput, ...request.Option) (*ioteventsdata.DescribeAlarmOutput, error)
    93  	DescribeAlarmRequest(*ioteventsdata.DescribeAlarmInput) (*request.Request, *ioteventsdata.DescribeAlarmOutput)
    94  
    95  	DescribeDetector(*ioteventsdata.DescribeDetectorInput) (*ioteventsdata.DescribeDetectorOutput, error)
    96  	DescribeDetectorWithContext(aws.Context, *ioteventsdata.DescribeDetectorInput, ...request.Option) (*ioteventsdata.DescribeDetectorOutput, error)
    97  	DescribeDetectorRequest(*ioteventsdata.DescribeDetectorInput) (*request.Request, *ioteventsdata.DescribeDetectorOutput)
    98  
    99  	ListAlarms(*ioteventsdata.ListAlarmsInput) (*ioteventsdata.ListAlarmsOutput, error)
   100  	ListAlarmsWithContext(aws.Context, *ioteventsdata.ListAlarmsInput, ...request.Option) (*ioteventsdata.ListAlarmsOutput, error)
   101  	ListAlarmsRequest(*ioteventsdata.ListAlarmsInput) (*request.Request, *ioteventsdata.ListAlarmsOutput)
   102  
   103  	ListDetectors(*ioteventsdata.ListDetectorsInput) (*ioteventsdata.ListDetectorsOutput, error)
   104  	ListDetectorsWithContext(aws.Context, *ioteventsdata.ListDetectorsInput, ...request.Option) (*ioteventsdata.ListDetectorsOutput, error)
   105  	ListDetectorsRequest(*ioteventsdata.ListDetectorsInput) (*request.Request, *ioteventsdata.ListDetectorsOutput)
   106  }
   107  
   108  var _ IoTEventsDataAPI = (*ioteventsdata.IoTEventsData)(nil)