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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package autoscalingplansiface provides an interface to enable mocking the AWS Auto Scaling Plans 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 autoscalingplansiface
    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/autoscalingplans"
    15  )
    16  
    17  // AutoScalingPlansAPI provides an interface to enable mocking the
    18  // autoscalingplans.AutoScalingPlans 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 Auto Scaling Plans.
    28  //    func myFunc(svc autoscalingplansiface.AutoScalingPlansAPI) bool {
    29  //        // Make svc.CreateScalingPlan request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := autoscalingplans.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 mockAutoScalingPlansClient struct {
    43  //        autoscalingplansiface.AutoScalingPlansAPI
    44  //    }
    45  //    func (m *mockAutoScalingPlansClient) CreateScalingPlan(input *autoscalingplans.CreateScalingPlanInput) (*autoscalingplans.CreateScalingPlanOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockAutoScalingPlansClient{}
    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 AutoScalingPlansAPI interface {
    63  	CreateScalingPlan(*autoscalingplans.CreateScalingPlanInput) (*autoscalingplans.CreateScalingPlanOutput, error)
    64  	CreateScalingPlanWithContext(aws.Context, *autoscalingplans.CreateScalingPlanInput, ...request.Option) (*autoscalingplans.CreateScalingPlanOutput, error)
    65  	CreateScalingPlanRequest(*autoscalingplans.CreateScalingPlanInput) (*request.Request, *autoscalingplans.CreateScalingPlanOutput)
    66  
    67  	DeleteScalingPlan(*autoscalingplans.DeleteScalingPlanInput) (*autoscalingplans.DeleteScalingPlanOutput, error)
    68  	DeleteScalingPlanWithContext(aws.Context, *autoscalingplans.DeleteScalingPlanInput, ...request.Option) (*autoscalingplans.DeleteScalingPlanOutput, error)
    69  	DeleteScalingPlanRequest(*autoscalingplans.DeleteScalingPlanInput) (*request.Request, *autoscalingplans.DeleteScalingPlanOutput)
    70  
    71  	DescribeScalingPlanResources(*autoscalingplans.DescribeScalingPlanResourcesInput) (*autoscalingplans.DescribeScalingPlanResourcesOutput, error)
    72  	DescribeScalingPlanResourcesWithContext(aws.Context, *autoscalingplans.DescribeScalingPlanResourcesInput, ...request.Option) (*autoscalingplans.DescribeScalingPlanResourcesOutput, error)
    73  	DescribeScalingPlanResourcesRequest(*autoscalingplans.DescribeScalingPlanResourcesInput) (*request.Request, *autoscalingplans.DescribeScalingPlanResourcesOutput)
    74  
    75  	DescribeScalingPlans(*autoscalingplans.DescribeScalingPlansInput) (*autoscalingplans.DescribeScalingPlansOutput, error)
    76  	DescribeScalingPlansWithContext(aws.Context, *autoscalingplans.DescribeScalingPlansInput, ...request.Option) (*autoscalingplans.DescribeScalingPlansOutput, error)
    77  	DescribeScalingPlansRequest(*autoscalingplans.DescribeScalingPlansInput) (*request.Request, *autoscalingplans.DescribeScalingPlansOutput)
    78  
    79  	GetScalingPlanResourceForecastData(*autoscalingplans.GetScalingPlanResourceForecastDataInput) (*autoscalingplans.GetScalingPlanResourceForecastDataOutput, error)
    80  	GetScalingPlanResourceForecastDataWithContext(aws.Context, *autoscalingplans.GetScalingPlanResourceForecastDataInput, ...request.Option) (*autoscalingplans.GetScalingPlanResourceForecastDataOutput, error)
    81  	GetScalingPlanResourceForecastDataRequest(*autoscalingplans.GetScalingPlanResourceForecastDataInput) (*request.Request, *autoscalingplans.GetScalingPlanResourceForecastDataOutput)
    82  
    83  	UpdateScalingPlan(*autoscalingplans.UpdateScalingPlanInput) (*autoscalingplans.UpdateScalingPlanOutput, error)
    84  	UpdateScalingPlanWithContext(aws.Context, *autoscalingplans.UpdateScalingPlanInput, ...request.Option) (*autoscalingplans.UpdateScalingPlanOutput, error)
    85  	UpdateScalingPlanRequest(*autoscalingplans.UpdateScalingPlanInput) (*request.Request, *autoscalingplans.UpdateScalingPlanOutput)
    86  }
    87  
    88  var _ AutoScalingPlansAPI = (*autoscalingplans.AutoScalingPlans)(nil)