aliases

Documentation

Index

• type Alias
  • func (pt *Alias) GetTargetAliasAttributes() (*TargetAliasAttributes, error)
• type AliasCreateResult
• type AliasDeleteResult
  • func (n AliasDeleteResult) GetItem() interface{}
  • func (n AliasDeleteResult) GetResponse() *api.Response
• type AliasListResult
  • func (n AliasListResult) GetEstItemCount() uint
  • func (n AliasListResult) GetItems() []*Alias
  • func (n AliasListResult) GetListToken() string
  • func (n AliasListResult) GetRemovedIds() []string
  • func (n AliasListResult) GetResponse() *api.Response
  • func (n AliasListResult) GetResponseType() string
• type AliasReadResult
  • func (n AliasReadResult) GetItem() *Alias
  • func (n AliasReadResult) GetResponse() *api.Response
• type AliasUpdateResult
• type AuthorizeSessionArguments
• type Client
  • func NewClient(c *api.Client) *Client
  • func (c *Client) ApiClient() *api.Client
  • func (c *Client) Create(ctx context.Context, resourceType string, scopeId string, opt ...Option) (*AliasCreateResult, error)
  • func (c *Client) Delete(ctx context.Context, id string, opt ...Option) (*AliasDeleteResult, error)
  • func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*AliasListResult, error)
  • func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*AliasReadResult, error)
  • func (c *Client) Update(ctx context.Context, id string, version uint32, opt ...Option) (*AliasUpdateResult, error)
• type Option
  • func DefaultAttributes() Option
  • func DefaultDescription() Option
  • func DefaultDestinationId() Option
  • func DefaultName() Option
  • func DefaultTargetAliasAuthorizeSessionArgumentsHostId() Option
  • func DefaultValue() Option
  • func WithAttributes(inAttributes map[string]interface{}) Option
  • func WithAutomaticVersioning(enable bool) Option
  • func WithDescription(inDescription string) Option
  • func WithDestinationId(inDestinationId string) Option
  • func WithFilter(filter string) Option
  • func WithListToken(listToken string) Option
  • func WithName(inName string) Option
  • func WithRecursive(recurse bool) Option
  • func WithSkipCurlOutput(skip bool) Option
  • func WithTargetAliasAuthorizeSessionArgumentsHostId(hid string) Option
  • func WithValue(inValue string) Option
• type TargetAliasAttributes
  • func AttributesMapToTargetAliasAttributes(in map[string]interface{}) (*TargetAliasAttributes, error)

Types

type Alias

type Alias struct {
	Id                string                 `json:"id,omitempty"`
	ScopeId           string                 `json:"scope_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"`
	Value             string                 `json:"value,omitempty"`
	DestinationId     string                 `json:"destination_id,omitempty"`
	Type              string                 `json:"type,omitempty"`
	Attributes        map[string]interface{} `json:"attributes,omitempty"`
	AuthorizedActions []string               `json:"authorized_actions,omitempty"`
}

func (*Alias) GetTargetAliasAttributes

func (pt *Alias) GetTargetAliasAttributes() (*TargetAliasAttributes, error)

type AliasCreateResult

type AliasCreateResult = AliasReadResult

type AliasDeleteResult

type AliasDeleteResult struct {
	Response *api.Response
}

func (AliasDeleteResult) GetItem

func (n AliasDeleteResult) GetItem() interface{}

GetItem will always be nil for AliasDeleteResult

func (AliasDeleteResult) GetResponse

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

type AliasListResult

type AliasListResult struct {
	Items        []*Alias `json:"items,omitempty"`
	EstItemCount uint     `json:"est_item_count,omitempty"`
	RemovedIds   []string `json:"removed_ids,omitempty"`
	ListToken    string   `json:"list_token,omitempty"`
	ResponseType string   `json:"response_type,omitempty"`
	Response     *api.Response
}

func (AliasListResult) GetEstItemCount

func (n AliasListResult) GetEstItemCount() uint

func (AliasListResult) GetItems

func (n AliasListResult) GetItems() []*Alias

func (AliasListResult) GetListToken

func (n AliasListResult) GetListToken() string

func (AliasListResult) GetRemovedIds

func (n AliasListResult) GetRemovedIds() []string

func (AliasListResult) GetResponse

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

func (AliasListResult) GetResponseType

func (n AliasListResult) GetResponseType() string

type AliasReadResult

type AliasReadResult struct {
	Item     *Alias
	Response *api.Response
}

func (AliasReadResult) GetItem

func (n AliasReadResult) GetItem() *Alias

func (AliasReadResult) GetResponse

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

type AliasUpdateResult

type AliasUpdateResult = AliasReadResult

type AuthorizeSessionArguments

type AuthorizeSessionArguments struct {
	HostId string `json:"host_id,omitempty"`
}

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, resourceType string, scopeId string, opt ...Option) (*AliasCreateResult, error)

func (*Client) Delete

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

func (*Client) List

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

func (*Client) Read

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

func (*Client) Update

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

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 the 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 DefaultDestinationId

func DefaultDestinationId() Option

func DefaultName

func DefaultName() Option

func DefaultTargetAliasAuthorizeSessionArgumentsHostId

func DefaultTargetAliasAuthorizeSessionArgumentsHostId() Option

func DefaultValue

func DefaultValue() 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 WithDestinationId

func WithDestinationId(inDestinationId 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 WithListToken

func WithListToken(listToken string) Option

WithListToken tells the API to use the provided list token for listing operations on this resource.

func WithName

func WithName(inName string) Option

func WithRecursive

func WithRecursive(recurse bool) Option

WithRecursive tells the API to use recursion for listing operations on this resource

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 WithTargetAliasAuthorizeSessionArgumentsHostId

func WithTargetAliasAuthorizeSessionArgumentsHostId(hid string) Option

func WithValue

func WithValue(inValue string) Option

type TargetAliasAttributes

type TargetAliasAttributes struct {
	AuthorizeSessionArguments *AuthorizeSessionArguments `json:"authorize_session_arguments,omitempty"`
}

func AttributesMapToTargetAliasAttributes

func AttributesMapToTargetAliasAttributes(in map[string]interface{}) (*TargetAliasAttributes, error)