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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package budgetsiface provides an interface to enable mocking the AWS Budgets 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 budgetsiface
    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/budgets"
    15  )
    16  
    17  // BudgetsAPI provides an interface to enable mocking the
    18  // budgets.Budgets 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 Budgets.
    28  //    func myFunc(svc budgetsiface.BudgetsAPI) bool {
    29  //        // Make svc.CreateBudget request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := budgets.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 mockBudgetsClient struct {
    43  //        budgetsiface.BudgetsAPI
    44  //    }
    45  //    func (m *mockBudgetsClient) CreateBudget(input *budgets.CreateBudgetInput) (*budgets.CreateBudgetOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockBudgetsClient{}
    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 BudgetsAPI interface {
    63  	CreateBudget(*budgets.CreateBudgetInput) (*budgets.CreateBudgetOutput, error)
    64  	CreateBudgetWithContext(aws.Context, *budgets.CreateBudgetInput, ...request.Option) (*budgets.CreateBudgetOutput, error)
    65  	CreateBudgetRequest(*budgets.CreateBudgetInput) (*request.Request, *budgets.CreateBudgetOutput)
    66  
    67  	CreateBudgetAction(*budgets.CreateBudgetActionInput) (*budgets.CreateBudgetActionOutput, error)
    68  	CreateBudgetActionWithContext(aws.Context, *budgets.CreateBudgetActionInput, ...request.Option) (*budgets.CreateBudgetActionOutput, error)
    69  	CreateBudgetActionRequest(*budgets.CreateBudgetActionInput) (*request.Request, *budgets.CreateBudgetActionOutput)
    70  
    71  	CreateNotification(*budgets.CreateNotificationInput) (*budgets.CreateNotificationOutput, error)
    72  	CreateNotificationWithContext(aws.Context, *budgets.CreateNotificationInput, ...request.Option) (*budgets.CreateNotificationOutput, error)
    73  	CreateNotificationRequest(*budgets.CreateNotificationInput) (*request.Request, *budgets.CreateNotificationOutput)
    74  
    75  	CreateSubscriber(*budgets.CreateSubscriberInput) (*budgets.CreateSubscriberOutput, error)
    76  	CreateSubscriberWithContext(aws.Context, *budgets.CreateSubscriberInput, ...request.Option) (*budgets.CreateSubscriberOutput, error)
    77  	CreateSubscriberRequest(*budgets.CreateSubscriberInput) (*request.Request, *budgets.CreateSubscriberOutput)
    78  
    79  	DeleteBudget(*budgets.DeleteBudgetInput) (*budgets.DeleteBudgetOutput, error)
    80  	DeleteBudgetWithContext(aws.Context, *budgets.DeleteBudgetInput, ...request.Option) (*budgets.DeleteBudgetOutput, error)
    81  	DeleteBudgetRequest(*budgets.DeleteBudgetInput) (*request.Request, *budgets.DeleteBudgetOutput)
    82  
    83  	DeleteBudgetAction(*budgets.DeleteBudgetActionInput) (*budgets.DeleteBudgetActionOutput, error)
    84  	DeleteBudgetActionWithContext(aws.Context, *budgets.DeleteBudgetActionInput, ...request.Option) (*budgets.DeleteBudgetActionOutput, error)
    85  	DeleteBudgetActionRequest(*budgets.DeleteBudgetActionInput) (*request.Request, *budgets.DeleteBudgetActionOutput)
    86  
    87  	DeleteNotification(*budgets.DeleteNotificationInput) (*budgets.DeleteNotificationOutput, error)
    88  	DeleteNotificationWithContext(aws.Context, *budgets.DeleteNotificationInput, ...request.Option) (*budgets.DeleteNotificationOutput, error)
    89  	DeleteNotificationRequest(*budgets.DeleteNotificationInput) (*request.Request, *budgets.DeleteNotificationOutput)
    90  
    91  	DeleteSubscriber(*budgets.DeleteSubscriberInput) (*budgets.DeleteSubscriberOutput, error)
    92  	DeleteSubscriberWithContext(aws.Context, *budgets.DeleteSubscriberInput, ...request.Option) (*budgets.DeleteSubscriberOutput, error)
    93  	DeleteSubscriberRequest(*budgets.DeleteSubscriberInput) (*request.Request, *budgets.DeleteSubscriberOutput)
    94  
    95  	DescribeBudget(*budgets.DescribeBudgetInput) (*budgets.DescribeBudgetOutput, error)
    96  	DescribeBudgetWithContext(aws.Context, *budgets.DescribeBudgetInput, ...request.Option) (*budgets.DescribeBudgetOutput, error)
    97  	DescribeBudgetRequest(*budgets.DescribeBudgetInput) (*request.Request, *budgets.DescribeBudgetOutput)
    98  
    99  	DescribeBudgetAction(*budgets.DescribeBudgetActionInput) (*budgets.DescribeBudgetActionOutput, error)
   100  	DescribeBudgetActionWithContext(aws.Context, *budgets.DescribeBudgetActionInput, ...request.Option) (*budgets.DescribeBudgetActionOutput, error)
   101  	DescribeBudgetActionRequest(*budgets.DescribeBudgetActionInput) (*request.Request, *budgets.DescribeBudgetActionOutput)
   102  
   103  	DescribeBudgetActionHistories(*budgets.DescribeBudgetActionHistoriesInput) (*budgets.DescribeBudgetActionHistoriesOutput, error)
   104  	DescribeBudgetActionHistoriesWithContext(aws.Context, *budgets.DescribeBudgetActionHistoriesInput, ...request.Option) (*budgets.DescribeBudgetActionHistoriesOutput, error)
   105  	DescribeBudgetActionHistoriesRequest(*budgets.DescribeBudgetActionHistoriesInput) (*request.Request, *budgets.DescribeBudgetActionHistoriesOutput)
   106  
   107  	DescribeBudgetActionHistoriesPages(*budgets.DescribeBudgetActionHistoriesInput, func(*budgets.DescribeBudgetActionHistoriesOutput, bool) bool) error
   108  	DescribeBudgetActionHistoriesPagesWithContext(aws.Context, *budgets.DescribeBudgetActionHistoriesInput, func(*budgets.DescribeBudgetActionHistoriesOutput, bool) bool, ...request.Option) error
   109  
   110  	DescribeBudgetActionsForAccount(*budgets.DescribeBudgetActionsForAccountInput) (*budgets.DescribeBudgetActionsForAccountOutput, error)
   111  	DescribeBudgetActionsForAccountWithContext(aws.Context, *budgets.DescribeBudgetActionsForAccountInput, ...request.Option) (*budgets.DescribeBudgetActionsForAccountOutput, error)
   112  	DescribeBudgetActionsForAccountRequest(*budgets.DescribeBudgetActionsForAccountInput) (*request.Request, *budgets.DescribeBudgetActionsForAccountOutput)
   113  
   114  	DescribeBudgetActionsForAccountPages(*budgets.DescribeBudgetActionsForAccountInput, func(*budgets.DescribeBudgetActionsForAccountOutput, bool) bool) error
   115  	DescribeBudgetActionsForAccountPagesWithContext(aws.Context, *budgets.DescribeBudgetActionsForAccountInput, func(*budgets.DescribeBudgetActionsForAccountOutput, bool) bool, ...request.Option) error
   116  
   117  	DescribeBudgetActionsForBudget(*budgets.DescribeBudgetActionsForBudgetInput) (*budgets.DescribeBudgetActionsForBudgetOutput, error)
   118  	DescribeBudgetActionsForBudgetWithContext(aws.Context, *budgets.DescribeBudgetActionsForBudgetInput, ...request.Option) (*budgets.DescribeBudgetActionsForBudgetOutput, error)
   119  	DescribeBudgetActionsForBudgetRequest(*budgets.DescribeBudgetActionsForBudgetInput) (*request.Request, *budgets.DescribeBudgetActionsForBudgetOutput)
   120  
   121  	DescribeBudgetActionsForBudgetPages(*budgets.DescribeBudgetActionsForBudgetInput, func(*budgets.DescribeBudgetActionsForBudgetOutput, bool) bool) error
   122  	DescribeBudgetActionsForBudgetPagesWithContext(aws.Context, *budgets.DescribeBudgetActionsForBudgetInput, func(*budgets.DescribeBudgetActionsForBudgetOutput, bool) bool, ...request.Option) error
   123  
   124  	DescribeBudgetPerformanceHistory(*budgets.DescribeBudgetPerformanceHistoryInput) (*budgets.DescribeBudgetPerformanceHistoryOutput, error)
   125  	DescribeBudgetPerformanceHistoryWithContext(aws.Context, *budgets.DescribeBudgetPerformanceHistoryInput, ...request.Option) (*budgets.DescribeBudgetPerformanceHistoryOutput, error)
   126  	DescribeBudgetPerformanceHistoryRequest(*budgets.DescribeBudgetPerformanceHistoryInput) (*request.Request, *budgets.DescribeBudgetPerformanceHistoryOutput)
   127  
   128  	DescribeBudgetPerformanceHistoryPages(*budgets.DescribeBudgetPerformanceHistoryInput, func(*budgets.DescribeBudgetPerformanceHistoryOutput, bool) bool) error
   129  	DescribeBudgetPerformanceHistoryPagesWithContext(aws.Context, *budgets.DescribeBudgetPerformanceHistoryInput, func(*budgets.DescribeBudgetPerformanceHistoryOutput, bool) bool, ...request.Option) error
   130  
   131  	DescribeBudgets(*budgets.DescribeBudgetsInput) (*budgets.DescribeBudgetsOutput, error)
   132  	DescribeBudgetsWithContext(aws.Context, *budgets.DescribeBudgetsInput, ...request.Option) (*budgets.DescribeBudgetsOutput, error)
   133  	DescribeBudgetsRequest(*budgets.DescribeBudgetsInput) (*request.Request, *budgets.DescribeBudgetsOutput)
   134  
   135  	DescribeBudgetsPages(*budgets.DescribeBudgetsInput, func(*budgets.DescribeBudgetsOutput, bool) bool) error
   136  	DescribeBudgetsPagesWithContext(aws.Context, *budgets.DescribeBudgetsInput, func(*budgets.DescribeBudgetsOutput, bool) bool, ...request.Option) error
   137  
   138  	DescribeNotificationsForBudget(*budgets.DescribeNotificationsForBudgetInput) (*budgets.DescribeNotificationsForBudgetOutput, error)
   139  	DescribeNotificationsForBudgetWithContext(aws.Context, *budgets.DescribeNotificationsForBudgetInput, ...request.Option) (*budgets.DescribeNotificationsForBudgetOutput, error)
   140  	DescribeNotificationsForBudgetRequest(*budgets.DescribeNotificationsForBudgetInput) (*request.Request, *budgets.DescribeNotificationsForBudgetOutput)
   141  
   142  	DescribeNotificationsForBudgetPages(*budgets.DescribeNotificationsForBudgetInput, func(*budgets.DescribeNotificationsForBudgetOutput, bool) bool) error
   143  	DescribeNotificationsForBudgetPagesWithContext(aws.Context, *budgets.DescribeNotificationsForBudgetInput, func(*budgets.DescribeNotificationsForBudgetOutput, bool) bool, ...request.Option) error
   144  
   145  	DescribeSubscribersForNotification(*budgets.DescribeSubscribersForNotificationInput) (*budgets.DescribeSubscribersForNotificationOutput, error)
   146  	DescribeSubscribersForNotificationWithContext(aws.Context, *budgets.DescribeSubscribersForNotificationInput, ...request.Option) (*budgets.DescribeSubscribersForNotificationOutput, error)
   147  	DescribeSubscribersForNotificationRequest(*budgets.DescribeSubscribersForNotificationInput) (*request.Request, *budgets.DescribeSubscribersForNotificationOutput)
   148  
   149  	DescribeSubscribersForNotificationPages(*budgets.DescribeSubscribersForNotificationInput, func(*budgets.DescribeSubscribersForNotificationOutput, bool) bool) error
   150  	DescribeSubscribersForNotificationPagesWithContext(aws.Context, *budgets.DescribeSubscribersForNotificationInput, func(*budgets.DescribeSubscribersForNotificationOutput, bool) bool, ...request.Option) error
   151  
   152  	ExecuteBudgetAction(*budgets.ExecuteBudgetActionInput) (*budgets.ExecuteBudgetActionOutput, error)
   153  	ExecuteBudgetActionWithContext(aws.Context, *budgets.ExecuteBudgetActionInput, ...request.Option) (*budgets.ExecuteBudgetActionOutput, error)
   154  	ExecuteBudgetActionRequest(*budgets.ExecuteBudgetActionInput) (*request.Request, *budgets.ExecuteBudgetActionOutput)
   155  
   156  	UpdateBudget(*budgets.UpdateBudgetInput) (*budgets.UpdateBudgetOutput, error)
   157  	UpdateBudgetWithContext(aws.Context, *budgets.UpdateBudgetInput, ...request.Option) (*budgets.UpdateBudgetOutput, error)
   158  	UpdateBudgetRequest(*budgets.UpdateBudgetInput) (*request.Request, *budgets.UpdateBudgetOutput)
   159  
   160  	UpdateBudgetAction(*budgets.UpdateBudgetActionInput) (*budgets.UpdateBudgetActionOutput, error)
   161  	UpdateBudgetActionWithContext(aws.Context, *budgets.UpdateBudgetActionInput, ...request.Option) (*budgets.UpdateBudgetActionOutput, error)
   162  	UpdateBudgetActionRequest(*budgets.UpdateBudgetActionInput) (*request.Request, *budgets.UpdateBudgetActionOutput)
   163  
   164  	UpdateNotification(*budgets.UpdateNotificationInput) (*budgets.UpdateNotificationOutput, error)
   165  	UpdateNotificationWithContext(aws.Context, *budgets.UpdateNotificationInput, ...request.Option) (*budgets.UpdateNotificationOutput, error)
   166  	UpdateNotificationRequest(*budgets.UpdateNotificationInput) (*request.Request, *budgets.UpdateNotificationOutput)
   167  
   168  	UpdateSubscriber(*budgets.UpdateSubscriberInput) (*budgets.UpdateSubscriberOutput, error)
   169  	UpdateSubscriberWithContext(aws.Context, *budgets.UpdateSubscriberInput, ...request.Option) (*budgets.UpdateSubscriberOutput, error)
   170  	UpdateSubscriberRequest(*budgets.UpdateSubscriberInput) (*request.Request, *budgets.UpdateSubscriberOutput)
   171  }
   172  
   173  var _ BudgetsAPI = (*budgets.Budgets)(nil)