kubev1

package
v0.0.0-...-4f19d90 Latest Latest
Warning

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

Go to latest
Published: May 9, 2024 License: Apache-2.0 Imports: 9 Imported by: 6

Documentation

Index

Constants

View Source
const (
	KubeService_ListKubernetesResources_FullMethodName = "/teleport.kube.v1.KubeService/ListKubernetesResources"
)

Variables

View Source
var File_teleport_kube_v1_kube_service_proto protoreflect.FileDescriptor
View Source
var KubeService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "teleport.kube.v1.KubeService",
	HandlerType: (*KubeServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListKubernetesResources",
			Handler:    _KubeService_ListKubernetesResources_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "teleport/kube/v1/kube_service.proto",
}

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

Functions

func RegisterKubeServiceServer

func RegisterKubeServiceServer(s grpc.ServiceRegistrar, srv KubeServiceServer)

Types

type KubeServiceClient

type KubeServiceClient interface {
	// ListKubernetesResources lists the Kubernetes resources without leaking details.
	ListKubernetesResources(ctx context.Context, in *ListKubernetesResourcesRequest, opts ...grpc.CallOption) (*ListKubernetesResourcesResponse, error)
}

KubeServiceClient is the client API for KubeService 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.

type KubeServiceServer

type KubeServiceServer interface {
	// ListKubernetesResources lists the Kubernetes resources without leaking details.
	ListKubernetesResources(context.Context, *ListKubernetesResourcesRequest) (*ListKubernetesResourcesResponse, error)
	// contains filtered or unexported methods
}

KubeServiceServer is the server API for KubeService service. All implementations must embed UnimplementedKubeServiceServer for forward compatibility

type ListKubernetesResourcesRequest

type ListKubernetesResourcesRequest struct {

	// ResourceType is the Kubernetes resource that is going to be retrieved.
	ResourceType string `protobuf:"bytes,1,opt,name=resource_type,json=resourceType,proto3" json:"resource_type,omitempty"`
	// Limit is the maximum amount of resources to retrieve.
	Limit int32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// StartKey is used to start listing resources from a specific spot. It
	// should be set to the previous NextKey value if using pagination, or
	// left empty.
	StartKey string `protobuf:"bytes,3,opt,name=start_key,json=startKey,proto3" json:"start_key,omitempty"`
	// Labels is a label-based matcher if non-empty.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// PredicateExpression defines boolean conditions that will be matched against the resource.
	PredicateExpression string `protobuf:"bytes,5,opt,name=predicate_expression,json=predicateExpression,proto3" json:"predicate_expression,omitempty"`
	// SearchKeywords is a list of search keywords to match against resource field values.
	SearchKeywords []string `protobuf:"bytes,6,rep,name=search_keywords,json=searchKeywords,proto3" json:"search_keywords,omitempty"`
	// SortBy describes which resource field and which direction to sort by.
	SortBy *types.SortBy `protobuf:"bytes,7,opt,name=sort_by,json=sortBy,proto3" json:"sort_by,omitempty"`
	// NeedTotalCount indicates whether or not the caller also wants the total number of resources
	// after filtering.
	NeedTotalCount bool `protobuf:"varint,8,opt,name=need_total_count,json=needTotalCount,proto3" json:"need_total_count,omitempty"`
	// UseSearchAsRoles indicates that the response should include all resources
	// the caller is able to request access to using search_as_roles
	UseSearchAsRoles bool `protobuf:"varint,9,opt,name=use_search_as_roles,json=useSearchAsRoles,proto3" json:"use_search_as_roles,omitempty"`
	// UsePreviewAsRoles indicates that the response should include all resources
	// the caller would be able to access with their preview_as_roles
	UsePreviewAsRoles bool `protobuf:"varint,11,opt,name=use_preview_as_roles,json=usePreviewAsRoles,proto3" json:"use_preview_as_roles,omitempty"`
	// TeleportCluster is the Teleport Cluster name to route the request to.
	TeleportCluster string `protobuf:"bytes,12,opt,name=teleport_cluster,json=teleportCluster,proto3" json:"teleport_cluster,omitempty"`
	// Cluster is the Kubernetes Cluster to request the resources.
	KubernetesCluster string `protobuf:"bytes,13,opt,name=kubernetes_cluster,json=kubernetesCluster,proto3" json:"kubernetes_cluster,omitempty"`
	// Namespace is the Kubernetes namespace where the resources must be located.
	// To search on every Kubernetes Namespace, do not define the value.
	KubernetesNamespace string `protobuf:"bytes,14,opt,name=kubernetes_namespace,json=kubernetesNamespace,proto3" json:"kubernetes_namespace,omitempty"`
	// contains filtered or unexported fields
}

