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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package iotanalyticsiface provides an interface to enable mocking the AWS IoT Analytics 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 iotanalyticsiface
    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/iotanalytics"
    15  )
    16  
    17  // IoTAnalyticsAPI provides an interface to enable mocking the
    18  // iotanalytics.IoTAnalytics 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 Analytics.
    28  //    func myFunc(svc iotanalyticsiface.IoTAnalyticsAPI) bool {
    29  //        // Make svc.BatchPutMessage request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := iotanalytics.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 mockIoTAnalyticsClient struct {
    43  //        iotanalyticsiface.IoTAnalyticsAPI
    44  //    }
    45  //    func (m *mockIoTAnalyticsClient) BatchPutMessage(input *iotanalytics.BatchPutMessageInput) (*iotanalytics.BatchPutMessageOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockIoTAnalyticsClient{}
    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 IoTAnalyticsAPI interface {
    63  	BatchPutMessage(*iotanalytics.BatchPutMessageInput) (*iotanalytics.BatchPutMessageOutput, error)
    64  	BatchPutMessageWithContext(aws.Context, *iotanalytics.BatchPutMessageInput, ...request.Option) (*iotanalytics.BatchPutMessageOutput, error)
    65  	BatchPutMessageRequest(*iotanalytics.BatchPutMessageInput) (*request.Request, *iotanalytics.BatchPutMessageOutput)
    66  
    67  	CancelPipelineReprocessing(*iotanalytics.CancelPipelineReprocessingInput) (*iotanalytics.CancelPipelineReprocessingOutput, error)
    68  	CancelPipelineReprocessingWithContext(aws.Context, *iotanalytics.CancelPipelineReprocessingInput, ...request.Option) (*iotanalytics.CancelPipelineReprocessingOutput, error)
    69  	CancelPipelineReprocessingRequest(*iotanalytics.CancelPipelineReprocessingInput) (*request.Request, *iotanalytics.CancelPipelineReprocessingOutput)
    70  
    71  	CreateChannel(*iotanalytics.CreateChannelInput) (*iotanalytics.CreateChannelOutput, error)
    72  	CreateChannelWithContext(aws.Context, *iotanalytics.CreateChannelInput, ...request.Option) (*iotanalytics.CreateChannelOutput, error)
    73  	CreateChannelRequest(*iotanalytics.CreateChannelInput) (*request.Request, *iotanalytics.CreateChannelOutput)
    74  
    75  	CreateDataset(*iotanalytics.CreateDatasetInput) (*iotanalytics.CreateDatasetOutput, error)
    76  	CreateDatasetWithContext(aws.Context, *iotanalytics.CreateDatasetInput, ...request.Option) (*iotanalytics.CreateDatasetOutput, error)
    77  	CreateDatasetRequest(*iotanalytics.CreateDatasetInput) (*request.Request, *iotanalytics.CreateDatasetOutput)
    78  
    79  	CreateDatasetContent(*iotanalytics.CreateDatasetContentInput) (*iotanalytics.CreateDatasetContentOutput, error)
    80  	CreateDatasetContentWithContext(aws.Context, *iotanalytics.CreateDatasetContentInput, ...request.Option) (*iotanalytics.CreateDatasetContentOutput, error)
    81  	CreateDatasetContentRequest(*iotanalytics.CreateDatasetContentInput) (*request.Request, *iotanalytics.CreateDatasetContentOutput)
    82  
    83  	CreateDatastore(*iotanalytics.CreateDatastoreInput) (*iotanalytics.CreateDatastoreOutput, error)
    84  	CreateDatastoreWithContext(aws.Context, *iotanalytics.CreateDatastoreInput, ...request.Option) (*iotanalytics.CreateDatastoreOutput, error)
    85  	CreateDatastoreRequest(*iotanalytics.CreateDatastoreInput) (*request.Request, *iotanalytics.CreateDatastoreOutput)
    86  
    87  	CreatePipeline(*iotanalytics.CreatePipelineInput) (*iotanalytics.CreatePipelineOutput, error)
    88  	CreatePipelineWithContext(aws.Context, *iotanalytics.CreatePipelineInput, ...request.Option) (*iotanalytics.CreatePipelineOutput, error)
    89  	CreatePipelineRequest(*iotanalytics.CreatePipelineInput) (*request.Request, *iotanalytics.CreatePipelineOutput)
    90  
    91  	DeleteChannel(*iotanalytics.DeleteChannelInput) (*iotanalytics.DeleteChannelOutput, error)
    92  	DeleteChannelWithContext(aws.Context, *iotanalytics.DeleteChannelInput, ...request.Option) (*iotanalytics.DeleteChannelOutput, error)
    93  	DeleteChannelRequest(*iotanalytics.DeleteChannelInput) (*request.Request, *iotanalytics.DeleteChannelOutput)
    94  
    95  	DeleteDataset(*iotanalytics.DeleteDatasetInput) (*iotanalytics.DeleteDatasetOutput, error)
    96  	DeleteDatasetWithContext(aws.Context, *iotanalytics.DeleteDatasetInput, ...request.Option) (*iotanalytics.DeleteDatasetOutput, error)
    97  	DeleteDatasetRequest(*iotanalytics.DeleteDatasetInput) (*request.Request, *iotanalytics.DeleteDatasetOutput)
    98  
    99  	DeleteDatasetContent(*iotanalytics.DeleteDatasetContentInput) (*iotanalytics.DeleteDatasetContentOutput, error)
   100  	DeleteDatasetContentWithContext(aws.Context, *iotanalytics.DeleteDatasetContentInput, ...request.Option) (*iotanalytics.DeleteDatasetContentOutput, error)
   101  	DeleteDatasetContentRequest(*iotanalytics.DeleteDatasetContentInput) (*request.Request, *iotanalytics.DeleteDatasetContentOutput)
   102  
   103  	DeleteDatastore(*iotanalytics.DeleteDatastoreInput) (*iotanalytics.DeleteDatastoreOutput, error)
   104  	DeleteDatastoreWithContext(aws.Context, *iotanalytics.DeleteDatastoreInput, ...request.Option) (*iotanalytics.DeleteDatastoreOutput, error)
   105  	DeleteDatastoreRequest(*iotanalytics.DeleteDatastoreInput) (*request.Request, *iotanalytics.DeleteDatastoreOutput)
   106  
   107  	DeletePipeline(*iotanalytics.DeletePipelineInput) (*iotanalytics.DeletePipelineOutput, error)
   108  	DeletePipelineWithContext(aws.Context, *iotanalytics.DeletePipelineInput, ...request.Option) (*iotanalytics.DeletePipelineOutput, error)
   109  	DeletePipelineRequest(*iotanalytics.DeletePipelineInput) (*request.Request, *iotanalytics.DeletePipelineOutput)
   110  
   111  	DescribeChannel(*iotanalytics.DescribeChannelInput) (*iotanalytics.DescribeChannelOutput, error)
   112  	DescribeChannelWithContext(aws.Context, *iotanalytics.DescribeChannelInput, ...request.Option) (*iotanalytics.DescribeChannelOutput, error)
   113  	DescribeChannelRequest(*iotanalytics.DescribeChannelInput) (*request.Request, *iotanalytics.DescribeChannelOutput)
   114  
   115  	DescribeDataset(*iotanalytics.DescribeDatasetInput) (*iotanalytics.DescribeDatasetOutput, error)
   116  	DescribeDatasetWithContext(aws.Context, *iotanalytics.DescribeDatasetInput, ...request.Option) (*iotanalytics.DescribeDatasetOutput, error)
   117  	DescribeDatasetRequest(*iotanalytics.DescribeDatasetInput) (*request.Request, *iotanalytics.DescribeDatasetOutput)
   118  
   119  	DescribeDatastore(*iotanalytics.DescribeDatastoreInput) (*iotanalytics.DescribeDatastoreOutput, error)
   120  	DescribeDatastoreWithContext(aws.Context, *iotanalytics.DescribeDatastoreInput, ...request.Option) (*iotanalytics.DescribeDatastoreOutput, error)
   121  	DescribeDatastoreRequest(*iotanalytics.DescribeDatastoreInput) (*request.Request, *iotanalytics.DescribeDatastoreOutput)
   122  
   123  	DescribeLoggingOptions(*iotanalytics.DescribeLoggingOptionsInput) (*iotanalytics.DescribeLoggingOptionsOutput, error)
   124  	DescribeLoggingOptionsWithContext(aws.Context, *iotanalytics.DescribeLoggingOptionsInput, ...request.Option) (*iotanalytics.DescribeLoggingOptionsOutput, error)
   125  	DescribeLoggingOptionsRequest(*iotanalytics.DescribeLoggingOptionsInput) (*request.Request, *iotanalytics.DescribeLoggingOptionsOutput)
   126  
   127  	DescribePipeline(*iotanalytics.DescribePipelineInput) (*iotanalytics.DescribePipelineOutput, error)
   128  	DescribePipelineWithContext(aws.Context, *iotanalytics.DescribePipelineInput, ...request.Option) (*iotanalytics.DescribePipelineOutput, error)
   129  	DescribePipelineRequest(*iotanalytics.DescribePipelineInput) (*request.Request, *iotanalytics.DescribePipelineOutput)
   130  
   131  	GetDatasetContent(*iotanalytics.GetDatasetContentInput) (*iotanalytics.GetDatasetContentOutput, error)
   132  	GetDatasetContentWithContext(aws.Context, *iotanalytics.GetDatasetContentInput, ...request.Option) (*iotanalytics.GetDatasetContentOutput, error)
   133  	GetDatasetContentRequest(*iotanalytics.GetDatasetContentInput) (*request.Request, *iotanalytics.GetDatasetContentOutput)
   134  
   135  	ListChannels(*iotanalytics.ListChannelsInput) (*iotanalytics.ListChannelsOutput, error)
   136  	ListChannelsWithContext(aws.Context, *iotanalytics.ListChannelsInput, ...request.Option) (*iotanalytics.ListChannelsOutput, error)
   137  	ListChannelsRequest(*iotanalytics.ListChannelsInput) (*request.Request, *iotanalytics.ListChannelsOutput)
   138  
   139  	ListChannelsPages(*iotanalytics.ListChannelsInput, func(*iotanalytics.ListChannelsOutput, bool) bool) error
   140  	ListChannelsPagesWithContext(aws.Context, *iotanalytics.ListChannelsInput, func(*iotanalytics.ListChannelsOutput, bool) bool, ...request.Option) error
   141  
   142  	ListDatasetContents(*iotanalytics.ListDatasetContentsInput) (*iotanalytics.ListDatasetContentsOutput, error)
   143  	ListDatasetContentsWithContext(aws.Context, *iotanalytics.ListDatasetContentsInput, ...request.Option) (*iotanalytics.ListDatasetContentsOutput, error)
   144  	ListDatasetContentsRequest(*iotanalytics.ListDatasetContentsInput) (*request.Request, *iotanalytics.ListDatasetContentsOutput)
   145  
   146  	ListDatasetContentsPages(*iotanalytics.ListDatasetContentsInput, func(*iotanalytics.ListDatasetContentsOutput, bool) bool) error
   147  	ListDatasetContentsPagesWithContext(aws.Context, *iotanalytics.ListDatasetContentsInput, func(*iotanalytics.ListDatasetContentsOutput, bool) bool, ...request.Option) error
   148  
   149  	ListDatasets(*iotanalytics.ListDatasetsInput) (*iotanalytics.ListDatasetsOutput, error)
   150  	ListDatasetsWithContext(aws.Context, *iotanalytics.ListDatasetsInput, ...request.Option) (*iotanalytics.ListDatasetsOutput, error)
   151  	ListDatasetsRequest(*iotanalytics.ListDatasetsInput) (*request.Request, *iotanalytics.ListDatasetsOutput)
   152  
   153  	ListDatasetsPages(*iotanalytics.ListDatasetsInput, func(*iotanalytics.ListDatasetsOutput, bool) bool) error
   154  	ListDatasetsPagesWithContext(aws.Context, *iotanalytics.ListDatasetsInput, func(*iotanalytics.ListDatasetsOutput, bool) bool, ...request.Option) error
   155  
   156  	ListDatastores(*iotanalytics.ListDatastoresInput) (*iotanalytics.ListDatastoresOutput, error)
   157  	ListDatastoresWithContext(aws.Context, *iotanalytics.ListDatastoresInput, ...request.Option) (*iotanalytics.ListDatastoresOutput, error)
   158  	ListDatastoresRequest(*iotanalytics.ListDatastoresInput) (*request.Request, *iotanalytics.ListDatastoresOutput)
   159  
   160  	ListDatastoresPages(*iotanalytics.ListDatastoresInput, func(*iotanalytics.ListDatastoresOutput, bool) bool) error
   161  	ListDatastoresPagesWithContext(aws.Context, *iotanalytics.ListDatastoresInput, func(*iotanalytics.ListDatastoresOutput, bool) bool, ...request.Option) error
   162  
   163  	ListPipelines(*iotanalytics.ListPipelinesInput) (*iotanalytics.ListPipelinesOutput, error)
   164  	ListPipelinesWithContext(aws.Context, *iotanalytics.ListPipelinesInput, ...request.Option) (*iotanalytics.ListPipelinesOutput, error)
   165  	ListPipelinesRequest(*iotanalytics.ListPipelinesInput) (*request.Request, *iotanalytics.ListPipelinesOutput)
   166  
   167  	ListPipelinesPages(*iotanalytics.ListPipelinesInput, func(*iotanalytics.ListPipelinesOutput, bool) bool) error
   168  	ListPipelinesPagesWithContext(aws.Context, *iotanalytics.ListPipelinesInput, func(*iotanalytics.ListPipelinesOutput, bool) bool, ...request.Option) error
   169  
   170  	ListTagsForResource(*iotanalytics.ListTagsForResourceInput) (*iotanalytics.ListTagsForResourceOutput, error)
   171  	ListTagsForResourceWithContext(aws.Context, *iotanalytics.ListTagsForResourceInput, ...request.Option) (*iotanalytics.ListTagsForResourceOutput, error)
   172  	ListTagsForResourceRequest(*iotanalytics.ListTagsForResourceInput) (*request.Request, *iotanalytics.ListTagsForResourceOutput)
   173  
   174  	PutLoggingOptions(*iotanalytics.PutLoggingOptionsInput) (*iotanalytics.PutLoggingOptionsOutput, error)
   175  	PutLoggingOptionsWithContext(aws.Context, *iotanalytics.PutLoggingOptionsInput, ...request.Option) (*iotanalytics.PutLoggingOptionsOutput, error)
   176  	PutLoggingOptionsRequest(*iotanalytics.PutLoggingOptionsInput) (*request.Request, *iotanalytics.PutLoggingOptionsOutput)
   177  
   178  	RunPipelineActivity(*iotanalytics.RunPipelineActivityInput) (*iotanalytics.RunPipelineActivityOutput, error)
   179  	RunPipelineActivityWithContext(aws.Context, *iotanalytics.RunPipelineActivityInput, ...request.Option) (*iotanalytics.RunPipelineActivityOutput, error)
   180  	RunPipelineActivityRequest(*iotanalytics.RunPipelineActivityInput) (*request.Request, *iotanalytics.RunPipelineActivityOutput)
   181  
   182  	SampleChannelData(*iotanalytics.SampleChannelDataInput) (*iotanalytics.SampleChannelDataOutput, error)
   183  	SampleChannelDataWithContext(aws.Context, *iotanalytics.SampleChannelDataInput, ...request.Option) (*iotanalytics.SampleChannelDataOutput, error)
   184  	SampleChannelDataRequest(*iotanalytics.SampleChannelDataInput) (*request.Request, *iotanalytics.SampleChannelDataOutput)
   185  
   186  	StartPipelineReprocessing(*iotanalytics.StartPipelineReprocessingInput) (*iotanalytics.StartPipelineReprocessingOutput, error)
   187  	StartPipelineReprocessingWithContext(aws.Context, *iotanalytics.StartPipelineReprocessingInput, ...request.Option) (*iotanalytics.StartPipelineReprocessingOutput, error)
   188  	StartPipelineReprocessingRequest(*iotanalytics.StartPipelineReprocessingInput) (*request.Request, *iotanalytics.StartPipelineReprocessingOutput)
   189  
   190  	TagResource(*iotanalytics.TagResourceInput) (*iotanalytics.TagResourceOutput, error)
   191  	TagResourceWithContext(aws.Context, *iotanalytics.TagResourceInput, ...request.Option) (*iotanalytics.TagResourceOutput, error)
   192  	TagResourceRequest(*iotanalytics.TagResourceInput) (*request.Request, *iotanalytics.TagResourceOutput)
   193  
   194  	UntagResource(*iotanalytics.UntagResourceInput) (*iotanalytics.UntagResourceOutput, error)
   195  	UntagResourceWithContext(aws.Context, *iotanalytics.UntagResourceInput, ...request.Option) (*iotanalytics.UntagResourceOutput, error)
   196  	UntagResourceRequest(*iotanalytics.UntagResourceInput) (*request.Request, *iotanalytics.UntagResourceOutput)
   197  
   198  	UpdateChannel(*iotanalytics.UpdateChannelInput) (*iotanalytics.UpdateChannelOutput, error)
   199  	UpdateChannelWithContext(aws.Context, *iotanalytics.UpdateChannelInput, ...request.Option) (*iotanalytics.UpdateChannelOutput, error)
   200  	UpdateChannelRequest(*iotanalytics.UpdateChannelInput) (*request.Request, *iotanalytics.UpdateChannelOutput)
   201  
   202  	UpdateDataset(*iotanalytics.UpdateDatasetInput) (*iotanalytics.UpdateDatasetOutput, error)
   203  	UpdateDatasetWithContext(aws.Context, *iotanalytics.UpdateDatasetInput, ...request.Option) (*iotanalytics.UpdateDatasetOutput, error)
   204  	UpdateDatasetRequest(*iotanalytics.UpdateDatasetInput) (*request.Request, *iotanalytics.UpdateDatasetOutput)
   205  
   206  	UpdateDatastore(*iotanalytics.UpdateDatastoreInput) (*iotanalytics.UpdateDatastoreOutput, error)
   207  	UpdateDatastoreWithContext(aws.Context, *iotanalytics.UpdateDatastoreInput, ...request.Option) (*iotanalytics.UpdateDatastoreOutput, error)
   208  	UpdateDatastoreRequest(*iotanalytics.UpdateDatastoreInput) (*request.Request, *iotanalytics.UpdateDatastoreOutput)
   209  
   210  	UpdatePipeline(*iotanalytics.UpdatePipelineInput) (*iotanalytics.UpdatePipelineOutput, error)
   211  	UpdatePipelineWithContext(aws.Context, *iotanalytics.UpdatePipelineInput, ...request.Option) (*iotanalytics.UpdatePipelineOutput, error)
   212  	UpdatePipelineRequest(*iotanalytics.UpdatePipelineInput) (*request.Request, *iotanalytics.UpdatePipelineOutput)
   213  }
   214  
   215  var _ IoTAnalyticsAPI = (*iotanalytics.IoTAnalytics)(nil)