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

     1  // Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
     2  
     3  // Package qldbiface provides an interface to enable mocking the Amazon QLDB 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 qldbiface
    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/qldb"
    15  )
    16  
    17  // QLDBAPI provides an interface to enable mocking the
    18  // qldb.QLDB 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  //    // Amazon QLDB.
    28  //    func myFunc(svc qldbiface.QLDBAPI) bool {
    29  //        // Make svc.CancelJournalKinesisStream request
    30  //    }
    31  //
    32  //    func main() {
    33  //        sess := session.New()
    34  //        svc := qldb.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 mockQLDBClient struct {
    43  //        qldbiface.QLDBAPI
    44  //    }
    45  //    func (m *mockQLDBClient) CancelJournalKinesisStream(input *qldb.CancelJournalKinesisStreamInput) (*qldb.CancelJournalKinesisStreamOutput, error) {
    46  //        // mock response/functionality
    47  //    }
    48  //
    49  //    func TestMyFunc(t *testing.T) {
    50  //        // Setup Test
    51  //        mockSvc := &mockQLDBClient{}
    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 QLDBAPI interface {
    63  	CancelJournalKinesisStream(*qldb.CancelJournalKinesisStreamInput) (*qldb.CancelJournalKinesisStreamOutput, error)
    64  	CancelJournalKinesisStreamWithContext(aws.Context, *qldb.CancelJournalKinesisStreamInput, ...request.Option) (*qldb.CancelJournalKinesisStreamOutput, error)
    65  	CancelJournalKinesisStreamRequest(*qldb.CancelJournalKinesisStreamInput) (*request.Request, *qldb.CancelJournalKinesisStreamOutput)
    66  
    67  	CreateLedger(*qldb.CreateLedgerInput) (*qldb.CreateLedgerOutput, error)
    68  	CreateLedgerWithContext(aws.Context, *qldb.CreateLedgerInput, ...request.Option) (*qldb.CreateLedgerOutput, error)
    69  	CreateLedgerRequest(*qldb.CreateLedgerInput) (*request.Request, *qldb.CreateLedgerOutput)
    70  
    71  	DeleteLedger(*qldb.DeleteLedgerInput) (*qldb.DeleteLedgerOutput, error)
    72  	DeleteLedgerWithContext(aws.Context, *qldb.DeleteLedgerInput, ...request.Option) (*qldb.DeleteLedgerOutput, error)
    73  	DeleteLedgerRequest(*qldb.DeleteLedgerInput) (*request.Request, *qldb.DeleteLedgerOutput)
    74  
    75  	DescribeJournalKinesisStream(*qldb.DescribeJournalKinesisStreamInput) (*qldb.DescribeJournalKinesisStreamOutput, error)
    76  	DescribeJournalKinesisStreamWithContext(aws.Context, *qldb.DescribeJournalKinesisStreamInput, ...request.Option) (*qldb.DescribeJournalKinesisStreamOutput, error)
    77  	DescribeJournalKinesisStreamRequest(*qldb.DescribeJournalKinesisStreamInput) (*request.Request, *qldb.DescribeJournalKinesisStreamOutput)
    78  
    79  	DescribeJournalS3Export(*qldb.DescribeJournalS3ExportInput) (*qldb.DescribeJournalS3ExportOutput, error)
    80  	DescribeJournalS3ExportWithContext(aws.Context, *qldb.DescribeJournalS3ExportInput, ...request.Option) (*qldb.DescribeJournalS3ExportOutput, error)
    81  	DescribeJournalS3ExportRequest(*qldb.DescribeJournalS3ExportInput) (*request.Request, *qldb.DescribeJournalS3ExportOutput)
    82  
    83  	DescribeLedger(*qldb.DescribeLedgerInput) (*qldb.DescribeLedgerOutput, error)
    84  	DescribeLedgerWithContext(aws.Context, *qldb.DescribeLedgerInput, ...request.Option) (*qldb.DescribeLedgerOutput, error)
    85  	DescribeLedgerRequest(*qldb.DescribeLedgerInput) (*request.Request, *qldb.DescribeLedgerOutput)
    86  
    87  	ExportJournalToS3(*qldb.ExportJournalToS3Input) (*qldb.ExportJournalToS3Output, error)
    88  	ExportJournalToS3WithContext(aws.Context, *qldb.ExportJournalToS3Input, ...request.Option) (*qldb.ExportJournalToS3Output, error)
    89  	ExportJournalToS3Request(*qldb.ExportJournalToS3Input) (*request.Request, *qldb.ExportJournalToS3Output)
    90  
    91  	GetBlock(*qldb.GetBlockInput) (*qldb.GetBlockOutput, error)
    92  	GetBlockWithContext(aws.Context, *qldb.GetBlockInput, ...request.Option) (*qldb.GetBlockOutput, error)
    93  	GetBlockRequest(*qldb.GetBlockInput) (*request.Request, *qldb.GetBlockOutput)
    94  
    95  	GetDigest(*qldb.GetDigestInput) (*qldb.GetDigestOutput, error)
    96  	GetDigestWithContext(aws.Context, *qldb.GetDigestInput, ...request.Option) (*qldb.GetDigestOutput, error)
    97  	GetDigestRequest(*qldb.GetDigestInput) (*request.Request, *qldb.GetDigestOutput)
    98  
    99  	GetRevision(*qldb.GetRevisionInput) (*qldb.GetRevisionOutput, error)
   100  	GetRevisionWithContext(aws.Context, *qldb.GetRevisionInput, ...request.Option) (*qldb.GetRevisionOutput, error)
   101  	GetRevisionRequest(*qldb.GetRevisionInput) (*request.Request, *qldb.GetRevisionOutput)
   102  
   103  	ListJournalKinesisStreamsForLedger(*qldb.ListJournalKinesisStreamsForLedgerInput) (*qldb.ListJournalKinesisStreamsForLedgerOutput, error)
   104  	ListJournalKinesisStreamsForLedgerWithContext(aws.Context, *qldb.ListJournalKinesisStreamsForLedgerInput, ...request.Option) (*qldb.ListJournalKinesisStreamsForLedgerOutput, error)
   105  	ListJournalKinesisStreamsForLedgerRequest(*qldb.ListJournalKinesisStreamsForLedgerInput) (*request.Request, *qldb.ListJournalKinesisStreamsForLedgerOutput)
   106  
   107  	ListJournalKinesisStreamsForLedgerPages(*qldb.ListJournalKinesisStreamsForLedgerInput, func(*qldb.ListJournalKinesisStreamsForLedgerOutput, bool) bool) error
   108  	ListJournalKinesisStreamsForLedgerPagesWithContext(aws.Context, *qldb.ListJournalKinesisStreamsForLedgerInput, func(*qldb.ListJournalKinesisStreamsForLedgerOutput, bool) bool, ...request.Option) error
   109  
   110  	ListJournalS3Exports(*qldb.ListJournalS3ExportsInput) (*qldb.ListJournalS3ExportsOutput, error)
   111  	ListJournalS3ExportsWithContext(aws.Context, *qldb.ListJournalS3ExportsInput, ...request.Option) (*qldb.ListJournalS3ExportsOutput, error)
   112  	ListJournalS3ExportsRequest(*qldb.ListJournalS3ExportsInput) (*request.Request, *qldb.ListJournalS3ExportsOutput)
   113  
   114  	ListJournalS3ExportsPages(*qldb.ListJournalS3ExportsInput, func(*qldb.ListJournalS3ExportsOutput, bool) bool) error
   115  	ListJournalS3ExportsPagesWithContext(aws.Context, *qldb.ListJournalS3ExportsInput, func(*qldb.ListJournalS3ExportsOutput, bool) bool, ...request.Option) error
   116  
   117  	ListJournalS3ExportsForLedger(*qldb.ListJournalS3ExportsForLedgerInput) (*qldb.ListJournalS3ExportsForLedgerOutput, error)
   118  	ListJournalS3ExportsForLedgerWithContext(aws.Context, *qldb.ListJournalS3ExportsForLedgerInput, ...request.Option) (*qldb.ListJournalS3ExportsForLedgerOutput, error)
   119  	ListJournalS3ExportsForLedgerRequest(*qldb.ListJournalS3ExportsForLedgerInput) (*request.Request, *qldb.ListJournalS3ExportsForLedgerOutput)
   120  
   121  	ListJournalS3ExportsForLedgerPages(*qldb.ListJournalS3ExportsForLedgerInput, func(*qldb.ListJournalS3ExportsForLedgerOutput, bool) bool) error
   122  	ListJournalS3ExportsForLedgerPagesWithContext(aws.Context, *qldb.ListJournalS3ExportsForLedgerInput, func(*qldb.ListJournalS3ExportsForLedgerOutput, bool) bool, ...request.Option) error
   123  
   124  	ListLedgers(*qldb.ListLedgersInput) (*qldb.ListLedgersOutput, error)
   125  	ListLedgersWithContext(aws.Context, *qldb.ListLedgersInput, ...request.Option) (*qldb.ListLedgersOutput, error)
   126  	ListLedgersRequest(*qldb.ListLedgersInput) (*request.Request, *qldb.ListLedgersOutput)
   127  
   128  	ListLedgersPages(*qldb.ListLedgersInput, func(*qldb.ListLedgersOutput, bool) bool) error
   129  	ListLedgersPagesWithContext(aws.Context, *qldb.ListLedgersInput, func(*qldb.ListLedgersOutput, bool) bool, ...request.Option) error
   130  
   131  	ListTagsForResource(*qldb.ListTagsForResourceInput) (*qldb.ListTagsForResourceOutput, error)
   132  	ListTagsForResourceWithContext(aws.Context, *qldb.ListTagsForResourceInput, ...request.Option) (*qldb.ListTagsForResourceOutput, error)
   133  	ListTagsForResourceRequest(*qldb.ListTagsForResourceInput) (*request.Request, *qldb.ListTagsForResourceOutput)
   134  
   135  	StreamJournalToKinesis(*qldb.StreamJournalToKinesisInput) (*qldb.StreamJournalToKinesisOutput, error)
   136  	StreamJournalToKinesisWithContext(aws.Context, *qldb.StreamJournalToKinesisInput, ...request.Option) (*qldb.StreamJournalToKinesisOutput, error)
   137  	StreamJournalToKinesisRequest(*qldb.StreamJournalToKinesisInput) (*request.Request, *qldb.StreamJournalToKinesisOutput)
   138  
   139  	TagResource(*qldb.TagResourceInput) (*qldb.TagResourceOutput, error)
   140  	TagResourceWithContext(aws.Context, *qldb.TagResourceInput, ...request.Option) (*qldb.TagResourceOutput, error)
   141  	TagResourceRequest(*qldb.TagResourceInput) (*request.Request, *qldb.TagResourceOutput)
   142  
   143  	UntagResource(*qldb.UntagResourceInput) (*qldb.UntagResourceOutput, error)
   144  	UntagResourceWithContext(aws.Context, *qldb.UntagResourceInput, ...request.Option) (*qldb.UntagResourceOutput, error)
   145  	UntagResourceRequest(*qldb.UntagResourceInput) (*request.Request, *qldb.UntagResourceOutput)
   146  
   147  	UpdateLedger(*qldb.UpdateLedgerInput) (*qldb.UpdateLedgerOutput, error)
   148  	UpdateLedgerWithContext(aws.Context, *qldb.UpdateLedgerInput, ...request.Option) (*qldb.UpdateLedgerOutput, error)
   149  	UpdateLedgerRequest(*qldb.UpdateLedgerInput) (*request.Request, *qldb.UpdateLedgerOutput)
   150  
   151  	UpdateLedgerPermissionsMode(*qldb.UpdateLedgerPermissionsModeInput) (*qldb.UpdateLedgerPermissionsModeOutput, error)
   152  	UpdateLedgerPermissionsModeWithContext(aws.Context, *qldb.UpdateLedgerPermissionsModeInput, ...request.Option) (*qldb.UpdateLedgerPermissionsModeOutput, error)
   153  	UpdateLedgerPermissionsModeRequest(*qldb.UpdateLedgerPermissionsModeInput) (*request.Request, *qldb.UpdateLedgerPermissionsModeOutput)
   154  }
   155  
   156  var _ QLDBAPI = (*qldb.QLDB)(nil)