credentiallibraries

Documentation

Overview

Code generated by "make api"; DO NOT EDIT.

Code generated by "make api"; DO NOT EDIT.

Index

• type Client
  • func NewClient(c *api.Client) *Client
  • func (c *Client) ApiClient() *api.Client
  • func (c *Client) Create(ctx context.Context, credentialStoreId string, opt ...Option) (*CredentialLibraryCreateResult, error)
  • func (c *Client) Delete(ctx context.Context, id string, opt ...Option) (*CredentialLibraryDeleteResult, error)
  • func (c *Client) List(ctx context.Context, credentialStoreId string, opt ...Option) (*CredentialLibraryListResult, error)
  • func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*CredentialLibraryReadResult, error)
  • func (c *Client) Update(ctx context.Context, id string, version uint32, opt ...Option) (*CredentialLibraryUpdateResult, error)
• type CredentialLibrary
• type CredentialLibraryCreateResult
• type CredentialLibraryDeleteResult
  • func (n CredentialLibraryDeleteResult) GetItem() interface{}
  • func (n CredentialLibraryDeleteResult) GetResponse() *api.Response
• type CredentialLibraryListResult
  • func (n CredentialLibraryListResult) GetItems() interface{}
  • func (n CredentialLibraryListResult) GetResponse() *api.Response
• type CredentialLibraryReadResult
  • func (n CredentialLibraryReadResult) GetItem() interface{}
  • func (n CredentialLibraryReadResult) GetResponse() *api.Response
• type CredentialLibraryUpdateResult
• type Option
  • func DefaultAttributes() Option
  • func DefaultDescription() Option
  • func DefaultName() Option
  • func DefaultVaultCredentialLibraryHttpMethod() Option
  • func DefaultVaultCredentialLibraryHttpRequestBody() Option
  • func WithAttributes(inAttributes map[string]interface{}) Option
  • func WithAutomaticVersioning(enable bool) Option
  • func WithDescription(inDescription string) Option
  • func WithFilter(filter string) Option
  • func WithName(inName string) Option
  • func WithSkipCurlOutput(skip bool) Option
  • func WithVaultCredentialLibraryHttpMethod(inHttpMethod string) Option
  • func WithVaultCredentialLibraryHttpRequestBody(inHttpRequestBody string) Option
  • func WithVaultCredentialLibraryPath(inPath string) Option
• type VaultCredentialLibraryAttributes

Types

type Client

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

Client is a client for this collection

func NewClient

func NewClient(c *api.Client) *Client

Creates a new client for this collection. The submitted API client is cloned; modifications to it after generating this client will not have effect. If you need to make changes to the underlying API client, use ApiClient() to access it.

func (*Client) ApiClient

func (c *Client) ApiClient() *api.Client

ApiClient returns the underlying API client

func (*Client) Create

func (c *Client) Create(ctx context.Context, credentialStoreId string, opt ...Option) (*CredentialLibraryCreateResult, error)

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, id string, opt ...Option) (*CredentialLibraryDeleteResult, error)

func (*Client) List

func (c *Client) List(ctx context.Context, credentialStoreId string, opt ...Option) (*CredentialLibraryListResult, error)

func (*Client) Read

func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*CredentialLibraryReadResult, error)

func (*Client) Update

func (c *Client) Update(ctx context.Context, id string, version uint32, opt ...Option) (*CredentialLibraryUpdateResult, error)

type CredentialLibrary

type CredentialLibrary struct {
	Id                string                 `json:"id,omitempty"`
	CredentialStoreId string                 `json:"credential_store_id,omitempty"`
	Scope             *scopes.ScopeInfo      `json:"scope,omitempty"`
	Name              string                 `json:"name,omitempty"`
	Description       string                 `json:"description,omitempty"`
	CreatedTime       time.Time              `json:"created_time,omitempty"`
	UpdatedTime       time.Time              `json:"updated_time,omitempty"`
	Version           uint32                 `json:"version,omitempty"`
	Type              string                 `json:"type,omitempty"`
	Attributes        map[string]interface{} `json:"attributes,omitempty"`
	AuthorizedActions []string               `json:"authorized_actions,omitempty"`
	// contains filtered or unexported fields
}

