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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package datapipelineiface provides an interface to enable mocking the AWS Data Pipeline 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 datapipelineiface
    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/datapipeline"
    15  )
    16  
    17  // DataPipelineAPI provides an interface to enable mocking the
    18  // datapipeline.DataPipeline 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 Data Pipeline.
    28  //    func myFunc(svc datapipelineiface.DataPipelineAPI) bool {
    29  //        // Make svc.ActivatePipeline request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := datapipeline.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 mockDataPipelineClient struct {
    43  //        datapipelineiface.DataPipelineAPI
    44  //    }
    45  //    func (m *mockDataPipelineClient) ActivatePipeline(input *datapipeline.ActivatePipelineInput) (*datapipeline.ActivatePipelineOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockDataPipelineClient{}
    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 DataPipelineAPI interface {
    63  	ActivatePipeline(*datapipeline.ActivatePipelineInput) (*datapipeline.ActivatePipelineOutput, error)
    64  	ActivatePipelineWithContext(aws.Context, *datapipeline.ActivatePipelineInput, ...request.Option) (*datapipeline.ActivatePipelineOutput, error)
    65  	ActivatePipelineRequest(*datapipeline.ActivatePipelineInput) (*request.Request, *datapipeline.ActivatePipelineOutput)
    66  
    67  	AddTags(*datapipeline.AddTagsInput) (*datapipeline.AddTagsOutput, error)
    68  	AddTagsWithContext(aws.Context, *datapipeline.AddTagsInput, ...request.Option) (*datapipeline.AddTagsOutput, error)
    69  	AddTagsRequest(*datapipeline.AddTagsInput) (*request.Request, *datapipeline.AddTagsOutput)
    70  
    71  	CreatePipeline(*datapipeline.CreatePipelineInput) (*datapipeline.CreatePipelineOutput, error)
    72  	CreatePipelineWithContext(aws.Context, *datapipeline.CreatePipelineInput, ...request.Option) (*datapipeline.CreatePipelineOutput, error)
    73  	CreatePipelineRequest(*datapipeline.CreatePipelineInput) (*request.Request, *datapipeline.CreatePipelineOutput)
    74  
    75  	DeactivatePipeline(*datapipeline.DeactivatePipelineInput) (*datapipeline.DeactivatePipelineOutput, error)
    76  	DeactivatePipelineWithContext(aws.Context, *datapipeline.DeactivatePipelineInput, ...request.Option) (*datapipeline.DeactivatePipelineOutput, error)
    77  	DeactivatePipelineRequest(*datapipeline.DeactivatePipelineInput) (*request.Request, *datapipeline.DeactivatePipelineOutput)
    78  
    79  	DeletePipeline(*datapipeline.DeletePipelineInput) (*datapipeline.DeletePipelineOutput, error)
    80  	DeletePipelineWithContext(aws.Context, *datapipeline.DeletePipelineInput, ...request.Option) (*datapipeline.DeletePipelineOutput, error)
    81  	DeletePipelineRequest(*datapipeline.DeletePipelineInput) (*request.Request, *datapipeline.DeletePipelineOutput)
    82  
    83  	DescribeObjects(*datapipeline.DescribeObjectsInput) (*datapipeline.DescribeObjectsOutput, error)
    84  	DescribeObjectsWithContext(aws.Context, *datapipeline.DescribeObjectsInput, ...request.Option) (*datapipeline.DescribeObjectsOutput, error)
    85  	DescribeObjectsRequest(*datapipeline.DescribeObjectsInput) (*request.Request, *datapipeline.DescribeObjectsOutput)
    86  
    87  	DescribeObjectsPages(*datapipeline.DescribeObjectsInput, func(*datapipeline.DescribeObjectsOutput, bool) bool) error
    88  	DescribeObjectsPagesWithContext(aws.Context, *datapipeline.DescribeObjectsInput, func(*datapipeline.DescribeObjectsOutput, bool) bool, ...request.Option) error
    89  
    90  	DescribePipelines(*datapipeline.DescribePipelinesInput) (*datapipeline.DescribePipelinesOutput, error)
    91  	DescribePipelinesWithContext(aws.Context, *datapipeline.DescribePipelinesInput, ...request.Option) (*datapipeline.DescribePipelinesOutput, error)
    92  	DescribePipelinesRequest(*datapipeline.DescribePipelinesInput) (*request.Request, *datapipeline.DescribePipelinesOutput)
    93  
    94  	EvaluateExpression(*datapipeline.EvaluateExpressionInput) (*datapipeline.EvaluateExpressionOutput, error)
    95  	EvaluateExpressionWithContext(aws.Context, *datapipeline.EvaluateExpressionInput, ...request.Option) (*datapipeline.EvaluateExpressionOutput, error)
    96  	EvaluateExpressionRequest(*datapipeline.EvaluateExpressionInput) (*request.Request, *datapipeline.EvaluateExpressionOutput)
    97  
    98  	GetPipelineDefinition(*datapipeline.GetPipelineDefinitionInput) (*datapipeline.GetPipelineDefinitionOutput, error)
    99  	GetPipelineDefinitionWithContext(aws.Context, *datapipeline.GetPipelineDefinitionInput, ...request.Option) (*datapipeline.GetPipelineDefinitionOutput, error)
   100  	GetPipelineDefinitionRequest(*datapipeline.GetPipelineDefinitionInput) (*request.Request, *datapipeline.GetPipelineDefinitionOutput)
   101  
   102  	ListPipelines(*datapipeline.ListPipelinesInput) (*datapipeline.ListPipelinesOutput, error)
   103  	ListPipelinesWithContext(aws.Context, *datapipeline.ListPipelinesInput, ...request.Option) (*datapipeline.ListPipelinesOutput, error)
   104  	ListPipelinesRequest(*datapipeline.ListPipelinesInput) (*request.Request, *datapipeline.ListPipelinesOutput)
   105  
   106  	ListPipelinesPages(*datapipeline.ListPipelinesInput, func(*datapipeline.ListPipelinesOutput, bool) bool) error
   107  	ListPipelinesPagesWithContext(aws.Context, *datapipeline.ListPipelinesInput, func(*datapipeline.ListPipelinesOutput, bool) bool, ...request.Option) error
   108  
   109  	PollForTask(*datapipeline.PollForTaskInput) (*datapipeline.PollForTaskOutput, error)
   110  	PollForTaskWithContext(aws.Context, *datapipeline.PollForTaskInput, ...request.Option) (*datapipeline.PollForTaskOutput, error)
   111  	PollForTaskRequest(*datapipeline.PollForTaskInput) (*request.Request, *datapipeline.PollForTaskOutput)
   112  
   113  	PutPipelineDefinition(*datapipeline.PutPipelineDefinitionInput) (*datapipeline.PutPipelineDefinitionOutput, error)
   114  	PutPipelineDefinitionWithContext(aws.Context, *datapipeline.PutPipelineDefinitionInput, ...request.Option) (*datapipeline.PutPipelineDefinitionOutput, error)
   115  	PutPipelineDefinitionRequest(*datapipeline.PutPipelineDefinitionInput) (*request.Request, *datapipeline.PutPipelineDefinitionOutput)
   116  
   117  	QueryObjects(*datapipeline.QueryObjectsInput) (*datapipeline.QueryObjectsOutput, error)
   118  	QueryObjectsWithContext(aws.Context, *datapipeline.QueryObjectsInput, ...request.Option) (*datapipeline.QueryObjectsOutput, error)
   119  	QueryObjectsRequest(*datapipeline.QueryObjectsInput) (*request.Request, *datapipeline.QueryObjectsOutput)
   120  
   121  	QueryObjectsPages(*datapipeline.QueryObjectsInput, func(*datapipeline.QueryObjectsOutput, bool) bool) error
   122  	QueryObjectsPagesWithContext(aws.Context, *datapipeline.QueryObjectsInput, func(*datapipeline.QueryObjectsOutput, bool) bool, ...request.Option) error
   123  
   124  	RemoveTags(*datapipeline.RemoveTagsInput) (*datapipeline.RemoveTagsOutput, error)
   125  	RemoveTagsWithContext(aws.Context, *datapipeline.RemoveTagsInput, ...request.Option) (*datapipeline.RemoveTagsOutput, error)
   126  	RemoveTagsRequest(*datapipeline.RemoveTagsInput) (*request.Request, *datapipeline.RemoveTagsOutput)
   127  
   128  	ReportTaskProgress(*datapipeline.ReportTaskProgressInput) (*datapipeline.ReportTaskProgressOutput, error)
   129  	ReportTaskProgressWithContext(aws.Context, *datapipeline.ReportTaskProgressInput, ...request.Option) (*datapipeline.ReportTaskProgressOutput, error)
   130  	ReportTaskProgressRequest(*datapipeline.ReportTaskProgressInput) (*request.Request, *datapipeline.ReportTaskProgressOutput)
   131  
   132  	ReportTaskRunnerHeartbeat(*datapipeline.ReportTaskRunnerHeartbeatInput) (*datapipeline.ReportTaskRunnerHeartbeatOutput, error)
   133  	ReportTaskRunnerHeartbeatWithContext(aws.Context, *datapipeline.ReportTaskRunnerHeartbeatInput, ...request.Option) (*datapipeline.ReportTaskRunnerHeartbeatOutput, error)
   134  	ReportTaskRunnerHeartbeatRequest(*datapipeline.ReportTaskRunnerHeartbeatInput) (*request.Request, *datapipeline.ReportTaskRunnerHeartbeatOutput)
   135  
   136  	SetStatus(*datapipeline.SetStatusInput) (*datapipeline.SetStatusOutput, error)
   137  	SetStatusWithContext(aws.Context, *datapipeline.SetStatusInput, ...request.Option) (*datapipeline.SetStatusOutput, error)
   138  	SetStatusRequest(*datapipeline.SetStatusInput) (*request.Request, *datapipeline.SetStatusOutput)
   139  
   140  	SetTaskStatus(*datapipeline.SetTaskStatusInput) (*datapipeline.SetTaskStatusOutput, error)
   141  	SetTaskStatusWithContext(aws.Context, *datapipeline.SetTaskStatusInput, ...request.Option) (*datapipeline.SetTaskStatusOutput, error)
   142  	SetTaskStatusRequest(*datapipeline.SetTaskStatusInput) (*request.Request, *datapipeline.SetTaskStatusOutput)
   143  
   144  	ValidatePipelineDefinition(*datapipeline.ValidatePipelineDefinitionInput) (*datapipeline.ValidatePipelineDefinitionOutput, error)
   145  	ValidatePipelineDefinitionWithContext(aws.Context, *datapipeline.ValidatePipelineDefinitionInput, ...request.Option) (*datapipeline.ValidatePipelineDefinitionOutput, error)
   146  	ValidatePipelineDefinitionRequest(*datapipeline.ValidatePipelineDefinitionInput) (*request.Request, *datapipeline.ValidatePipelineDefinitionOutput)
   147  }
   148  
   149  var _ DataPipelineAPI = (*datapipeline.DataPipeline)(nil)