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 (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, sessionId string, opt ...Option) (*SessionReadResult, error)
- type Option
- type Session
- type SessionCreateResult
- type SessionDeleteResult
- type SessionListResult
- type SessionReadResult
- type SessionState
- type SessionUpdateResult
- type WorkerInfo
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a client for this collection
func NewClient ¶
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.
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 ¶
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.
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"` // contains filtered or unexported fields }
func (Session) ResponseBody ¶
func (Session) ResponseMap ¶
type SessionCreateResult ¶
type SessionCreateResult = SessionReadResult
type SessionDeleteResult ¶
type SessionDeleteResult struct {
// contains filtered or unexported fields
}
func (SessionDeleteResult) GetResponseBody ¶
func (n SessionDeleteResult) GetResponseBody() *bytes.Buffer
func (SessionDeleteResult) GetResponseMap ¶
func (n SessionDeleteResult) GetResponseMap() map[string]interface{}
type SessionListResult ¶
type SessionListResult struct { Items []*Session // contains filtered or unexported fields }
func (SessionListResult) GetItems ¶
func (n SessionListResult) GetItems() interface{}
func (SessionListResult) GetResponseBody ¶
func (n SessionListResult) GetResponseBody() *bytes.Buffer
func (SessionListResult) GetResponseMap ¶
func (n SessionListResult) GetResponseMap() map[string]interface{}
type SessionReadResult ¶
type SessionReadResult struct { Item *Session // contains filtered or unexported fields }
func (SessionReadResult) GetItem ¶
func (n SessionReadResult) GetItem() interface{}
func (SessionReadResult) GetResponseBody ¶
func (n SessionReadResult) GetResponseBody() *bytes.Buffer
func (SessionReadResult) GetResponseMap ¶
func (n SessionReadResult) GetResponseMap() map[string]interface{}
type SessionState ¶
type SessionUpdateResult ¶
type SessionUpdateResult = SessionReadResult
type WorkerInfo ¶
type WorkerInfo struct {
Address string `json:"address,omitempty"`
}