github.com/1aal/kubeblocks@v0.0.0-20231107070852-e1c03e598921/pkg/dataprotection/action/action.go (about)

     1  /*
     2  Copyright (C) 2022-2023 ApeCloud Co., Ltd
     3  
     4  This file is part of KubeBlocks project
     5  
     6  This program is free software: you can redistribute it and/or modify
     7  it under the terms of the GNU Affero General Public License as published by
     8  the Free Software Foundation, either version 3 of the License, or
     9  (at your option) any later version.
    10  
    11  This program is distributed in the hope that it will be useful
    12  but WITHOUT ANY WARRANTY; without even the implied warranty of
    13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    14  GNU Affero General Public License for more details.
    15  
    16  You should have received a copy of the GNU Affero General Public License
    17  along with this program.  If not, see <http://www.gnu.org/licenses/>.
    18  */
    19  
    20  package action
    21  
    22  import (
    23  	"context"
    24  
    25  	"k8s.io/apimachinery/pkg/runtime"
    26  	"k8s.io/client-go/rest"
    27  	"k8s.io/client-go/tools/record"
    28  	"sigs.k8s.io/controller-runtime/pkg/client"
    29  
    30  	dpv1alpha1 "github.com/1aal/kubeblocks/apis/dataprotection/v1alpha1"
    31  )
    32  
    33  type Action interface {
    34  	// Execute executes the action.
    35  	Execute(ctx Context) (*dpv1alpha1.ActionStatus, error)
    36  
    37  	// GetName returns the Name of the action.
    38  	GetName() string
    39  
    40  	// Type returns the type of the action.
    41  	Type() dpv1alpha1.ActionType
    42  }
    43  
    44  type Context struct {
    45  	Ctx      context.Context
    46  	Client   client.Client
    47  	Recorder record.EventRecorder
    48  
    49  	Scheme           *runtime.Scheme
    50  	RestClientConfig *rest.Config
    51  }