rest

Documentation

Overview

Package rest contains the types and interfaces to interact with the Liqo API.

Index

• type API
• type APIOptions
• type APIProvider
• type CreateOptions
• type DeleteOptions
• type GetOptions
• type UpdateOptions

Types

type API

type API interface {
	APIOptions() *APIOptions
	Create(ctx context.Context, options *CreateOptions) *cobra.Command
	Delete(ctx context.Context, options *DeleteOptions) *cobra.Command
	Get(ctx context.Context, options *GetOptions) *cobra.Command
	Update(ctx context.Context, options *UpdateOptions) *cobra.Command
}

API is the interface that must be implemented by the API.

type APIOptions

type APIOptions struct {
	EnableCreate bool
	EnableDelete bool
	EnableGet    bool
	EnableUpdate bool
}

APIOptions contains the options for the API.

type APIProvider

type APIProvider func() API

APIProvider is the function that returns the API.

type CreateOptions

type CreateOptions struct {
	*factory.Factory

	OutputFormat string
	Name         string
}

CreateOptions contains the options for the create API.

type DeleteOptions

type DeleteOptions struct {
	*factory.Factory

	Name string
}

DeleteOptions contains the options for the delete API.

type GetOptions

type GetOptions struct {
	*factory.Factory
}

GetOptions contains the options for the get API.

type UpdateOptions

type UpdateOptions struct {
	*factory.Factory
}

UpdateOptions contains the options for the update API.