sessionrecordings

package
v0.0.62 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 8, 2026 License: MPL-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ChannelRecording

type ChannelRecording struct {
	Id             string                 `json:"id,omitempty"`
	BytesUp        uint64                 `json:"bytes_up,string,omitempty"`
	BytesDown      uint64                 `json:"bytes_down,string,omitempty"`
	CreatedTime    time.Time              `json:"created_time,omitempty"`
	UpdatedTime    time.Time              `json:"updated_time,omitempty"`
	StartTime      time.Time              `json:"start_time,omitempty"`
	EndTime        time.Time              `json:"end_time,omitempty"`
	Duration       api.Duration           `json:"duration,omitempty"`
	MimeTypes      []string               `json:"mime_types,omitempty"`
	RecordingState *RecordingState        `json:"recording_state,omitempty"`
	Attributes     map[string]interface{} `json:"attributes,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) CancelExport added in v0.0.62

func (c *Client) CancelExport(ctx context.Context, exportId string, opt ...Option) (*ExportDeleteResult, error)

CancelExport cancels an existing export.

func (*Client) Delete added in v0.0.45

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

func (*Client) Download

func (c *Client) Download(ctx context.Context, contentId string, opt ...Option) (io.ReadCloser, error)

Download makes a Boundary request to download the requested session recording or media resource.

func (*Client) Export added in v0.0.62

func (c *Client) Export(ctx context.Context, connectionRecordingId, mimeType string, opt ...Option) (*ExportCreateResult, error)

Export starts an export against a session recording connection.

func (*Client) List

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

func (*Client) ListExports added in v0.0.62

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

ListExports lists existing session recording exports.

func (*Client) ListExportsNextPage added in v0.0.62

func (c *Client) ListExportsNextPage(ctx context.Context, currentPage *ExportListResult, opt ...Option) (*ExportListResult, error)

ListExportsNextPage obtains the next page of an export listing process, given the current page.

func (*Client) ListNextPage added in v0.0.53

func (c *Client) ListNextPage(ctx context.Context, currentPage *SessionRecordingListResult, opt ...Option) (*SessionRecordingListResult, error)

func (*Client) ReApplyStoragePolicy added in v0.0.45

func (c *Client) ReApplyStoragePolicy(ctx context.Context, contentId string, opt ...Option) (*SessionRecordingReadResult, error)

ReApplyStoragePolicy will reapply a storage policy to a session recording.

func (*Client) Read

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

func (*Client) ReadExport added in v0.0.62

func (c *Client) ReadExport(ctx context.Context, exportId string, opt ...Option) (*ExportReadResult, error)

ReadExport reads an export.

type ConnectionRecording

type ConnectionRecording struct {
	Id                string              `json:"id,omitempty"`
	BytesUp           uint64              `json:"bytes_up,string,omitempty"`
	BytesDown         uint64              `json:"bytes_down,string,omitempty"`
	CreatedTime       time.Time           `json:"created_time,omitempty"`
	UpdatedTime       time.Time           `json:"updated_time,omitempty"`
	StartTime         time.Time           `json:"start_time,omitempty"`
	EndTime           time.Time           `json:"end_time,omitempty"`
	Duration          api.Duration        `json:"duration,omitempty"`
	MimeTypes         []string            `json:"mime_types,omitempty"`
	ChannelRecordings []*ChannelRecording `json:"channel_recordings,omitempty"`
	RecordingState    *RecordingState     `json:"recording_state,omitempty"`
	Exports           []*Export           `json:"exports,omitempty"`
	Videos            []*Video            `json:"videos,omitempty"`
}

type Credential added in v0.0.40

type Credential struct {
	Id              string                 `json:"id,omitempty"`
	CredentialStore *CredentialStore       `json:"credential_store,omitempty"`
	Name            string                 `json:"name,omitempty"`
	Description     string                 `json:"description,omitempty"`
	Purposes        []string               `json:"purposes,omitempty"`
	Type            string                 `json:"type,omitempty"`
	Attributes      map[string]interface{} `json:"attributes,omitempty"`
}

func (*Credential) GetJsonCredentialAttributes added in v0.0.40

func (pt *Credential) GetJsonCredentialAttributes() (*JsonCredentialAttributes, error)

func (*Credential) GetPasswordCredentialAttributes added in v0.0.59

func (pt *Credential) GetPasswordCredentialAttributes() (*PasswordCredentialAttributes, error)

func (*Credential) GetSshPrivateKeyCredentialAttributes added in v0.0.40

func (pt *Credential) GetSshPrivateKeyCredentialAttributes() (*SshPrivateKeyCredentialAttributes, error)

func (*Credential) GetUsernamePasswordCredentialAttributes added in v0.0.40

func (pt *Credential) GetUsernamePasswordCredentialAttributes() (*UsernamePasswordCredentialAttributes, error)

func (*Credential) GetUsernamePasswordDomainCredentialAttributes added in v0.0.62

func (pt *Credential) GetUsernamePasswordDomainCredentialAttributes() (*UsernamePasswordDomainCredentialAttributes, error)

type CredentialLibrary added in v0.0.40

type CredentialLibrary struct {
	Id              string                 `json:"id,omitempty"`
	CredentialStore *CredentialStore       `json:"credential_store,omitempty"`
	Name            string                 `json:"name,omitempty"`
	Description     string                 `json:"description,omitempty"`
	Purposes        []string               `json:"purposes,omitempty"`
	Type            string                 `json:"type,omitempty"`
	Attributes      map[string]interface{} `json:"attributes,omitempty"`
}

func (*CredentialLibrary) GetVaultCredentialLibraryAttributes added in v0.0.40

func (pt *CredentialLibrary) GetVaultCredentialLibraryAttributes() (*VaultCredentialLibraryAttributes, error)

func (*CredentialLibrary) GetVaultLdapCredentialLibraryAttributes added in v0.0.62

func (pt *CredentialLibrary) GetVaultLdapCredentialLibraryAttributes() (*VaultLdapCredentialLibraryAttributes, error)

func (*CredentialLibrary) GetVaultSSHCertificateCredentialLibraryAttributes added in v0.0.40

func (pt *CredentialLibrary) GetVaultSSHCertificateCredentialLibraryAttributes() (*VaultSSHCertificateCredentialLibraryAttributes, error)

type CredentialStore added in v0.0.40

type CredentialStore struct {
	Id          string                 `json:"id,omitempty"`
	ScopeId     string                 `json:"scope_id,omitempty"`
	Name        string                 `json:"name,omitempty"`
	Description string                 `json:"description,omitempty"`
	Type        string                 `json:"type,omitempty"`
	Attributes  map[string]interface{} `json:"attributes,omitempty"`
}

func (*CredentialStore) GetVaultCredentialStoreAttributes added in v0.0.40

func (pt *CredentialStore) GetVaultCredentialStoreAttributes() (*VaultCredentialStoreAttributes, error)

type Export added in v0.0.62

type Export struct {
	Id                    string            `json:"id,omitempty"`
	Scope                 *scopes.ScopeInfo `json:"scope,omitempty"`
	MimeType              string            `json:"mime_type,omitempty"`
	State                 string            `json:"state,omitempty"`
	ProgressPercent       uint32            `json:"progress_percent,omitempty"`
	WorkerId              string            `json:"worker_id,omitempty"`
	CreatedTime           time.Time         `json:"created_time,omitempty"`
	UpdatedTime           time.Time         `json:"updated_time,omitempty"`
	Version               uint32            `json:"version,omitempty"`
	ConnectionRecordingId string            `json:"connection_recording_id,omitempty"`
	Error                 string            `json:"error,omitempty"`
	AuthorizedActions     []string          `json:"authorized_actions,omitempty"`
}

type ExportCreateResult added in v0.0.62

type ExportCreateResult = ExportReadResult

type ExportDeleteResult added in v0.0.62

type ExportDeleteResult struct {
	Response *api.Response
}

func (ExportDeleteResult) GetItem added in v0.0.62

func (n ExportDeleteResult) GetItem() any

GetItem will always be nil for ExportDeleteResult

func (ExportDeleteResult) GetResponse added in v0.0.62

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

type ExportListResult added in v0.0.62

type ExportListResult struct {
	Items        []*Export `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
	// contains filtered or unexported fields
}

