secrets

Documentation

Overview

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

Code generated by go generate; DO NOT EDIT.

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) GetDriverOpts() map[string]string
  • func (o *CreateOptions) GetLabels() map[string]string
  • func (o *CreateOptions) GetName() string
  • func (o *CreateOptions) ToParams() (url.Values, error)
  • func (o *CreateOptions) WithDriver(value string) *CreateOptions
  • func (o *CreateOptions) WithDriverOpts(value map[string]string) *CreateOptions
  • func (o *CreateOptions) WithLabels(value map[string]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) GetFilters() map[string][]string
  • func (o *ListOptions) ToParams() (url.Values, error)
  • func (o *ListOptions) WithFilters(value map[string][]string) *ListOptions
• 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 {
	Name       *string
	Driver     *string
	DriverOpts map[string]string
	Labels     map[string]string
}

CreateOptions are optional options for Creating secrets

func (*CreateOptions) Changed

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

Changed returns true if named field has been set

func (*CreateOptions) GetDriver

func (o *CreateOptions) GetDriver() string

GetDriver returns value of field Driver

func (*CreateOptions) GetDriverOpts

func (o *CreateOptions) GetDriverOpts() map[string]string

GetDriverOpts returns value of field DriverOpts

func (*CreateOptions) GetLabels

func (o *CreateOptions) GetLabels() map[string]string

GetLabels returns value of field Labels

func (*CreateOptions) GetName

func (o *CreateOptions) GetName() string

GetName returns value of field Name

func (*CreateOptions) ToParams

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

ToParams formats struct fields to be passed to API service

func (*CreateOptions) WithDriver

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

WithDriver set field Driver to given value

func (*CreateOptions) WithDriverOpts

func (o *CreateOptions) WithDriverOpts(value map[string]string) *CreateOptions

WithDriverOpts set field DriverOpts to given value

func (*CreateOptions) WithLabels

func (o *CreateOptions) WithLabels(value map[string]string) *CreateOptions

WithLabels set field Labels to given value

func (*CreateOptions) WithName

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

WithName set field Name to given value

type InspectOptions

type InspectOptions struct {
}

InspectOptions are optional options for inspecting secrets

func (*InspectOptions) Changed

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

Changed returns true if named field has been set

func (*InspectOptions) ToParams

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

ToParams formats struct fields to be passed to API service

type ListOptions

type ListOptions struct {
	Filters map[string][]string
}

ListOptions are optional options for inspecting secrets

func (*ListOptions) Changed

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

Changed returns true if named field has been set

func (*ListOptions) GetFilters

func (o *ListOptions) GetFilters() map[string][]string

GetFilters returns value of field Filters

func (*ListOptions) ToParams

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

ToParams formats struct fields to be passed to API service

func (*ListOptions) WithFilters

func (o *ListOptions) WithFilters(value map[string][]string) *ListOptions

WithFilters set field Filters to given value

type RemoveOptions

type RemoveOptions struct {
}

RemoveOptions are optional options for removing secrets

func (*RemoveOptions) Changed

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

Changed returns true if named field has been set

func (*RemoveOptions) ToParams

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

ToParams formats struct fields to be passed to API service