internalversion

Documentation

Index

• Constants
• Variables
• func Convert_internalversion_ListOptions_To_v1_ListOptions(in *ListOptions, out *v1.ListOptions, s conversion.Scope) error
• func Convert_internalversion_List_To_v1_List(in *List, out *v1.List, s conversion.Scope) error
• func Convert_v1_ListOptions_To_internalversion_ListOptions(in *v1.ListOptions, out *ListOptions, s conversion.Scope) error
• func Convert_v1_List_To_internalversion_List(in *v1.List, out *List, s conversion.Scope) error
• func Kind(kind string) schema.GroupKind
• func RegisterConversions(s *runtime.Scheme) error
• func SetListOptionsDefaults(obj *ListOptions, isWatchListFeatureEnabled bool)
• type List
  • func (in *List) DeepCopy() *List
  • func (in *List) DeepCopyInto(out *List)
  • func (in *List) DeepCopyObject() runtime.Object
• type ListOptions
  • func (in *ListOptions) DeepCopy() *ListOptions
  • func (in *ListOptions) DeepCopyInto(out *ListOptions)
  • func (in *ListOptions) DeepCopyObject() runtime.Object

Constants

const GroupName = "meta.k8s.io"

GroupName is the group name for this API.

Variables

var (
	// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder runtime.SchemeBuilder

	AddToScheme = localSchemeBuilder.AddToScheme
)

var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func Convert_internalversion_ListOptions_To_v1_ListOptions

func Convert_internalversion_ListOptions_To_v1_ListOptions(in *ListOptions, out *v1.ListOptions, s conversion.Scope) error

Convert_internalversion_ListOptions_To_v1_ListOptions is an autogenerated conversion function.

func Convert_internalversion_List_To_v1_List

func Convert_internalversion_List_To_v1_List(in *List, out *v1.List, s conversion.Scope) error

Convert_internalversion_List_To_v1_List is an autogenerated conversion function.

func Convert_v1_ListOptions_To_internalversion_ListOptions

func Convert_v1_ListOptions_To_internalversion_ListOptions(in *v1.ListOptions, out *ListOptions, s conversion.Scope) error

Convert_v1_ListOptions_To_internalversion_ListOptions is an autogenerated conversion function.

func Convert_v1_List_To_internalversion_List

func Convert_v1_List_To_internalversion_List(in *v1.List, out *List, s conversion.Scope) error

Convert_v1_List_To_internalversion_List is an autogenerated conversion function.

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func RegisterConversions

func RegisterConversions(s *runtime.Scheme) error

RegisterConversions adds conversion functions to the given scheme. Public to allow building arbitrary schemes.

func SetListOptionsDefaults

func SetListOptionsDefaults(obj *ListOptions, isWatchListFeatureEnabled bool)

SetListOptionsDefaults sets defaults on the provided ListOptions if applicable.

TODO(#115478): once the watch-list fg is always on we register this function in the scheme (via AddTypeDefaultingFunc). TODO(#115478): when the function is registered in the scheme remove all callers of this method.

Types

type List

type List struct {
	metav1.TypeMeta
	// +optional
	metav1.ListMeta

	Items []runtime.Object
}

List holds a list of objects, which may not be known by the server.

func (*List) DeepCopy

func (in *List) DeepCopy() *List

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new List.

func (*List) DeepCopyInto

func (in *List) DeepCopyInto(out *List)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*List) DeepCopyObject

func (in *List) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type ListOptions

type ListOptions struct {
	metav1.TypeMeta

	// A selector based on labels
	LabelSelector labels.Selector
	// A selector based on fields
	FieldSelector fields.Selector
	// If true, watch for changes to this list
	Watch bool
	// allowWatchBookmarks requests watch events with type "BOOKMARK".
	// Servers that do not implement bookmarks may ignore this flag and
	// bookmarks are sent at the server's discretion. Clients should not
	// assume bookmarks are returned at any specific interval, nor may they
	// assume the server will send any BOOKMARK event during a session.
	// If this is not a watch, this field is ignored.
	// If the feature gate WatchBookmarks is not enabled in apiserver,
	// this field is ignored.
	AllowWatchBookmarks bool
	// resourceVersion sets a constraint on what resource versions a request may be served from.
	// See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
	// details.
	ResourceVersion string
	// resourceVersionMatch determines how resourceVersion is applied to list calls.
	// It is highly recommended that resourceVersionMatch be set for list calls where
	// resourceVersion is set.
	// See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for
	// details.
	ResourceVersionMatch metav1.ResourceVersionMatch

	// Timeout for the list/watch call.
	TimeoutSeconds *int64
	// Limit specifies the maximum number of results to return from the server. The server may
	// not support this field on all resource types, but if it does and more results remain it
	// will set the continue field on the returned list object.
	Limit int64
	// Continue is a token returned by the server that lets a client retrieve chunks of results
	// from the server by specifying limit. The server may reject requests for continuation tokens
	// it does not recognize and will return a 410 error if the token can no longer be used because
	// it has expired.
	Continue string

	// `sendInitialEvents=true` may be set together with `watch=true`.
	// In that case, the watch stream will begin with synthetic events to
	// produce the current state of objects in the collection. Once all such
	// events have been sent, a synthetic "Bookmark" event  will be sent.
	// The bookmark will report the ResourceVersion (RV) corresponding to the
	// set of objects, and be marked with `"k8s.io/initial-events-end": "true"` annotation.
	// Afterwards, the watch stream will proceed as usual, sending watch events
	// corresponding to changes (subsequent to the RV) to objects watched.
	//
	// When `sendInitialEvents` option is set, we require `resourceVersionMatch`
	// option to also be set. The semantic of the watch request is as following:
	// - `resourceVersionMatch` = NotOlderThan
	//   is interpreted as "data at least as new as the provided `resourceVersion`"
	//   and the bookmark event is send when the state is synced
	//   to a `resourceVersion` at least as fresh as the one provided by the ListOptions.
	//   If `resourceVersion` is unset, this is interpreted as "consistent read" and the
	//   bookmark event is send when the state is synced at least to the moment
	//   when request started being processed.
	// - `resourceVersionMatch` set to any other value or unset
	//   Invalid error is returned.
	//
	// Defaults to true if `resourceVersion=""` or `resourceVersion="0"` (for backward
	// compatibility reasons) and to false otherwise.
	SendInitialEvents *bool
}

ListOptions is the query options to a standard REST list call.

func (*ListOptions) DeepCopy

func (in *ListOptions) DeepCopy() *ListOptions

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ListOptions.

func (*ListOptions) DeepCopyInto

func (in *ListOptions) DeepCopyInto(out *ListOptions)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*ListOptions) DeepCopyObject

func (in *ListOptions) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.