secrets

Documentation

Index

• func Create(ctx context.Context, reader io.Reader, options *CreateOptions) (*entities.SecretCreateReport, error)
• func Inspect(ctx context.Context, nameOrID string, options *InspectOptions) (*entities.SecretInfoReport, error)
• func List(ctx context.Context, options *ListOptions) ([]*entities.SecretInfoReport, error)
• func Remove(ctx context.Context, nameOrID string) error
• type CreateOptions
  • func (o *CreateOptions) Changed(fieldName string) bool
  • func (o *CreateOptions) GetDriver() string
  • func (o *CreateOptions) GetName() string
  • func (o *CreateOptions) ToParams() (url.Values, error)
  • func (o *CreateOptions) WithDriver(value string) *CreateOptions
  • func (o *CreateOptions) WithName(value string) *CreateOptions
• type InspectOptions
  • func (o *InspectOptions) Changed(fieldName string) bool
  • func (o *InspectOptions) ToParams() (url.Values, error)
• type ListOptions
  • func (o *ListOptions) Changed(fieldName string) bool
  • func (o *ListOptions) ToParams() (url.Values, error)
• type RemoveOptions
  • func (o *RemoveOptions) Changed(fieldName string) bool
  • func (o *RemoveOptions) ToParams() (url.Values, error)

Functions

func Create

func Create(ctx context.Context, reader io.Reader, options *CreateOptions) (*entities.SecretCreateReport, error)

Create creates a secret given some data

func Inspect

func Inspect(ctx context.Context, nameOrID string, options *InspectOptions) (*entities.SecretInfoReport, error)

Inspect returns low-level information about a secret.

func List

func List(ctx context.Context, options *ListOptions) ([]*entities.SecretInfoReport, error)

List returns information about existing secrets in the form of a slice.

func Remove

func Remove(ctx context.Context, nameOrID string) error

Remove removes a secret from storage

Types

type CreateOptions

type CreateOptions struct {
	Driver *string
	Name   *string
}

CreateOptions are optional options for Creating secrets

func (*CreateOptions) Changed

func (o *CreateOptions) Changed(fieldName string) bool

Changed

func (*CreateOptions) GetDriver

func (o *CreateOptions) GetDriver() string

GetDriver

func (*CreateOptions) GetName

func (o *CreateOptions) GetName() string

GetName

func (*CreateOptions) ToParams

func (o *CreateOptions) ToParams() (url.Values, error)

ToParams

func (*CreateOptions) WithDriver

func (o *CreateOptions) WithDriver(value string) *CreateOptions

WithDriver

func (*CreateOptions) WithName

func (o *CreateOptions) WithName(value string) *CreateOptions

WithName

type InspectOptions

type InspectOptions struct {
}

InspectOptions are optional options for inspecting secrets

func (*InspectOptions) Changed

func (o *InspectOptions) Changed(fieldName string) bool

Changed

func (*InspectOptions) ToParams

func (o *InspectOptions) ToParams() (url.Values, error)

ToParams

type ListOptions

type ListOptions struct {
}

ListOptions are optional options for inspecting secrets

func (*ListOptions) Changed

func (o *ListOptions) Changed(fieldName string) bool

Changed

func (*ListOptions) ToParams

func (o *ListOptions) ToParams() (url.Values, error)

ToParams

type RemoveOptions

type RemoveOptions struct {
}

RemoveOptions are optional options for removing secrets

func (*RemoveOptions) Changed

func (o *RemoveOptions) Changed(fieldName string) bool

Changed

func (*RemoveOptions) ToParams

func (o *RemoveOptions) ToParams() (url.Values, error)

ToParams