userpreferencesv1

package
v0.0.0-...-aaea047 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 9 Imported by: 7

Documentation

Index

Constants

View Source 
const (
	UserPreferencesService_GetUserPreferences_FullMethodName    = "/teleport.userpreferences.v1.UserPreferencesService/GetUserPreferences"
	UserPreferencesService_UpsertUserPreferences_FullMethodName = "/teleport.userpreferences.v1.UserPreferencesService/UpsertUserPreferences"
)

Variables

View Source 
var (
	AssistViewMode_name = map[int32]string{
		0: "ASSIST_VIEW_MODE_UNSPECIFIED",
		1: "ASSIST_VIEW_MODE_DOCKED",
		2: "ASSIST_VIEW_MODE_POPUP",
		3: "ASSIST_VIEW_MODE_POPUP_EXPANDED",
		4: "ASSIST_VIEW_MODE_POPUP_EXPANDED_SIDEBAR_VISIBLE",
	}
	AssistViewMode_value = map[string]int32{
		"ASSIST_VIEW_MODE_UNSPECIFIED":                    0,
		"ASSIST_VIEW_MODE_DOCKED":                         1,
		"ASSIST_VIEW_MODE_POPUP":                          2,
		"ASSIST_VIEW_MODE_POPUP_EXPANDED":                 3,
		"ASSIST_VIEW_MODE_POPUP_EXPANDED_SIDEBAR_VISIBLE": 4,
	}
)

Enum value maps for AssistViewMode.

View Source 
var (
	Resource_name = map[int32]string{
		0: "RESOURCE_UNSPECIFIED",
		1: "RESOURCE_WINDOWS_DESKTOPS",
		2: "RESOURCE_SERVER_SSH",
		3: "RESOURCE_DATABASES",
		4: "RESOURCE_KUBERNETES",
		5: "RESOURCE_WEB_APPLICATIONS",
	}
	Resource_value = map[string]int32{
		"RESOURCE_UNSPECIFIED":      0,
		"RESOURCE_WINDOWS_DESKTOPS": 1,
		"RESOURCE_SERVER_SSH":       2,
		"RESOURCE_DATABASES":        3,
		"RESOURCE_KUBERNETES":       4,
		"RESOURCE_WEB_APPLICATIONS": 5,
	}
)

Enum value maps for Resource.

View Source 
var (
	SideNavDrawerMode_name = map[int32]string{
		0: "SIDE_NAV_DRAWER_MODE_UNSPECIFIED",
		1: "SIDE_NAV_DRAWER_MODE_COLLAPSED",
		2: "SIDE_NAV_DRAWER_MODE_STICKY",
	}
	SideNavDrawerMode_value = map[string]int32{
		"SIDE_NAV_DRAWER_MODE_UNSPECIFIED": 0,
		"SIDE_NAV_DRAWER_MODE_COLLAPSED":   1,
		"SIDE_NAV_DRAWER_MODE_STICKY":      2,
	}
)

Enum value maps for SideNavDrawerMode.

View Source 
var (
	Theme_name = map[int32]string{
		0: "THEME_UNSPECIFIED",
		1: "THEME_LIGHT",
		2: "THEME_DARK",
	}
	Theme_value = map[string]int32{
		"THEME_UNSPECIFIED": 0,
		"THEME_LIGHT":       1,
		"THEME_DARK":        2,
	}
)

Enum value maps for Theme.

View Source 
var (
	DefaultTab_name = map[int32]string{
		0: "DEFAULT_TAB_UNSPECIFIED",
		1: "DEFAULT_TAB_ALL",
		2: "DEFAULT_TAB_PINNED",
	}
	DefaultTab_value = map[string]int32{
		"DEFAULT_TAB_UNSPECIFIED": 0,
		"DEFAULT_TAB_ALL":         1,
		"DEFAULT_TAB_PINNED":      2,
	}
)

Enum value maps for DefaultTab.

View Source 
var (
	ViewMode_name = map[int32]string{
		0: "VIEW_MODE_UNSPECIFIED",
		1: "VIEW_MODE_CARD",
		2: "VIEW_MODE_LIST",
	}
	ViewMode_value = map[string]int32{
		"VIEW_MODE_UNSPECIFIED": 0,
		"VIEW_MODE_CARD":        1,
		"VIEW_MODE_LIST":        2,
	}
)

Enum value maps for ViewMode.