func (ExportListResult) GetEstItemCount added in v0.0.62

func (n ExportListResult) GetEstItemCount() uint

func (ExportListResult) GetItems added in v0.0.62

func (n ExportListResult) GetItems() []*Export

func (ExportListResult) GetListToken added in v0.0.62

func (n ExportListResult) GetListToken() string

func (ExportListResult) GetRemovedIds added in v0.0.62

func (n ExportListResult) GetRemovedIds() []string

func (ExportListResult) GetResponse added in v0.0.62

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

func (ExportListResult) GetResponseType added in v0.0.62

func (n ExportListResult) GetResponseType() string

type ExportReadResult added in v0.0.62

type ExportReadResult struct {
	Item     *Export
	Response *api.Response
}

func (ExportReadResult) GetItem added in v0.0.62

func (n ExportReadResult) GetItem() *Export

func (ExportReadResult) GetResponse added in v0.0.62

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

type Host

type Host struct {
	Id           string                 `json:"id,omitempty"`
	HostCatalog  *HostCatalog           `json:"host_catalog,omitempty"`
	Name         string                 `json:"name,omitempty"`
	Description  string                 `json:"description,omitempty"`
	Type         string                 `json:"type,omitempty"`
	Attributes   map[string]interface{} `json:"attributes,omitempty"`
	ExternalId   string                 `json:"external_id,omitempty"`
	ExternalName string                 `json:"external_name,omitempty"`
}

