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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package cloudcontrolapiiface provides an interface to enable mocking the AWS Cloud Control API 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 cloudcontrolapiiface
    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/cloudcontrolapi"
    15  )
    16  
    17  // CloudControlApiAPI provides an interface to enable mocking the
    18  // cloudcontrolapi.CloudControlApi 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 Cloud Control API.
    28  //    func myFunc(svc cloudcontrolapiiface.CloudControlApiAPI) bool {
    29  //        // Make svc.CancelResourceRequest request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := cloudcontrolapi.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 mockCloudControlApiClient struct {
    43  //        cloudcontrolapiiface.CloudControlApiAPI
    44  //    }
    45  //    func (m *mockCloudControlApiClient) CancelResourceRequest(input *cloudcontrolapi.CancelResourceRequestInput) (*cloudcontrolapi.CancelResourceRequestOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockCloudControlApiClient{}
    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 CloudControlApiAPI interface {
    63  	CancelResourceRequest(*cloudcontrolapi.CancelResourceRequestInput) (*cloudcontrolapi.CancelResourceRequestOutput, error)
    64  	CancelResourceRequestWithContext(aws.Context, *cloudcontrolapi.CancelResourceRequestInput, ...request.Option) (*cloudcontrolapi.CancelResourceRequestOutput, error)
    65  	CancelResourceRequestRequest(*cloudcontrolapi.CancelResourceRequestInput) (*request.Request, *cloudcontrolapi.CancelResourceRequestOutput)
    66  
    67  	CreateResource(*cloudcontrolapi.CreateResourceInput) (*cloudcontrolapi.CreateResourceOutput, error)
    68  	CreateResourceWithContext(aws.Context, *cloudcontrolapi.CreateResourceInput, ...request.Option) (*cloudcontrolapi.CreateResourceOutput, error)
    69  	CreateResourceRequest(*cloudcontrolapi.CreateResourceInput) (*request.Request, *cloudcontrolapi.CreateResourceOutput)
    70  
    71  	DeleteResource(*cloudcontrolapi.DeleteResourceInput) (*cloudcontrolapi.DeleteResourceOutput, error)
    72  	DeleteResourceWithContext(aws.Context, *cloudcontrolapi.DeleteResourceInput, ...request.Option) (*cloudcontrolapi.DeleteResourceOutput, error)
    73  	DeleteResourceRequest(*cloudcontrolapi.DeleteResourceInput) (*request.Request, *cloudcontrolapi.DeleteResourceOutput)
    74  
    75  	GetResource(*cloudcontrolapi.GetResourceInput) (*cloudcontrolapi.GetResourceOutput, error)
    76  	GetResourceWithContext(aws.Context, *cloudcontrolapi.GetResourceInput, ...request.Option) (*cloudcontrolapi.GetResourceOutput, error)
    77  	GetResourceRequest(*cloudcontrolapi.GetResourceInput) (*request.Request, *cloudcontrolapi.GetResourceOutput)
    78  
    79  	GetResourceRequestStatus(*cloudcontrolapi.GetResourceRequestStatusInput) (*cloudcontrolapi.GetResourceRequestStatusOutput, error)
    80  	GetResourceRequestStatusWithContext(aws.Context, *cloudcontrolapi.GetResourceRequestStatusInput, ...request.Option) (*cloudcontrolapi.GetResourceRequestStatusOutput, error)
    81  	GetResourceRequestStatusRequest(*cloudcontrolapi.GetResourceRequestStatusInput) (*request.Request, *cloudcontrolapi.GetResourceRequestStatusOutput)
    82  
    83  	ListResourceRequests(*cloudcontrolapi.ListResourceRequestsInput) (*cloudcontrolapi.ListResourceRequestsOutput, error)
    84  	ListResourceRequestsWithContext(aws.Context, *cloudcontrolapi.ListResourceRequestsInput, ...request.Option) (*cloudcontrolapi.ListResourceRequestsOutput, error)
    85  	ListResourceRequestsRequest(*cloudcontrolapi.ListResourceRequestsInput) (*request.Request, *cloudcontrolapi.ListResourceRequestsOutput)
    86  
    87  	ListResourceRequestsPages(*cloudcontrolapi.ListResourceRequestsInput, func(*cloudcontrolapi.ListResourceRequestsOutput, bool) bool) error
    88  	ListResourceRequestsPagesWithContext(aws.Context, *cloudcontrolapi.ListResourceRequestsInput, func(*cloudcontrolapi.ListResourceRequestsOutput, bool) bool, ...request.Option) error
    89  
    90  	ListResources(*cloudcontrolapi.ListResourcesInput) (*cloudcontrolapi.ListResourcesOutput, error)
    91  	ListResourcesWithContext(aws.Context, *cloudcontrolapi.ListResourcesInput, ...request.Option) (*cloudcontrolapi.ListResourcesOutput, error)
    92  	ListResourcesRequest(*cloudcontrolapi.ListResourcesInput) (*request.Request, *cloudcontrolapi.ListResourcesOutput)
    93  
    94  	ListResourcesPages(*cloudcontrolapi.ListResourcesInput, func(*cloudcontrolapi.ListResourcesOutput, bool) bool) error
    95  	ListResourcesPagesWithContext(aws.Context, *cloudcontrolapi.ListResourcesInput, func(*cloudcontrolapi.ListResourcesOutput, bool) bool, ...request.Option) error
    96  
    97  	UpdateResource(*cloudcontrolapi.UpdateResourceInput) (*cloudcontrolapi.UpdateResourceOutput, error)
    98  	UpdateResourceWithContext(aws.Context, *cloudcontrolapi.UpdateResourceInput, ...request.Option) (*cloudcontrolapi.UpdateResourceOutput, error)
    99  	UpdateResourceRequest(*cloudcontrolapi.UpdateResourceInput) (*request.Request, *cloudcontrolapi.UpdateResourceOutput)
   100  
   101  	WaitUntilResourceRequestSuccess(*cloudcontrolapi.GetResourceRequestStatusInput) error
   102  	WaitUntilResourceRequestSuccessWithContext(aws.Context, *cloudcontrolapi.GetResourceRequestStatusInput, ...request.WaiterOption) error
   103  }
   104  
   105  var _ CloudControlApiAPI = (*cloudcontrolapi.CloudControlApi)(nil)