apidiscovery

package
v1.27.11 Latest Latest
Warning

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

Go to latest
Published: Feb 14, 2024 License: Apache-2.0 Imports: 3 Imported by: 1

Documentation

Overview

Package apidiscovery provides api definitions for the "apidiscovery.k8s.io" api group.

Index

Constants

View Source
const GroupName = "apidiscovery.k8s.io"

GroupName is the name of api group

Variables

View Source
var (
	// SchemeBuilder installs the api group to a scheme
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme adds api to a scheme
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type APIGroupDiscovery

type APIGroupDiscovery struct {
	v1.TypeMeta
	// Standard object's metadata.
	// The only field completed will be name. For instance, resourceVersion will be empty.
	// name is the name of the API group whose discovery information is presented here.
	// name is allowed to be "" to represent the legacy, ungroupified resources.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	v1.ObjectMeta
	// versions are the versions supported in this group. They are sorted in descending order of preference,
	// with the preferred version being the first entry.
	// +listType=map
	// +listMapKey=version
	Versions []APIVersionDiscovery
}

APIGroupDiscovery holds information about which resources are being served for all version of the API Group. It contains a list of APIVersionDiscovery that holds a list of APIResourceDiscovery types served for a version. Versions are in descending order of preference, with the first version being the preferred entry.

func (*APIGroupDiscovery) DeepCopy

func (in *APIGroupDiscovery) DeepCopy() *APIGroupDiscovery

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

func (*APIGroupDiscovery) DeepCopyInto

func (in *APIGroupDiscovery) DeepCopyInto(out *APIGroupDiscovery)

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

func (*APIGroupDiscovery) DeepCopyObject

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

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

type APIGroupDiscoveryList

type APIGroupDiscoveryList struct {
	v1.TypeMeta
	// ResourceVersion will not be set, because this does not have a replayable ordering among multiple apiservers.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
	// +optional
	v1.ListMeta
	// items is the list of groups for discovery. The groups are listed in priority order.
	Items []APIGroupDiscovery
}

APIGroupDiscoveryList is a resource containing a list of APIGroupDiscovery. This is one of the types able to be returned from the /api and /apis endpoint and contains an aggregated list of API resources (built-ins, Custom Resource Definitions, resources from aggregated servers) that a cluster supports.

func (*APIGroupDiscoveryList) DeepCopy

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

func (*APIGroupDiscoveryList) DeepCopyInto

func (in *APIGroupDiscoveryList) DeepCopyInto(out *APIGroupDiscoveryList)

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

func (*APIGroupDiscoveryList) DeepCopyObject

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

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

type APIResourceDiscovery

type APIResourceDiscovery struct {
	// resource is the plural name of the resource.  This is used in the URL path and is the unique identifier
	// for this resource across all versions in the API group.
	// Resources with non-empty groups are located at /apis/<APIGroupDiscovery.objectMeta.name>/<APIVersionDiscovery.version>/<APIResourceDiscovery.Resource>
	// Resources with empty groups are located at /api/v1/<APIResourceDiscovery.Resource>
	Resource string
	// responseKind describes the group, version, and kind of the serialization schema for the object type this endpoint typically returns.
	// APIs may return other objects types at their discretion, such as error conditions, requests for alternate representations, or other operation specific behavior.
	// This value will be null or empty if an APIService reports subresources but supports no operations on the parent resource
	ResponseKind *v1.GroupVersionKind
	// scope indicates the scope of a resource, either Cluster or Namespaced
	Scope ResourceScope
	// singularResource is the singular name of the resource.  This allows clients to handle plural and singular opaquely.
	// For many clients the singular form of the resource will be more understandable to users reading messages and should be used when integrating the name of the resource into a sentence.
	// The command line tool kubectl, for example, allows use of the singular resource name in place of plurals.
	// The singular form of a resource should always be an optional element - when in doubt use the canonical resource name.
	SingularResource string
	// verbs is a list of supported API operation types (this includes
	// but is not limited to get, list, watch, create, update, patch,
	// delete, deletecollection, and proxy).
	// +listType=set
	Verbs []string
	// shortNames is a list of suggested short names of the resource.
	// +listType=set
	ShortNames []string
	// categories is a list of the grouped resources this resource belongs to (e.g. 'all').
	// Clients may use this to simplify acting on multiple resource types at once.
	// +listType=set
	Categories []string
	// subresources is a list of subresources provided by this resource. Subresources are located at /apis/<APIGroupDiscovery.objectMeta.name>/<APIVersionDiscovery.version>/<APIResourceDiscovery.Resource>/name-of-instance/<APIResourceDiscovery.subresources[i].subresource>
	// +listType=map
	// +listMapKey=subresource
	Subresources []APISubresourceDiscovery
}

APIResourceDiscovery provides information about an API resource for discovery.

func (*APIResourceDiscovery) DeepCopy

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

func (*APIResourceDiscovery) DeepCopyInto

func (in *APIResourceDiscovery) DeepCopyInto(out *APIResourceDiscovery)

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

type APISubresourceDiscovery

type APISubresourceDiscovery struct {
	// subresource is the name of the subresource.  This is used in the URL path and is the unique identifier
	// for this resource across all versions.
	Subresource string
	// responseKind describes the group, version, and kind of the serialization schema for the object type this endpoint typically returns.
	// Some subresources do not return normal resources, these will have null or empty return types.
	ResponseKind *v1.GroupVersionKind
	// acceptedTypes describes the kinds that this endpoint accepts.
	// Subresources may accept the standard content types or define
	// custom negotiation schemes. The list may not be exhaustive for
	// all operations.
	// +listType=map
	// +listMapKey=group
	// +listMapKey=version
	// +listMapKey=kind
	AcceptedTypes []v1.GroupVersionKind
	// verbs is a list of supported API operation types (this includes
	// but is not limited to get, list, watch, create, update, patch,
	// delete, deletecollection, and proxy). Subresources may define
	// custom verbs outside the standard Kubernetes verb set. Clients
	// should expect the behavior of standard verbs to align with
	// Kubernetes interaction conventions.
	// +listType=set
	Verbs []string
}

APISubresourceDiscovery provides information about an API subresource for discovery.

func (*APISubresourceDiscovery) DeepCopy

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

func (*APISubresourceDiscovery) DeepCopyInto

func (in *APISubresourceDiscovery) DeepCopyInto(out *APISubresourceDiscovery)

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

type APIVersionDiscovery

type APIVersionDiscovery struct {
	// version is the name of the version within a group version.
	Version string
	// resources is a list of APIResourceDiscovery objects for the corresponding group version.
	// +listType=map
	// +listMapKey=resource
	Resources []APIResourceDiscovery
	// freshness marks whether a group version's discovery document is up to date.
	// "Current" indicates the discovery document was recently
	// refreshed. "Stale" indicates the discovery document could not
	// be retrieved and the returned discovery document may be
	// significantly out of date. Clients that require the latest
	// version of the discovery information be retrieved before
	// performing an operation should not use the aggregated document
	// and instead retrieve the necessary version docs directly.
	Freshness DiscoveryFreshness
}

APIVersionDiscovery holds a list of APIResourceDiscovery types that are served for a particular version within an API Group.

func (*APIVersionDiscovery) DeepCopy

func (in *APIVersionDiscovery) DeepCopy() *APIVersionDiscovery

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

func (*APIVersionDiscovery) DeepCopyInto

func (in *APIVersionDiscovery) DeepCopyInto(out *APIVersionDiscovery)

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

type DiscoveryFreshness

type DiscoveryFreshness string

DiscoveryFreshness is an enum defining whether the Discovery document published by an apiservice is up to date (fresh).

const (
	DiscoveryFreshnessCurrent DiscoveryFreshness = "Current"
	DiscoveryFreshnessStale   DiscoveryFreshness = "Stale"
)

type ResourceScope

type ResourceScope string

ResourceScope is an enum defining the different scopes available to a resource.

const (
	ScopeCluster   ResourceScope = "Cluster"
	ScopeNamespace ResourceScope = "Namespaced"
)

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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