github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/pkg/api/v2/capture.go (about)

     1  // Copyright 2023 PingCAP, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // See the License for the specific language governing permissions and
    12  // limitations under the License.
    13  
    14  package v2
    15  
    16  import (
    17  	"context"
    18  
    19  	v2 "github.com/pingcap/tiflow/cdc/api/v2"
    20  	"github.com/pingcap/tiflow/cdc/model"
    21  	"github.com/pingcap/tiflow/pkg/api/internal/rest"
    22  )
    23  
    24  // CapturesGetter has a method to return a CaptureInterface.
    25  type CapturesGetter interface {
    26  	Captures() CaptureInterface
    27  }
    28  
    29  // CaptureInterface has methods to work with Capture items.
    30  // We can also mock the capture operations by implement this interface.
    31  type CaptureInterface interface {
    32  	List(ctx context.Context) ([]model.Capture, error)
    33  }
    34  
    35  // captures implements CaptureInterface
    36  type captures struct {
    37  	client rest.CDCRESTInterface
    38  }
    39  
    40  // newCaptures returns captures
    41  func newCaptures(c *APIV2Client) *captures {
    42  	return &captures{
    43  		client: c.RESTClient(),
    44  	}
    45  }
    46  
    47  // List returns the list of captures
    48  func (c *captures) List(ctx context.Context) ([]model.Capture, error) {
    49  	result := &v2.ListResponse[model.Capture]{}
    50  	err := c.client.Get().
    51  		WithURI("captures").
    52  		Do(ctx).
    53  		Into(result)
    54  	return result.Items, err
    55  }