github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/pkg/api/v2/status.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  	"github.com/pingcap/tiflow/cdc/model"
    20  	"github.com/pingcap/tiflow/pkg/api/internal/rest"
    21  )
    22  
    23  // StatusGetter has a method to return a StatusInterface.
    24  type StatusGetter interface {
    25  	Status() StatusInterface
    26  }
    27  
    28  // StatusInterface has methods to work with status api
    29  type StatusInterface interface {
    30  	Get(ctx context.Context) (*model.ServerStatus, error)
    31  }
    32  
    33  // status implements StatusGetter
    34  type status struct {
    35  	client rest.CDCRESTInterface
    36  }
    37  
    38  // newCaptures returns captures
    39  func newStatus(c *APIV2Client) *status {
    40  	return &status{
    41  		client: c.RESTClient(),
    42  	}
    43  }
    44  
    45  // Get returns the server status
    46  func (c *status) Get(ctx context.Context) (*model.ServerStatus, error) {
    47  	result := new(model.ServerStatus)
    48  	err := c.client.Get().
    49  		WithURI("status").
    50  		Do(ctx).
    51  		Into(result)
    52  	return result, err
    53  }