type CredentialLibraryCreateResult

type CredentialLibraryCreateResult = CredentialLibraryReadResult

type CredentialLibraryDeleteResult

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

func (CredentialLibraryDeleteResult) GetItem

func (n CredentialLibraryDeleteResult) GetItem() interface{}

GetItem will always be nil for CredentialLibraryDeleteResult

func (CredentialLibraryDeleteResult) GetResponse

func (n CredentialLibraryDeleteResult) GetResponse() *api.Response

type CredentialLibraryListResult

type CredentialLibraryListResult struct {
	Items []*CredentialLibrary
	// contains filtered or unexported fields
}

func (CredentialLibraryListResult) GetItems

func (n CredentialLibraryListResult) GetItems() interface{}

func (CredentialLibraryListResult) GetResponse

func (n CredentialLibraryListResult) GetResponse() *api.Response

type CredentialLibraryReadResult

type CredentialLibraryReadResult struct {
	Item *CredentialLibrary
	// contains filtered or unexported fields
}

func (CredentialLibraryReadResult) GetItem

func (n CredentialLibraryReadResult) GetItem() interface{}

func (CredentialLibraryReadResult) GetResponse

func (n CredentialLibraryReadResult) GetResponse() *api.Response

type CredentialLibraryUpdateResult

type CredentialLibraryUpdateResult = CredentialLibraryReadResult

type Option

type Option func(*options)

Option is a func that sets optional attributes for a call. This does not need to be used directly, but instead option arguments are built from the functions in this package. WithX options set a value to that given in the argument; DefaultX options indicate that the value should be set to its default. When an API call is made options are processed in ther order they appear in the function call, so for a given argument X, a succession of WithX or DefaultX calls will result in the last call taking effect.

func DefaultAttributes

func DefaultAttributes() Option

func DefaultDescription

func DefaultDescription() Option

func DefaultName

func DefaultName() Option

func DefaultVaultCredentialLibraryHttpMethod

func DefaultVaultCredentialLibraryHttpMethod() Option

func DefaultVaultCredentialLibraryHttpRequestBody

func DefaultVaultCredentialLibraryHttpRequestBody() Option

func WithAttributes

func WithAttributes(inAttributes map[string]interface{}) Option

func WithAutomaticVersioning

func WithAutomaticVersioning(enable bool) Option

If set, and if the version is zero during an update, the API will perform a fetch to get the current version of the resource and populate it during the update call. This is convenient but opens up the possibility for subtle order-of-modification issues, so use carefully.

func WithDescription

func WithDescription(inDescription string) Option

func WithFilter

func WithFilter(filter string) Option

WithFilter tells the API to filter the items returned using the provided filter term. The filter should be in a format supported by hashicorp/go-bexpr.

func WithName

func WithName(inName string) Option

func WithSkipCurlOutput

func WithSkipCurlOutput(skip bool) Option

WithSkipCurlOutput tells the API to not use the current call for cURL output. Useful for when we need to look up versions.

func WithVaultCredentialLibraryHttpMethod

func WithVaultCredentialLibraryHttpMethod(inHttpMethod string) Option

func WithVaultCredentialLibraryHttpRequestBody

func WithVaultCredentialLibraryHttpRequestBody(inHttpRequestBody string) Option

func WithVaultCredentialLibraryPath

func WithVaultCredentialLibraryPath(inPath string) Option

type VaultCredentialLibraryAttributes

type VaultCredentialLibraryAttributes struct {
	Path            string `json:"path,omitempty"`
	HttpMethod      string `json:"http_method,omitempty"`
	HttpRequestBody string `json:"http_request_body,omitempty"`
}