View Source 
var (
	LabelsViewMode_name = map[int32]string{
		0: "LABELS_VIEW_MODE_UNSPECIFIED",
		1: "LABELS_VIEW_MODE_EXPANDED",
		2: "LABELS_VIEW_MODE_COLLAPSED",
	}
	LabelsViewMode_value = map[string]int32{
		"LABELS_VIEW_MODE_UNSPECIFIED": 0,
		"LABELS_VIEW_MODE_EXPANDED":    1,
		"LABELS_VIEW_MODE_COLLAPSED":   2,
	}
)

Enum value maps for LabelsViewMode.

View Source 
var (
	AvailableResourceMode_name = map[int32]string{
		0: "AVAILABLE_RESOURCE_MODE_UNSPECIFIED",
		1: "AVAILABLE_RESOURCE_MODE_ALL",
		2: "AVAILABLE_RESOURCE_MODE_ACCESSIBLE",
		3: "AVAILABLE_RESOURCE_MODE_REQUESTABLE",
		4: "AVAILABLE_RESOURCE_MODE_NONE",
	}
	AvailableResourceMode_value = map[string]int32{
		"AVAILABLE_RESOURCE_MODE_UNSPECIFIED": 0,
		"AVAILABLE_RESOURCE_MODE_ALL":         1,
		"AVAILABLE_RESOURCE_MODE_ACCESSIBLE":  2,
		"AVAILABLE_RESOURCE_MODE_REQUESTABLE": 3,
		"AVAILABLE_RESOURCE_MODE_NONE":        4,
	}
)

Enum value maps for AvailableResourceMode.

View Source 
var File_teleport_userpreferences_v1_access_graph_proto protoreflect.FileDescriptor
View Source 
var File_teleport_userpreferences_v1_assist_proto protoreflect.FileDescriptor
View Source 
var File_teleport_userpreferences_v1_cluster_preferences_proto protoreflect.FileDescriptor
View Source 
var File_teleport_userpreferences_v1_onboard_proto protoreflect.FileDescriptor
View Source 
var File_teleport_userpreferences_v1_sidenav_preferences_proto protoreflect.FileDescriptor
View Source 
var File_teleport_userpreferences_v1_theme_proto protoreflect.FileDescriptor
View Source 
var File_teleport_userpreferences_v1_unified_resource_preferences_proto protoreflect.FileDescriptor
View Source 
var File_teleport_userpreferences_v1_userpreferences_proto protoreflect.FileDescriptor
View Source 
var UserPreferencesService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "teleport.userpreferences.v1.UserPreferencesService",
	HandlerType: (*UserPreferencesServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetUserPreferences",
			Handler:    _UserPreferencesService_GetUserPreferences_Handler,
		},
		{
			MethodName: "UpsertUserPreferences",
			Handler:    _UserPreferencesService_UpsertUserPreferences_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "teleport/userpreferences/v1/userpreferences.proto",
}

UserPreferencesService_ServiceDesc is the grpc.ServiceDesc for UserPreferencesService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterUserPreferencesServiceServer 

func RegisterUserPreferencesServiceServer(s grpc.ServiceRegistrar, srv UserPreferencesServiceServer)

Types

type AccessGraphUserPreferences 

type AccessGraphUserPreferences struct {

	// has_been_redirected is true if the user has already been redirected to the Access Graph
	// on login, after having signed up for a trial from the Teleport Policy page.
	HasBeenRedirected bool `protobuf:"varint,1,opt,name=has_been_redirected,json=hasBeenRedirected,proto3" json:"has_been_redirected,omitempty"`
	// contains filtered or unexported fields
}

AccessGraphUserPreferences is the user preferences for Access Graph.

func (*AccessGraphUserPreferences) Descriptor deprecated 

func (*AccessGraphUserPreferences) Descriptor() ([]byte, []int)

Deprecated: Use AccessGraphUserPreferences.ProtoReflect.Descriptor instead.

func (*AccessGraphUserPreferences) GetHasBeenRedirected 

func (x *AccessGraphUserPreferences) GetHasBeenRedirected() bool

func (*AccessGraphUserPreferences) ProtoMessage 

func (*AccessGraphUserPreferences) ProtoMessage()

func (*AccessGraphUserPreferences) ProtoReflect 

func (x *AccessGraphUserPreferences) ProtoReflect() protoreflect.Message

func (*AccessGraphUserPreferences) Reset 

func (x *AccessGraphUserPreferences) Reset()

func (*AccessGraphUserPreferences) String 

func (x *AccessGraphUserPreferences) String() string

type AssistUserPreferences 