func (*Host) GetStaticHostAttributes

func (pt *Host) GetStaticHostAttributes() (*StaticHostAttributes, error)

type HostCatalog

type HostCatalog struct {
	Id          string                 `json:"id,omitempty"`
	Scope       *scopes.ScopeInfo      `json:"scope,omitempty"`
	PluginId    string                 `json:"plugin_id,omitempty"`
	Name        string                 `json:"name,omitempty"`
	Description string                 `json:"description,omitempty"`
	Type        string                 `json:"type,omitempty"`
	Attributes  map[string]interface{} `json:"attributes,omitempty"`
}

type JsonCredentialAttributes added in v0.0.40

type JsonCredentialAttributes struct {
	ObjectHmac string `json:"object_hmac,omitempty"`
}

func AttributesMapToJsonCredentialAttributes added in v0.0.40

func AttributesMapToJsonCredentialAttributes(in map[string]any) (*JsonCredentialAttributes, 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 WithClientDirectedPagination added in v0.0.53

func WithClientDirectedPagination(with bool) Option

WithClientDirectedPagination tells the List function to return only the first page, if more pages are available

func WithListToken added in v0.0.44

func WithListToken(listToken string) Option

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

func WithMimeType added in v0.0.62

func WithMimeType(mimeType string) Option

WithMimeType tells the API to set a specific mime-type on this request.

func WithPageSize added in v0.0.53

func WithPageSize(with uint32) Option

WithPageSize controls the size of pages used during List

func WithRecursive

func WithRecursive(recurse bool) Option

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

func WithResourcePathOverride added in v0.0.53

func WithResourcePathOverride(path string) Option

WithResourcePathOverride tells the API to use the provided resource path

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 PasswordCredentialAttributes added in v0.0.59

type PasswordCredentialAttributes struct {
	PasswordHmac string `json:"password_hmac,omitempty"`
}

func AttributesMapToPasswordCredentialAttributes added in v0.0.59

func AttributesMapToPasswordCredentialAttributes(in map[string]any) (*PasswordCredentialAttributes, error)

type RdpTargetAttributes added in v0.0.62

type RdpTargetAttributes struct {
	DefaultPort       uint32 `json:"default_port,omitempty"`
	DefaultClientPort uint32 `json:"default_client_port,omitempty"`
}

func AttributesMapToRdpTargetAttributes added in v0.0.62

func AttributesMapToRdpTargetAttributes(in map[string]any) (*RdpTargetAttributes, error)

type RecordingState added in v0.0.62

type RecordingState struct {
	StorageState             string `json:"storage_state,omitempty"`
	SyncingErrorDetails      string `json:"syncing_error_details,omitempty"`
	VerificationErrorDetails string `json:"verification_error_details,omitempty"`
}

type SessionRecording

type SessionRecording struct {
	Id                   string                 `json:"id,omitempty"`
	Scope                *scopes.ScopeInfo      `json:"scope,omitempty"`
	SessionId            string                 `json:"session_id,omitempty"`
	StorageBucketId      string                 `json:"storage_bucket_id,omitempty"`
	BytesUp              uint64                 `json:"bytes_up,string,omitempty"`
	BytesDown            uint64                 `json:"bytes_down,string,omitempty"`
	CreatedTime          time.Time              `json:"created_time,omitempty"`
	UpdatedTime          time.Time              `json:"updated_time,omitempty"`
	StartTime            time.Time              `json:"start_time,omitempty"`
	EndTime              time.Time              `json:"end_time,omitempty"`
	Duration             api.Duration           `json:"duration,omitempty"`
	Type                 string                 `json:"type,omitempty"`
	State                string                 `json:"state,omitempty"`
	ErrorDetails         string                 `json:"error_details,omitempty"`
	MimeTypes            []string               `json:"mime_types,omitempty"`
	Endpoint             string                 `json:"endpoint,omitempty"`
	ConnectionRecordings []*ConnectionRecording `json:"connection_recordings,omitempty"`
	CreateTimeValues     *ValuesAtTime          `json:"create_time_values,omitempty"`
	AuthorizedActions    []string               `json:"authorized_actions,omitempty"`
	RetainUntil          time.Time              `json:"retain_until,omitempty"`
	DeleteAfter          time.Time              `json:"delete_after,omitempty"`
	Availability         string                 `json:"availability,omitempty"`
	RecordingState       *RecordingState        `json:"recording_state,omitempty"`
}

type SessionRecordingDeleteResult added in v0.0.45

type SessionRecordingDeleteResult struct {
	Response *api.Response
}

func (SessionRecordingDeleteResult) GetItem added in v0.0.45

func (n SessionRecordingDeleteResult) GetItem() any

GetItem will always be nil for SessionRecordingDeleteResult

func (SessionRecordingDeleteResult) GetResponse added in v0.0.45

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

type SessionRecordingListResult

type SessionRecordingListResult struct {
	Items        []*SessionRecording `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
	// contains filtered or unexported fields
}

func (SessionRecordingListResult) GetEstItemCount added in v0.0.44

func (n SessionRecordingListResult) GetEstItemCount() uint

func (SessionRecordingListResult) GetItems

func (SessionRecordingListResult) GetListToken added in v0.0.44

func (n SessionRecordingListResult) GetListToken() string

func (SessionRecordingListResult) GetRemovedIds added in v0.0.44

func (n SessionRecordingListResult) GetRemovedIds() []string

func (SessionRecordingListResult) GetResponse

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

func (SessionRecordingListResult) GetResponseType added in v0.0.44

func (n SessionRecordingListResult) GetResponseType() string

type SessionRecordingReadResult

type SessionRecordingReadResult struct {
	Item     *SessionRecording
	Response *api.Response
}

func (SessionRecordingReadResult) GetItem

func (SessionRecordingReadResult) GetResponse

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

type SshPrivateKeyCredentialAttributes added in v0.0.40

type SshPrivateKeyCredentialAttributes struct {
	Username                 string `json:"username,omitempty"`
	PrivateKeyHmac           string `json:"private_key_hmac,omitempty"`
	PrivateKeyPassphraseHmac string `json:"private_key_passphrase_hmac,omitempty"`
}

func AttributesMapToSshPrivateKeyCredentialAttributes added in v0.0.40

func AttributesMapToSshPrivateKeyCredentialAttributes(in map[string]any) (*SshPrivateKeyCredentialAttributes, error)

type SshTargetAttributes

type SshTargetAttributes struct {
	DefaultPort       uint32 `json:"default_port,omitempty"`
	DefaultClientPort uint32 `json:"default_client_port,omitempty"`
}

func AttributesMapToSshTargetAttributes

func AttributesMapToSshTargetAttributes(in map[string]any) (*SshTargetAttributes, error)

type StaticHostAttributes

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

func AttributesMapToStaticHostAttributes

func AttributesMapToStaticHostAttributes(in map[string]any) (*StaticHostAttributes, error)

type Target

type Target struct {
	Id                     string                 `json:"id,omitempty"`
	Name                   string                 `json:"name,omitempty"`
	Description            string                 `json:"description,omitempty"`
	Scope                  *scopes.ScopeInfo      `json:"scope,omitempty"`
	SessionMaxSeconds      uint32                 `json:"session_max_seconds,omitempty"`
	SessionConnectionLimit int32                  `json:"session_connection_limit,omitempty"`
	WorkerFilter           string                 `json:"worker_filter,omitempty"`
	EgressWorkerFilter     string                 `json:"egress_worker_filter,omitempty"`
	IngressWorkerFilter    string                 `json:"ingress_worker_filter,omitempty"`
	Type                   string                 `json:"type,omitempty"`
	Attributes             map[string]interface{} `json:"attributes,omitempty"`
}

func (*Target) GetRdpTargetAttributes added in v0.0.62

func (pt *Target) GetRdpTargetAttributes() (*RdpTargetAttributes, error)

func (*Target) GetSshTargetAttributes

func (pt *Target) GetSshTargetAttributes() (*SshTargetAttributes, error)

type User

type User struct {
	Id          string            `json:"id,omitempty"`
	Name        string            `json:"name,omitempty"`
	Description string            `json:"description,omitempty"`
	Scope       *scopes.ScopeInfo `json:"scope,omitempty"`
}

type UsernamePasswordCredentialAttributes added in v0.0.40

type UsernamePasswordCredentialAttributes struct {
	Username     string `json:"username,omitempty"`
	PasswordHmac string `json:"password_hmac,omitempty"`
}

func AttributesMapToUsernamePasswordCredentialAttributes added in v0.0.40

func AttributesMapToUsernamePasswordCredentialAttributes(in map[string]any) (*UsernamePasswordCredentialAttributes, error)

type UsernamePasswordDomainCredentialAttributes added in v0.0.62

type UsernamePasswordDomainCredentialAttributes struct {
	Username     string `json:"username,omitempty"`
	PasswordHmac string `json:"password_hmac,omitempty"`
	Domain       string `json:"domain,omitempty"`
}

func AttributesMapToUsernamePasswordDomainCredentialAttributes added in v0.0.62

func AttributesMapToUsernamePasswordDomainCredentialAttributes(in map[string]any) (*UsernamePasswordDomainCredentialAttributes, error)

type ValuesAtTime

type ValuesAtTime struct {
	User                *User                `json:"user,omitempty"`
	Target              *Target              `json:"target,omitempty"`
	Host                *Host                `json:"host,omitempty"`
	Credentials         []*Credential        `json:"credentials,omitempty"`
	CredentialLibraries []*CredentialLibrary `json:"credential_libraries,omitempty"`
}

type VaultCredentialLibraryAttributes added in v0.0.40

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

func AttributesMapToVaultCredentialLibraryAttributes added in v0.0.40

func AttributesMapToVaultCredentialLibraryAttributes(in map[string]any) (*VaultCredentialLibraryAttributes, error)

type VaultCredentialStoreAttributes added in v0.0.40

type VaultCredentialStoreAttributes struct {
	Address       string `json:"address,omitempty"`
	Namespace     string `json:"namespace,omitempty"`
	TlsServerName string `json:"tls_server_name,omitempty"`
	TlsSkipVerify bool   `json:"tls_skip_verify,omitempty"`
	WorkerFilter  string `json:"worker_filter,omitempty"`
}

func AttributesMapToVaultCredentialStoreAttributes added in v0.0.40

func AttributesMapToVaultCredentialStoreAttributes(in map[string]any) (*VaultCredentialStoreAttributes, error)

type VaultLdapCredentialLibraryAttributes added in v0.0.62

type VaultLdapCredentialLibraryAttributes struct {
	Path string `json:"path,omitempty"`
}

func AttributesMapToVaultLdapCredentialLibraryAttributes added in v0.0.62

func AttributesMapToVaultLdapCredentialLibraryAttributes(in map[string]any) (*VaultLdapCredentialLibraryAttributes, error)

type VaultSSHCertificateCredentialLibraryAttributes added in v0.0.40

type VaultSSHCertificateCredentialLibraryAttributes struct {
	Path                      string            `json:"path,omitempty"`
	Username                  string            `json:"username,omitempty"`
	KeyType                   string            `json:"key_type,omitempty"`
	KeyBits                   uint32            `json:"key_bits,omitempty"`
	Ttl                       string            `json:"ttl,omitempty"`
	CriticalOptions           map[string]string `json:"critical_options,omitempty"`
	Extensions                map[string]string `json:"extensions,omitempty"`
	AdditionalValidPrincipals []string          `json:"additional_valid_principals,omitempty"`
}

func AttributesMapToVaultSSHCertificateCredentialLibraryAttributes added in v0.0.40

func AttributesMapToVaultSSHCertificateCredentialLibraryAttributes(in map[string]any) (*VaultSSHCertificateCredentialLibraryAttributes, error)

type Video added in v0.0.62

type Video struct {
	Id            string    `json:"id,omitempty"`
	CreatedTime   time.Time `json:"created_time,omitempty"`
	LengthSeconds uint64    `json:"length_seconds,string,omitempty"`
	SizeBytes     uint64    `json:"size_bytes,string,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL