deleter

Documentation

Index

• Constants
• func IsExecutionFailed(err error) bool
• func IsInvalidConfig(err error) bool
• type Config
  • func DefaultConfig() Config
• type Request
  • func DefaultRequest() Request
• type Response
  • func DefaultResponse() *Response
• type Service
  • func New(config Config) (*Service, error)
  • func (s *Service) Delete(ctx context.Context, request Request) (*Response, error)

Constants

const (
	// Endpoint is the API endpoint of the service this client action interacts
	// with.
	Endpoint = "/v1/clusters/%s/"
	// Name is the service name being implemented. This can be used for e.g.
	// logging.
	Name = "cluster/deleter"
)

Functions

func IsExecutionFailed

func IsExecutionFailed(err error) bool

IsExecutionFailed asserts executionFailedError.

func IsInvalidConfig

func IsInvalidConfig(err error) bool

IsInvalidConfig asserts invalidConfigError.

Types

type Config

type Config struct {
	Logger     micrologger.Logger
	RestClient *resty.Client

	URL *url.URL
}

Config represents the configuration used to create a deleter service.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig provides a default configuration to create a new deleter service by best effort.

type Request

type Request struct {
	Cluster *config.Cluster `json:"cluster"`
}

Request is the configuration for the service action.

func DefaultRequest

func DefaultRequest() Request

DefaultRequest provides a default request by best effort.

type Response

type Response struct {
}

Response is the return value of the service action.

func DefaultResponse

func DefaultResponse() *Response

DefaultResponse provides a default response by best effort.

type Service

type Service struct {
	// contains filtered or unexported fields
}

func New

func New(config Config) (*Service, error)

New creates a new configured deleter service.

func (*Service) Delete

func (s *Service) Delete(ctx context.Context, request Request) (*Response, error)