type AssistUserPreferences struct {

	// preferredLogins is an array of the logins a user would prefer to use when running a command, ordered by preference.
	PreferredLogins []string `protobuf:"bytes,1,rep,name=preferred_logins,json=preferredLogins,proto3" json:"preferred_logins,omitempty"`
	// viewMode is the way the assistant is displayed.
	ViewMode AssistViewMode `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

AssistUserPreferences is the user preferences for Assist.

func (*AssistUserPreferences) Descriptor deprecated 

func (*AssistUserPreferences) Descriptor() ([]byte, []int)

Deprecated: Use AssistUserPreferences.ProtoReflect.Descriptor instead.

func (*AssistUserPreferences) GetPreferredLogins 

func (x *AssistUserPreferences) GetPreferredLogins() []string

func (*AssistUserPreferences) GetViewMode 

func (x *AssistUserPreferences) GetViewMode() AssistViewMode

func (*AssistUserPreferences) ProtoMessage 

func (*AssistUserPreferences) ProtoMessage()

func (*AssistUserPreferences) ProtoReflect 

func (x *AssistUserPreferences) ProtoReflect() protoreflect.Message

func (*AssistUserPreferences) Reset 

func (x *AssistUserPreferences) Reset()

func (*AssistUserPreferences) String 

func (x *AssistUserPreferences) String() string

type AssistViewMode 

type AssistViewMode int32

AssistViewMode is the way the assistant is displayed. 

const (
	AssistViewMode_ASSIST_VIEW_MODE_UNSPECIFIED AssistViewMode = 0
	// DOCKED is the assistant is docked to the right hand side of the screen.
	AssistViewMode_ASSIST_VIEW_MODE_DOCKED AssistViewMode = 1
	// POPUP is the assistant is displayed as a popup.
	AssistViewMode_ASSIST_VIEW_MODE_POPUP AssistViewMode = 2
	// POPUP_EXPANDED is the assistant is displayed as a popup and expanded.
	AssistViewMode_ASSIST_VIEW_MODE_POPUP_EXPANDED AssistViewMode = 3
	// POPUP_EXPANDED_SIDEBAR_VISIBLE is the assistant is displayed as a popup and expanded with the sidebar visible.
	AssistViewMode_ASSIST_VIEW_MODE_POPUP_EXPANDED_SIDEBAR_VISIBLE AssistViewMode = 4
)

func (AssistViewMode) Descriptor 

func (AssistViewMode) Descriptor() protoreflect.EnumDescriptor

func (AssistViewMode) Enum 

func (x AssistViewMode) Enum() *AssistViewMode

func (AssistViewMode) EnumDescriptor deprecated 

func (AssistViewMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use AssistViewMode.Descriptor instead.

func (AssistViewMode) Number 

func (x AssistViewMode) Number() protoreflect.EnumNumber

func (AssistViewMode) String 

func (x AssistViewMode) String() string

func (AssistViewMode) Type 

func (AssistViewMode) Type() protoreflect.EnumType

type AvailableResourceMode 

type AvailableResourceMode int32

* AvailableResourceMode specifies which option in the availability filter menu the user has selected, if any 

const (
	AvailableResourceMode_AVAILABLE_RESOURCE_MODE_UNSPECIFIED AvailableResourceMode = 0
	AvailableResourceMode_AVAILABLE_RESOURCE_MODE_ALL         AvailableResourceMode = 1
	AvailableResourceMode_AVAILABLE_RESOURCE_MODE_ACCESSIBLE  AvailableResourceMode = 2
	AvailableResourceMode_AVAILABLE_RESOURCE_MODE_REQUESTABLE AvailableResourceMode = 3
	AvailableResourceMode_AVAILABLE_RESOURCE_MODE_NONE        AvailableResourceMode = 4
)

func (AvailableResourceMode) Descriptor 

func (AvailableResourceMode) Descriptor() protoreflect.EnumDescriptor

func (AvailableResourceMode) Enum 

func (x AvailableResourceMode) Enum() *AvailableResourceMode

func (AvailableResourceMode) EnumDescriptor deprecated 

func (AvailableResourceMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use AvailableResourceMode.Descriptor instead.

func (AvailableResourceMode) Number 

func (x AvailableResourceMode) Number() protoreflect.EnumNumber

func (AvailableResourceMode) String 

func (x AvailableResourceMode) String() string

func (AvailableResourceMode) Type 

func (AvailableResourceMode) Type() protoreflect.EnumType

type ClusterUserPreferences 

type ClusterUserPreferences struct {

	// pinned_resources is a list of pinned resources.
	PinnedResources *PinnedResourcesUserPreferences `protobuf:"bytes,1,opt,name=pinned_resources,json=pinnedResources,proto3" json:"pinned_resources,omitempty"`
	// contains filtered or unexported fields
}

ClusterUserPreferences are user preferences saved per cluster.

func (*ClusterUserPreferences) Descriptor deprecated 

func (*ClusterUserPreferences) Descriptor() ([]byte, []int)

Deprecated: Use ClusterUserPreferences.ProtoReflect.Descriptor instead.

func (*ClusterUserPreferences) GetPinnedResources 

func (x *ClusterUserPreferences) GetPinnedResources() *PinnedResourcesUserPreferences

func (*ClusterUserPreferences) ProtoMessage 

func (*ClusterUserPreferences) ProtoMessage()

func (*ClusterUserPreferences) ProtoReflect 

func (x *ClusterUserPreferences) ProtoReflect() protoreflect.Message

func (*ClusterUserPreferences) Reset 

func (x *ClusterUserPreferences) Reset()

func (*ClusterUserPreferences) String 

func (x *ClusterUserPreferences) String() string

type DefaultTab 

type DefaultTab int32

DefaultTab is the default tab selected in the unified resource web UI 

const (
	DefaultTab_DEFAULT_TAB_UNSPECIFIED DefaultTab = 0
	// ALL is all resources
	DefaultTab_DEFAULT_TAB_ALL DefaultTab = 1
	// PINNED is only pinned resources
	DefaultTab_DEFAULT_TAB_PINNED DefaultTab = 2
)

func (DefaultTab) Descriptor 

func (DefaultTab) Descriptor() protoreflect.EnumDescriptor

func (DefaultTab) Enum 

func (x DefaultTab) Enum() *DefaultTab

func (DefaultTab) EnumDescriptor deprecated 

func (DefaultTab) EnumDescriptor() ([]byte, []int)

Deprecated: Use DefaultTab.Descriptor instead.

func (DefaultTab) Number 

func (x DefaultTab) Number() protoreflect.EnumNumber

func (DefaultTab) String 

func (x DefaultTab) String() string

func (DefaultTab) Type 

func (DefaultTab) Type() protoreflect.EnumType

type GetUserPreferencesRequest 

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

GetUserPreferencesRequest is a request to get the user preferences.

func (*GetUserPreferencesRequest) Descriptor deprecated 

func (*GetUserPreferencesRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetUserPreferencesRequest.ProtoReflect.Descriptor instead.

func (*GetUserPreferencesRequest) ProtoMessage 

func (*GetUserPreferencesRequest) ProtoMessage()

func (*GetUserPreferencesRequest) ProtoReflect 

func (x *GetUserPreferencesRequest) ProtoReflect() protoreflect.Message

func (*GetUserPreferencesRequest) Reset 

func (x *GetUserPreferencesRequest) Reset()

func (*GetUserPreferencesRequest) String 

func (x *GetUserPreferencesRequest) String() string

type GetUserPreferencesResponse 

type GetUserPreferencesResponse struct {

	// preferences is the user preferences.
	Preferences *UserPreferences `protobuf:"bytes,1,opt,name=preferences,proto3" json:"preferences,omitempty"`
	// contains filtered or unexported fields
}

GetUserPreferencesResponse is a response to get the user preferences.

func (*GetUserPreferencesResponse) Descriptor deprecated 

func (*GetUserPreferencesResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetUserPreferencesResponse.ProtoReflect.Descriptor instead.

func (*GetUserPreferencesResponse) GetPreferences 

func (x *GetUserPreferencesResponse) GetPreferences() *UserPreferences

func (*GetUserPreferencesResponse) ProtoMessage 

func (*GetUserPreferencesResponse) ProtoMessage()

func (*GetUserPreferencesResponse) ProtoReflect 

func (x *GetUserPreferencesResponse) ProtoReflect() protoreflect.Message

func (*GetUserPreferencesResponse) Reset 

func (x *GetUserPreferencesResponse) Reset()

func (*GetUserPreferencesResponse) String 

func (x *GetUserPreferencesResponse) String() string

type LabelsViewMode 

type LabelsViewMode int32

* LabelsViewMode is whether the labels for resources should all be collapsed or expanded. This only applies to the list view. 

const (
	LabelsViewMode_LABELS_VIEW_MODE_UNSPECIFIED LabelsViewMode = 0
	// EXPANDED is the expanded state which shows all labels for every resource.
	LabelsViewMode_LABELS_VIEW_MODE_EXPANDED LabelsViewMode = 1
	// COLLAPSED is the collapsed state which hides all labels for every resource.
	LabelsViewMode_LABELS_VIEW_MODE_COLLAPSED LabelsViewMode = 2
)

func (LabelsViewMode) Descriptor 

func (LabelsViewMode) Descriptor() protoreflect.EnumDescriptor

func (LabelsViewMode) Enum 

func (x LabelsViewMode) Enum() *LabelsViewMode

func (LabelsViewMode) EnumDescriptor deprecated 

func (LabelsViewMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use LabelsViewMode.Descriptor instead.

func (LabelsViewMode) Number 

func (x LabelsViewMode) Number() protoreflect.EnumNumber

func (LabelsViewMode) String 

func (x LabelsViewMode) String() string

func (LabelsViewMode) Type 

func (LabelsViewMode) Type() protoreflect.EnumType

type MarketingParams 

type MarketingParams struct {

	// campaign is the UTM campaign parameter which identifies a specific product promotion
	Campaign string `protobuf:"bytes,1,opt,name=campaign,proto3" json:"campaign,omitempty"`
	// source is the UTM source parameter which identifies which site sent the traffic
	Source string `protobuf:"bytes,2,opt,name=source,proto3" json:"source,omitempty"`
	// medium is the UTM medium parameter which identifies what type of link was used
	Medium string `protobuf:"bytes,3,opt,name=medium,proto3" json:"medium,omitempty"`
	// intent is the internal query param, which identifies any additional marketing intentions
	// via internally set and directed parameters.
	Intent string `protobuf:"bytes,4,opt,name=intent,proto3" json:"intent,omitempty"`
	// contains filtered or unexported fields
}

MarketingParams are the parameters associated with a user via marketing campaign at the time of sign up. They contain both traditional Urchin Tracking Module (UTM) parameters as well as custom parameters.

func (*MarketingParams) Descriptor deprecated 

func (*MarketingParams) Descriptor() ([]byte, []int)

Deprecated: Use MarketingParams.ProtoReflect.Descriptor instead.

func (*MarketingParams) GetCampaign 

func (x *MarketingParams) GetCampaign() string

func (*MarketingParams) GetIntent 

func (x *MarketingParams) GetIntent() string

func (*MarketingParams) GetMedium 

func (x *MarketingParams) GetMedium() string

func (*MarketingParams) GetSource 

func (x *MarketingParams) GetSource() string

func (*MarketingParams) ProtoMessage 

func (*MarketingParams) ProtoMessage()

func (*MarketingParams) ProtoReflect 

func (x *MarketingParams) ProtoReflect() protoreflect.Message

func (*MarketingParams) Reset 

func (x *MarketingParams) Reset()

func (*MarketingParams) String 

func (x *MarketingParams) String() string

type OnboardUserPreferences 

type OnboardUserPreferences struct {

	// preferredResources is an array of the resources a user selected during their onboarding questionnaire.
	PreferredResources []Resource `` /* 165-byte string literal not displayed */
	// marketingParams are the parameters associated with a user via marketing campaign at the time of sign up
	MarketingParams *MarketingParams `protobuf:"bytes,2,opt,name=marketing_params,json=marketingParams,proto3" json:"marketing_params,omitempty"`
	// contains filtered or unexported fields
}

OnboardUserPreferences is the user preferences selected during onboarding.

func (*OnboardUserPreferences) Descriptor deprecated 

func (*OnboardUserPreferences) Descriptor() ([]byte, []int)

Deprecated: Use OnboardUserPreferences.ProtoReflect.Descriptor instead.

func (*OnboardUserPreferences) GetMarketingParams 

func (x *OnboardUserPreferences) GetMarketingParams() *MarketingParams

func (*OnboardUserPreferences) GetPreferredResources 

func (x *OnboardUserPreferences) GetPreferredResources() []Resource

func (*OnboardUserPreferences) ProtoMessage 

func (*OnboardUserPreferences) ProtoMessage()

func (*OnboardUserPreferences) ProtoReflect 

func (x *OnboardUserPreferences) ProtoReflect() protoreflect.Message

func (*OnboardUserPreferences) Reset 

func (x *OnboardUserPreferences) Reset()

func (*OnboardUserPreferences) String 

func (x *OnboardUserPreferences) String() string

type PinnedResourcesUserPreferences 

type PinnedResourcesUserPreferences struct {

	// resource_ids is a list of unified resource name sort keys.
	ResourceIds []string `protobuf:"bytes,1,rep,name=resource_ids,json=resourceIds,proto3" json:"resource_ids,omitempty"`
	// contains filtered or unexported fields
}

PinnedResourcesUserPreferences is a collection of resource IDs that will be displayed in the user's pinned resources tab in the Web UI.

func (*PinnedResourcesUserPreferences) Descriptor deprecated 

func (*PinnedResourcesUserPreferences) Descriptor() ([]byte, []int)

Deprecated: Use PinnedResourcesUserPreferences.ProtoReflect.Descriptor instead.

func (*PinnedResourcesUserPreferences) GetResourceIds 

func (x *PinnedResourcesUserPreferences) GetResourceIds() []string

func (*PinnedResourcesUserPreferences) ProtoMessage 

func (*PinnedResourcesUserPreferences) ProtoMessage()

func (*PinnedResourcesUserPreferences) ProtoReflect 

func (x *PinnedResourcesUserPreferences) ProtoReflect() protoreflect.Message

func (*PinnedResourcesUserPreferences) Reset 

func (x *PinnedResourcesUserPreferences) Reset()

func (*PinnedResourcesUserPreferences) String 

func (x *PinnedResourcesUserPreferences) String() string

type Resource 

type Resource int32

Resources are the Resource options in the onboarding questionnaire 

const (
	Resource_RESOURCE_UNSPECIFIED      Resource = 0
	Resource_RESOURCE_WINDOWS_DESKTOPS Resource = 1
	Resource_RESOURCE_SERVER_SSH       Resource = 2
	Resource_RESOURCE_DATABASES        Resource = 3
	Resource_RESOURCE_KUBERNETES       Resource = 4
	Resource_RESOURCE_WEB_APPLICATIONS Resource = 5
)

func (Resource) Descriptor 

func (Resource) Descriptor() protoreflect.EnumDescriptor

func (Resource) Enum 

func (x Resource) Enum() *Resource

func (Resource) EnumDescriptor deprecated 

func (Resource) EnumDescriptor() ([]byte, []int)

Deprecated: Use Resource.Descriptor instead.

func (Resource) Number 

func (x Resource) Number() protoreflect.EnumNumber

func (Resource) String 

func (x Resource) String() string

func (Resource) Type 

func (Resource) Type() protoreflect.EnumType

type SideNavDrawerMode 

type SideNavDrawerMode int32

SideNavDrawerMode is the sidenav drawer behavior preference in the frontend. 

const (
	SideNavDrawerMode_SIDE_NAV_DRAWER_MODE_UNSPECIFIED SideNavDrawerMode = 0
	// SIDE_NAV_DRAWER_MODE_COLLAPSED means the sidenav drawer collapses automatically when no longer hovering over it.
	SideNavDrawerMode_SIDE_NAV_DRAWER_MODE_COLLAPSED SideNavDrawerMode = 1
	// SIDE_NAV_DRAWER_MODE_STICKY means the sidenav drawer remains expanded at all times.
	SideNavDrawerMode_SIDE_NAV_DRAWER_MODE_STICKY SideNavDrawerMode = 2
)

func (SideNavDrawerMode) Descriptor 

func (SideNavDrawerMode) Descriptor() protoreflect.EnumDescriptor

func (SideNavDrawerMode) Enum 

func (x SideNavDrawerMode) Enum() *SideNavDrawerMode

func (SideNavDrawerMode) EnumDescriptor deprecated 

func (SideNavDrawerMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use SideNavDrawerMode.Descriptor instead.

func (SideNavDrawerMode) Number 

func (x SideNavDrawerMode) Number() protoreflect.EnumNumber

func (SideNavDrawerMode) String 

func (x SideNavDrawerMode) String() string

func (SideNavDrawerMode) Type 

func (SideNavDrawerMode) Type() protoreflect.EnumType

type Theme 

type Theme int32

Theme is a frontend theme. 

const (
	Theme_THEME_UNSPECIFIED Theme = 0
	// THEME_LIGHT is the light theme.
	Theme_THEME_LIGHT Theme = 1
	// THEME_DARK is the dark theme.
	Theme_THEME_DARK Theme = 2
)

func (Theme) Descriptor 

func (Theme) Descriptor() protoreflect.EnumDescriptor

func (Theme) Enum 

func (x Theme) Enum() *Theme

func (Theme) EnumDescriptor deprecated 

func (Theme) EnumDescriptor() ([]byte, []int)

Deprecated: Use Theme.Descriptor instead.

func (Theme) Number 

func (x Theme) Number() protoreflect.EnumNumber

func (Theme) String 

func (x Theme) String() string

func (Theme) Type 

func (Theme) Type() protoreflect.EnumType

type UnifiedResourcePreferences 

type UnifiedResourcePreferences struct {

	// default_tab is the default tab selected in the unified resource web UI
	DefaultTab DefaultTab `` /* 136-byte string literal not displayed */
	// view_mode is the view mode selected in the unified resource Web UI
	ViewMode ViewMode `` /* 128-byte string literal not displayed */
	// labels_view_mode is whether the labels for resources should all be collapsed or expanded in the unified resource Web UI list view.
	LabelsViewMode LabelsViewMode `` /* 154-byte string literal not displayed */
	// available_resource_mode specifies which option in the availability filter menu the user has selected, if any
	AvailableResourceMode AvailableResourceMode `` /* 182-byte string literal not displayed */
	// contains filtered or unexported fields
}

UnifiedResourcePreferences are preferences used in the Unified Resource web UI

func (*UnifiedResourcePreferences) Descriptor deprecated 

func (*UnifiedResourcePreferences) Descriptor() ([]byte, []int)

Deprecated: Use UnifiedResourcePreferences.ProtoReflect.Descriptor instead.

func (*UnifiedResourcePreferences) GetAvailableResourceMode 

func (x *UnifiedResourcePreferences) GetAvailableResourceMode() AvailableResourceMode

func (*UnifiedResourcePreferences) GetDefaultTab 

func (x *UnifiedResourcePreferences) GetDefaultTab() DefaultTab

func (*UnifiedResourcePreferences) GetLabelsViewMode 

func (x *UnifiedResourcePreferences) GetLabelsViewMode() LabelsViewMode

func (*UnifiedResourcePreferences) GetViewMode 

func (x *UnifiedResourcePreferences) GetViewMode() ViewMode

func (*UnifiedResourcePreferences) ProtoMessage 

func (*UnifiedResourcePreferences) ProtoMessage()

func (*UnifiedResourcePreferences) ProtoReflect 

func (x *UnifiedResourcePreferences) ProtoReflect() protoreflect.Message

func (*UnifiedResourcePreferences) Reset 

func (x *UnifiedResourcePreferences) Reset()

func (*UnifiedResourcePreferences) String 

func (x *UnifiedResourcePreferences) String() string

type UnimplementedUserPreferencesServiceServer 

type UnimplementedUserPreferencesServiceServer struct{}

UnimplementedUserPreferencesServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedUserPreferencesServiceServer) GetUserPreferences 

func (UnimplementedUserPreferencesServiceServer) GetUserPreferences(context.Context, *GetUserPreferencesRequest) (*GetUserPreferencesResponse, error)

func (UnimplementedUserPreferencesServiceServer) UpsertUserPreferences 

func (UnimplementedUserPreferencesServiceServer) UpsertUserPreferences(context.Context, *UpsertUserPreferencesRequest) (*emptypb.Empty, error)

type UnsafeUserPreferencesServiceServer 

type UnsafeUserPreferencesServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeUserPreferencesServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to UserPreferencesServiceServer will result in compilation errors.

type UpsertUserPreferencesRequest 

type UpsertUserPreferencesRequest struct {

	// preferences is the new user preferences to set.
	Preferences *UserPreferences `protobuf:"bytes,1,opt,name=preferences,proto3" json:"preferences,omitempty"`
	// contains filtered or unexported fields
}

UpsertUserPreferencesRequest is a request to create or update the user preferences.

func (*UpsertUserPreferencesRequest) Descriptor deprecated 

func (*UpsertUserPreferencesRequest) Descriptor() ([]byte, []int)

Deprecated: Use UpsertUserPreferencesRequest.ProtoReflect.Descriptor instead.

func (*UpsertUserPreferencesRequest) GetPreferences 

func (x *UpsertUserPreferencesRequest) GetPreferences() *UserPreferences

func (*UpsertUserPreferencesRequest) ProtoMessage 

func (*UpsertUserPreferencesRequest) ProtoMessage()

func (*UpsertUserPreferencesRequest) ProtoReflect 

func (x *UpsertUserPreferencesRequest) ProtoReflect() protoreflect.Message

func (*UpsertUserPreferencesRequest) Reset 

func (x *UpsertUserPreferencesRequest) Reset()

func (*UpsertUserPreferencesRequest) String 

func (x *UpsertUserPreferencesRequest) String() string

type UserPreferences 

type UserPreferences struct {

	// theme is the theme of the frontend.
	Theme Theme `protobuf:"varint,2,opt,name=theme,proto3,enum=teleport.userpreferences.v1.Theme" json:"theme,omitempty"`
	// onboard is the preferences from the onboarding questionnaire.
	Onboard *OnboardUserPreferences `protobuf:"bytes,3,opt,name=onboard,proto3" json:"onboard,omitempty"`
	// cluster_preferences are user preferences saved per cluster.
	ClusterPreferences *ClusterUserPreferences `protobuf:"bytes,4,opt,name=cluster_preferences,json=clusterPreferences,proto3" json:"cluster_preferences,omitempty"`
	// unified_resource_preferences are user preferences saved for the Unified Resource web UI
	UnifiedResourcePreferences *UnifiedResourcePreferences `` /* 141-byte string literal not displayed */
	// access_graph is the preferences for Access Graph.
	AccessGraph *AccessGraphUserPreferences `protobuf:"bytes,6,opt,name=access_graph,json=accessGraph,proto3" json:"access_graph,omitempty"`
	// side_nav_drawer_mode is the sidenav drawer behavior preference in the frontend.
	SideNavDrawerMode SideNavDrawerMode `` /* 168-byte string literal not displayed */
	// contains filtered or unexported fields
}

UserPreferences is a collection of different user changeable preferences for the frontend.

func (*UserPreferences) Descriptor deprecated 

func (*UserPreferences) Descriptor() ([]byte, []int)

Deprecated: Use UserPreferences.ProtoReflect.Descriptor instead.

func (*UserPreferences) GetAccessGraph 

func (x *UserPreferences) GetAccessGraph() *AccessGraphUserPreferences

func (*UserPreferences) GetClusterPreferences 

func (x *UserPreferences) GetClusterPreferences() *ClusterUserPreferences

func (*UserPreferences) GetOnboard 

func (x *UserPreferences) GetOnboard() *OnboardUserPreferences

func (*UserPreferences) GetSideNavDrawerMode 

func (x *UserPreferences) GetSideNavDrawerMode() SideNavDrawerMode

func (*UserPreferences) GetTheme 

func (x *UserPreferences) GetTheme() Theme

func (*UserPreferences) GetUnifiedResourcePreferences 

func (x *UserPreferences) GetUnifiedResourcePreferences() *UnifiedResourcePreferences

func (*UserPreferences) ProtoMessage 

func (*UserPreferences) ProtoMessage()

func (*UserPreferences) ProtoReflect 

func (x *UserPreferences) ProtoReflect() protoreflect.Message

func (*UserPreferences) Reset 

func (x *UserPreferences) Reset()

func (*UserPreferences) String 

func (x *UserPreferences) String() string

type UserPreferencesServiceClient 

type UserPreferencesServiceClient interface {
	// GetUserPreferences returns the user preferences for a given user.
	GetUserPreferences(ctx context.Context, in *GetUserPreferencesRequest, opts ...grpc.CallOption) (*GetUserPreferencesResponse, error)
	// UpsertUserPreferences creates or updates user preferences for a given username.
	UpsertUserPreferences(ctx context.Context, in *UpsertUserPreferencesRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

UserPreferencesServiceClient is the client API for UserPreferencesService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

UserPreferencesService is a service that stores user settings.

func NewUserPreferencesServiceClient 

func NewUserPreferencesServiceClient(cc grpc.ClientConnInterface) UserPreferencesServiceClient

type UserPreferencesServiceServer 

type UserPreferencesServiceServer interface {
	// GetUserPreferences returns the user preferences for a given user.
	GetUserPreferences(context.Context, *GetUserPreferencesRequest) (*GetUserPreferencesResponse, error)
	// UpsertUserPreferences creates or updates user preferences for a given username.
	UpsertUserPreferences(context.Context, *UpsertUserPreferencesRequest) (*emptypb.Empty, error)
	// contains filtered or unexported methods
}

UserPreferencesServiceServer is the server API for UserPreferencesService service. All implementations must embed UnimplementedUserPreferencesServiceServer for forward compatibility.

UserPreferencesService is a service that stores user settings.

type ViewMode 

type ViewMode int32

ViewMode is the view mode selected in the unified resource Web UI 

const (
	ViewMode_VIEW_MODE_UNSPECIFIED ViewMode = 0
	// CARD is the card view
	ViewMode_VIEW_MODE_CARD ViewMode = 1
	// LIST is the list view
	ViewMode_VIEW_MODE_LIST ViewMode = 2
)

func (ViewMode) Descriptor 

func (ViewMode) Descriptor() protoreflect.EnumDescriptor

func (ViewMode) Enum 

func (x ViewMode) Enum() *ViewMode

func (ViewMode) EnumDescriptor deprecated 

func (ViewMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use ViewMode.Descriptor instead.

func (ViewMode) Number 

func (x ViewMode) Number() protoreflect.EnumNumber

func (ViewMode) String 

func (x ViewMode) String() string

func (ViewMode) Type 

func (ViewMode) Type() protoreflect.EnumType

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.