sessions

Documentation

Overview

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

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) Cancel(ctx context.Context, sessionId string, version uint32, opt ...Option) (*SessionUpdateResult, error)
  • func (c *Client) List(ctx context.Context, scopeId string, opt ...Option) (*SessionListResult, error)
  • func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*SessionReadResult, error)
• type Option
  • func WithAutomaticVersioning(enable bool) Option
  • func WithFilter(filter string) Option
  • func WithRecursive(recurse bool) Option
  • func WithSkipCurlOutput(skip bool) Option
• type Session
• type SessionCreateResult
• type SessionDeleteResult
  • func (n SessionDeleteResult) GetItem() interface{}
  • func (n SessionDeleteResult) GetResponse() *api.Response
• type SessionListResult
  • func (n SessionListResult) GetItems() interface{}
  • func (n SessionListResult) GetResponse() *api.Response
• type SessionReadResult
  • func (n SessionReadResult) GetItem() interface{}
  • func (n SessionReadResult) GetResponse() *api.Response
• type SessionState
• type SessionUpdateResult
• type WorkerInfo

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) Cancel

func (c *Client) Cancel(ctx context.Context, sessionId string, version uint32, opt ...Option) (*SessionUpdateResult, error)

func (*Client) List

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

func (*Client) Read

func (c *Client) Read(ctx context.Context, id string, opt ...Option) (*SessionReadResult, 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 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 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 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 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.

type Session

type Session struct {
	Id                string            `json:"id,omitempty"`
	TargetId          string            `json:"target_id,omitempty"`
	Scope             *scopes.ScopeInfo `json:"scope,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"`
	ExpirationTime    time.Time         `json:"expiration_time,omitempty"`
	AuthTokenId       string            `json:"auth_token_id,omitempty"`
	UserId            string            `json:"user_id,omitempty"`
	HostSetId         string            `json:"host_set_id,omitempty"`
	HostId            string            `json:"host_id,omitempty"`
	ScopeId           string            `json:"scope_id,omitempty"`
	Endpoint          string            `json:"endpoint,omitempty"`
	States            []*SessionState   `json:"states,omitempty"`
	Status            string            `json:"status,omitempty"`
	WorkerInfo        []*WorkerInfo     `json:"worker_info,omitempty"`
	Certificate       []byte            `json:"certificate,omitempty"`
	TerminationReason string            `json:"termination_reason,omitempty"`
	AuthorizedActions []string          `json:"authorized_actions,omitempty"`
	// contains filtered or unexported fields
}

type SessionCreateResult

type SessionCreateResult = SessionReadResult

type SessionDeleteResult

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

func (SessionDeleteResult) GetItem

func (n SessionDeleteResult) GetItem() interface{}

GetItem will always be nil for SessionDeleteResult

func (SessionDeleteResult) GetResponse

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

type SessionListResult

type SessionListResult struct {
	Items []*Session
	// contains filtered or unexported fields
}

func (SessionListResult) GetItems

func (n SessionListResult) GetItems() interface{}

func (SessionListResult) GetResponse

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

type SessionReadResult

type SessionReadResult struct {
	Item *Session
	// contains filtered or unexported fields
}

func (SessionReadResult) GetItem

func (n SessionReadResult) GetItem() interface{}

func (SessionReadResult) GetResponse

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

type SessionState

type SessionState struct {
	Status    string    `json:"status,omitempty"`
	StartTime time.Time `json:"start_time,omitempty"`
	EndTime   time.Time `json:"end_time,omitempty"`
}

type SessionUpdateResult

type SessionUpdateResult = SessionReadResult

type WorkerInfo

type WorkerInfo struct {
	Address string `json:"address,omitempty"`
}