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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package outpostsiface provides an interface to enable mocking the AWS Outposts 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 outpostsiface
    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/outposts"
    15  )
    16  
    17  // OutpostsAPI provides an interface to enable mocking the
    18  // outposts.Outposts 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 Outposts.
    28  //    func myFunc(svc outpostsiface.OutpostsAPI) bool {
    29  //        // Make svc.CreateOrder request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := outposts.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 mockOutpostsClient struct {
    43  //        outpostsiface.OutpostsAPI
    44  //    }
    45  //    func (m *mockOutpostsClient) CreateOrder(input *outposts.CreateOrderInput) (*outposts.CreateOrderOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockOutpostsClient{}
    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 OutpostsAPI interface {
    63  	CreateOrder(*outposts.CreateOrderInput) (*outposts.CreateOrderOutput, error)
    64  	CreateOrderWithContext(aws.Context, *outposts.CreateOrderInput, ...request.Option) (*outposts.CreateOrderOutput, error)
    65  	CreateOrderRequest(*outposts.CreateOrderInput) (*request.Request, *outposts.CreateOrderOutput)
    66  
    67  	CreateOutpost(*outposts.CreateOutpostInput) (*outposts.CreateOutpostOutput, error)
    68  	CreateOutpostWithContext(aws.Context, *outposts.CreateOutpostInput, ...request.Option) (*outposts.CreateOutpostOutput, error)
    69  	CreateOutpostRequest(*outposts.CreateOutpostInput) (*request.Request, *outposts.CreateOutpostOutput)
    70  
    71  	DeleteOutpost(*outposts.DeleteOutpostInput) (*outposts.DeleteOutpostOutput, error)
    72  	DeleteOutpostWithContext(aws.Context, *outposts.DeleteOutpostInput, ...request.Option) (*outposts.DeleteOutpostOutput, error)
    73  	DeleteOutpostRequest(*outposts.DeleteOutpostInput) (*request.Request, *outposts.DeleteOutpostOutput)
    74  
    75  	DeleteSite(*outposts.DeleteSiteInput) (*outposts.DeleteSiteOutput, error)
    76  	DeleteSiteWithContext(aws.Context, *outposts.DeleteSiteInput, ...request.Option) (*outposts.DeleteSiteOutput, error)
    77  	DeleteSiteRequest(*outposts.DeleteSiteInput) (*request.Request, *outposts.DeleteSiteOutput)
    78  
    79  	GetOutpost(*outposts.GetOutpostInput) (*outposts.GetOutpostOutput, error)
    80  	GetOutpostWithContext(aws.Context, *outposts.GetOutpostInput, ...request.Option) (*outposts.GetOutpostOutput, error)
    81  	GetOutpostRequest(*outposts.GetOutpostInput) (*request.Request, *outposts.GetOutpostOutput)
    82  
    83  	GetOutpostInstanceTypes(*outposts.GetOutpostInstanceTypesInput) (*outposts.GetOutpostInstanceTypesOutput, error)
    84  	GetOutpostInstanceTypesWithContext(aws.Context, *outposts.GetOutpostInstanceTypesInput, ...request.Option) (*outposts.GetOutpostInstanceTypesOutput, error)
    85  	GetOutpostInstanceTypesRequest(*outposts.GetOutpostInstanceTypesInput) (*request.Request, *outposts.GetOutpostInstanceTypesOutput)
    86  
    87  	ListOutposts(*outposts.ListOutpostsInput) (*outposts.ListOutpostsOutput, error)
    88  	ListOutpostsWithContext(aws.Context, *outposts.ListOutpostsInput, ...request.Option) (*outposts.ListOutpostsOutput, error)
    89  	ListOutpostsRequest(*outposts.ListOutpostsInput) (*request.Request, *outposts.ListOutpostsOutput)
    90  
    91  	ListOutpostsPages(*outposts.ListOutpostsInput, func(*outposts.ListOutpostsOutput, bool) bool) error
    92  	ListOutpostsPagesWithContext(aws.Context, *outposts.ListOutpostsInput, func(*outposts.ListOutpostsOutput, bool) bool, ...request.Option) error
    93  
    94  	ListSites(*outposts.ListSitesInput) (*outposts.ListSitesOutput, error)
    95  	ListSitesWithContext(aws.Context, *outposts.ListSitesInput, ...request.Option) (*outposts.ListSitesOutput, error)
    96  	ListSitesRequest(*outposts.ListSitesInput) (*request.Request, *outposts.ListSitesOutput)
    97  
    98  	ListSitesPages(*outposts.ListSitesInput, func(*outposts.ListSitesOutput, bool) bool) error
    99  	ListSitesPagesWithContext(aws.Context, *outposts.ListSitesInput, func(*outposts.ListSitesOutput, bool) bool, ...request.Option) error
   100  
   101  	ListTagsForResource(*outposts.ListTagsForResourceInput) (*outposts.ListTagsForResourceOutput, error)
   102  	ListTagsForResourceWithContext(aws.Context, *outposts.ListTagsForResourceInput, ...request.Option) (*outposts.ListTagsForResourceOutput, error)
   103  	ListTagsForResourceRequest(*outposts.ListTagsForResourceInput) (*request.Request, *outposts.ListTagsForResourceOutput)
   104  
   105  	TagResource(*outposts.TagResourceInput) (*outposts.TagResourceOutput, error)
   106  	TagResourceWithContext(aws.Context, *outposts.TagResourceInput, ...request.Option) (*outposts.TagResourceOutput, error)
   107  	TagResourceRequest(*outposts.TagResourceInput) (*request.Request, *outposts.TagResourceOutput)
   108  
   109  	UntagResource(*outposts.UntagResourceInput) (*outposts.UntagResourceOutput, error)
   110  	UntagResourceWithContext(aws.Context, *outposts.UntagResourceInput, ...request.Option) (*outposts.UntagResourceOutput, error)
   111  	UntagResourceRequest(*outposts.UntagResourceInput) (*request.Request, *outposts.UntagResourceOutput)
   112  }
   113  
   114  var _ OutpostsAPI = (*outposts.Outposts)(nil)