github.com/pingcap/tiflow@v0.0.0-20240520035814-5bf52d54e205/engine/pkg/externalresource/internal/resource_controller.go (about)

     1  // Copyright 2022 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 internal
    15  
    16  import (
    17  	"context"
    18  
    19  	"github.com/pingcap/tiflow/engine/model"
    20  	resModel "github.com/pingcap/tiflow/engine/pkg/externalresource/model"
    21  )
    22  
    23  // ResourceController is an interface providing relevant operations related
    24  // to one resource type.
    25  type ResourceController interface {
    26  	// GCSingleResource remove a persisted resource.
    27  	GCSingleResource(context.Context, *resModel.ResourceMeta) error
    28  	// GCExecutor removes all temporary resources created by the offlined executors.
    29  	GCExecutor(context.Context, []*resModel.ResourceMeta, model.ExecutorID) error
    30  }