ListKubernetesResourcesRequest defines a request to retrieve resources paginated. Only one type of resource can be retrieved per request.

func (*ListKubernetesResourcesRequest) Descriptor deprecated

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

Deprecated: Use ListKubernetesResourcesRequest.ProtoReflect.Descriptor instead.

func (*ListKubernetesResourcesRequest) GetKubernetesCluster

func (x *ListKubernetesResourcesRequest) GetKubernetesCluster() string

func (*ListKubernetesResourcesRequest) GetKubernetesNamespace

func (x *ListKubernetesResourcesRequest) GetKubernetesNamespace() string

func (*ListKubernetesResourcesRequest) GetLabels

func (x *ListKubernetesResourcesRequest) GetLabels() map[string]string

func (*ListKubernetesResourcesRequest) GetLimit

func (x *ListKubernetesResourcesRequest) GetLimit() int32

func (*ListKubernetesResourcesRequest) GetNeedTotalCount

func (x *ListKubernetesResourcesRequest) GetNeedTotalCount() bool

func (*ListKubernetesResourcesRequest) GetPredicateExpression

func (x *ListKubernetesResourcesRequest) GetPredicateExpression() string

func (*ListKubernetesResourcesRequest) GetResourceType

func (x *ListKubernetesResourcesRequest) GetResourceType() string

func (*ListKubernetesResourcesRequest) GetSearchKeywords

func (x *ListKubernetesResourcesRequest) GetSearchKeywords() []string

func (*ListKubernetesResourcesRequest) GetSortBy

func (*ListKubernetesResourcesRequest) GetStartKey

func (x *ListKubernetesResourcesRequest) GetStartKey() string

func (*ListKubernetesResourcesRequest) GetTeleportCluster

func (x *ListKubernetesResourcesRequest) GetTeleportCluster() string

func (*ListKubernetesResourcesRequest) GetUsePreviewAsRoles

func (x *ListKubernetesResourcesRequest) GetUsePreviewAsRoles() bool

func (*ListKubernetesResourcesRequest) GetUseSearchAsRoles

func (x *ListKubernetesResourcesRequest) GetUseSearchAsRoles() bool

func (*ListKubernetesResourcesRequest) ProtoMessage

func (*ListKubernetesResourcesRequest) ProtoMessage()

func (*ListKubernetesResourcesRequest) ProtoReflect

func (*ListKubernetesResourcesRequest) Reset

func (x *ListKubernetesResourcesRequest) Reset()

func (*ListKubernetesResourcesRequest) String

type ListKubernetesResourcesResponse

type ListKubernetesResourcesResponse struct {

	// Resources is a list of resource.
	Resources []*types.KubernetesResourceV1 `protobuf:"bytes,1,rep,name=resources,proto3" json:"resources,omitempty"`
	// NextKey is the next Key to use as StartKey in a ListResourcesRequest to
	// continue retrieving pages of resource. If NextKey is empty, there are no
	// more pages.
	NextKey string `protobuf:"bytes,2,opt,name=next_key,json=nextKey,proto3" json:"next_key,omitempty"`
	// TotalCount is the total number of resources available after filter, if any.
	TotalCount int32 `protobuf:"varint,3,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"`
	// contains filtered or unexported fields
}

ListKubernetesResourcesResponse is the response of ListKubernetesResources method.

func (*ListKubernetesResourcesResponse) Descriptor deprecated

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

Deprecated: Use ListKubernetesResourcesResponse.ProtoReflect.Descriptor instead.

func (*ListKubernetesResourcesResponse) GetNextKey

func (x *ListKubernetesResourcesResponse) GetNextKey() string

func (*ListKubernetesResourcesResponse) GetResources

func (*ListKubernetesResourcesResponse) GetTotalCount

func (x *ListKubernetesResourcesResponse) GetTotalCount() int32

func (*ListKubernetesResourcesResponse) ProtoMessage

func (*ListKubernetesResourcesResponse) ProtoMessage()

func (*ListKubernetesResourcesResponse) ProtoReflect

func (*ListKubernetesResourcesResponse) Reset

func (*ListKubernetesResourcesResponse) String

type UnimplementedKubeServiceServer

type UnimplementedKubeServiceServer struct {
}

UnimplementedKubeServiceServer must be embedded to have forward compatible implementations.

type UnsafeKubeServiceServer

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

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

Jump to

Keyboard shortcuts

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