GroupName is the group name for this API.
const GroupName = "apidiscovery.k8s.io"
var (
ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
ErrIntOverflowGenerated = fmt.Errorf("proto: integer overflow")
ErrUnexpectedEndOfGroupGenerated = fmt.Errorf("proto: unexpected end of group")
)
var (
// SchemeBuilder installs the api group to a scheme
SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
// AddToScheme adds api to a scheme
AddToScheme = SchemeBuilder.AddToScheme
)
SchemeGroupVersion is group version used to register these objects
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v2"}
func Kind(kind string) schema.GroupKind
Kind takes an unqualified kind and returns a Group qualified GroupKind
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource
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.
type APIGroupDiscovery struct {
v1.TypeMeta `json:",inline"`
// 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 `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// 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 `json:"versions,omitempty" protobuf:"bytes,2,rep,name=versions"`
}
func (in *APIGroupDiscovery) DeepCopy() *APIGroupDiscovery
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIGroupDiscovery.
func (in *APIGroupDiscovery) DeepCopyInto(out *APIGroupDiscovery)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *APIGroupDiscovery) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*APIGroupDiscovery) Descriptor() ([]byte, []int)
func (m *APIGroupDiscovery) Marshal() (dAtA []byte, err error)
func (m *APIGroupDiscovery) MarshalTo(dAtA []byte) (int, error)
func (m *APIGroupDiscovery) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*APIGroupDiscovery) ProtoMessage()
func (m *APIGroupDiscovery) Reset()
func (m *APIGroupDiscovery) Size() (n int)
func (this *APIGroupDiscovery) String() string
func (m *APIGroupDiscovery) Unmarshal(dAtA []byte) error
func (m *APIGroupDiscovery) XXX_DiscardUnknown()
func (m *APIGroupDiscovery) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *APIGroupDiscovery) XXX_Merge(src proto.Message)
func (m *APIGroupDiscovery) XXX_Size() int
func (m *APIGroupDiscovery) XXX_Unmarshal(b []byte) error
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.
type APIGroupDiscoveryList struct {
v1.TypeMeta `json:",inline"`
// 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 `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// items is the list of groups for discovery. The groups are listed in priority order.
Items []APIGroupDiscovery `json:"items" protobuf:"bytes,2,rep,name=items"`
}
func (in *APIGroupDiscoveryList) DeepCopy() *APIGroupDiscoveryList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIGroupDiscoveryList.
func (in *APIGroupDiscoveryList) DeepCopyInto(out *APIGroupDiscoveryList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (in *APIGroupDiscoveryList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*APIGroupDiscoveryList) Descriptor() ([]byte, []int)
func (m *APIGroupDiscoveryList) Marshal() (dAtA []byte, err error)
func (m *APIGroupDiscoveryList) MarshalTo(dAtA []byte) (int, error)
func (m *APIGroupDiscoveryList) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*APIGroupDiscoveryList) ProtoMessage()
func (m *APIGroupDiscoveryList) Reset()
func (m *APIGroupDiscoveryList) Size() (n int)
func (this *APIGroupDiscoveryList) String() string
func (m *APIGroupDiscoveryList) Unmarshal(dAtA []byte) error
func (m *APIGroupDiscoveryList) XXX_DiscardUnknown()
func (m *APIGroupDiscoveryList) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *APIGroupDiscoveryList) XXX_Merge(src proto.Message)
func (m *APIGroupDiscoveryList) XXX_Size() int
func (m *APIGroupDiscoveryList) XXX_Unmarshal(b []byte) error
APIResourceDiscovery provides information about an API resource for discovery.
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 `json:"resource" protobuf:"bytes,1,opt,name=resource"`
// 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 `json:"responseKind,omitempty" protobuf:"bytes,2,opt,name=responseKind"`
// scope indicates the scope of a resource, either Cluster or Namespaced
Scope ResourceScope `json:"scope" protobuf:"bytes,3,opt,name=scope"`
// 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 `json:"singularResource" protobuf:"bytes,4,opt,name=singularResource"`
// 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 `json:"verbs" protobuf:"bytes,5,opt,name=verbs"`
// shortNames is a list of suggested short names of the resource.
// +listType=set
ShortNames []string `json:"shortNames,omitempty" protobuf:"bytes,6,rep,name=shortNames"`
// 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 `json:"categories,omitempty" protobuf:"bytes,7,rep,name=categories"`
// 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 `json:"subresources,omitempty" protobuf:"bytes,8,rep,name=subresources"`
}
func (in *APIResourceDiscovery) DeepCopy() *APIResourceDiscovery
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIResourceDiscovery.
func (in *APIResourceDiscovery) DeepCopyInto(out *APIResourceDiscovery)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*APIResourceDiscovery) Descriptor() ([]byte, []int)
func (m *APIResourceDiscovery) Marshal() (dAtA []byte, err error)
func (m *APIResourceDiscovery) MarshalTo(dAtA []byte) (int, error)
func (m *APIResourceDiscovery) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*APIResourceDiscovery) ProtoMessage()
func (m *APIResourceDiscovery) Reset()
func (m *APIResourceDiscovery) Size() (n int)
func (this *APIResourceDiscovery) String() string
func (m *APIResourceDiscovery) Unmarshal(dAtA []byte) error
func (m *APIResourceDiscovery) XXX_DiscardUnknown()
func (m *APIResourceDiscovery) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *APIResourceDiscovery) XXX_Merge(src proto.Message)
func (m *APIResourceDiscovery) XXX_Size() int
func (m *APIResourceDiscovery) XXX_Unmarshal(b []byte) error
APISubresourceDiscovery provides information about an API subresource for discovery.
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 `json:"subresource" protobuf:"bytes,1,opt,name=subresource"`
// 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 `json:"responseKind,omitempty" protobuf:"bytes,2,opt,name=responseKind"`
// 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 `json:"acceptedTypes,omitempty" protobuf:"bytes,3,rep,name=acceptedTypes"`
// 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 `json:"verbs" protobuf:"bytes,4,opt,name=verbs"`
}
func (in *APISubresourceDiscovery) DeepCopy() *APISubresourceDiscovery
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APISubresourceDiscovery.
func (in *APISubresourceDiscovery) DeepCopyInto(out *APISubresourceDiscovery)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*APISubresourceDiscovery) Descriptor() ([]byte, []int)
func (m *APISubresourceDiscovery) Marshal() (dAtA []byte, err error)
func (m *APISubresourceDiscovery) MarshalTo(dAtA []byte) (int, error)
func (m *APISubresourceDiscovery) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*APISubresourceDiscovery) ProtoMessage()
func (m *APISubresourceDiscovery) Reset()
func (m *APISubresourceDiscovery) Size() (n int)
func (this *APISubresourceDiscovery) String() string
func (m *APISubresourceDiscovery) Unmarshal(dAtA []byte) error
func (m *APISubresourceDiscovery) XXX_DiscardUnknown()
func (m *APISubresourceDiscovery) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *APISubresourceDiscovery) XXX_Merge(src proto.Message)
func (m *APISubresourceDiscovery) XXX_Size() int
func (m *APISubresourceDiscovery) XXX_Unmarshal(b []byte) error
APIVersionDiscovery holds a list of APIResourceDiscovery types that are served for a particular version within an API Group.
type APIVersionDiscovery struct {
// version is the name of the version within a group version.
Version string `json:"version" protobuf:"bytes,1,opt,name=version"`
// resources is a list of APIResourceDiscovery objects for the corresponding group version.
// +listType=map
// +listMapKey=resource
Resources []APIResourceDiscovery `json:"resources,omitempty" protobuf:"bytes,2,rep,name=resources"`
// 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
Freshness DiscoveryFreshness `json:"freshness,omitempty" protobuf:"bytes,3,opt,name=freshness"`
}
func (in *APIVersionDiscovery) DeepCopy() *APIVersionDiscovery
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new APIVersionDiscovery.
func (in *APIVersionDiscovery) DeepCopyInto(out *APIVersionDiscovery)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*APIVersionDiscovery) Descriptor() ([]byte, []int)
func (m *APIVersionDiscovery) Marshal() (dAtA []byte, err error)
func (m *APIVersionDiscovery) MarshalTo(dAtA []byte) (int, error)
func (m *APIVersionDiscovery) MarshalToSizedBuffer(dAtA []byte) (int, error)
func (*APIVersionDiscovery) ProtoMessage()
func (m *APIVersionDiscovery) Reset()
func (m *APIVersionDiscovery) Size() (n int)
func (this *APIVersionDiscovery) String() string
func (m *APIVersionDiscovery) Unmarshal(dAtA []byte) error
func (m *APIVersionDiscovery) XXX_DiscardUnknown()
func (m *APIVersionDiscovery) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (m *APIVersionDiscovery) XXX_Merge(src proto.Message)
func (m *APIVersionDiscovery) XXX_Size() int
func (m *APIVersionDiscovery) XXX_Unmarshal(b []byte) error
DiscoveryFreshness is an enum defining whether the Discovery document published by an apiservice is up to date (fresh).
type DiscoveryFreshness string
const (
DiscoveryFreshnessCurrent DiscoveryFreshness = "Current"
DiscoveryFreshnessStale DiscoveryFreshness = "Stale"
)
ResourceScope is an enum defining the different scopes available to a resource.
type ResourceScope string
const (
ScopeCluster ResourceScope = "Cluster"
ScopeNamespace ResourceScope = "Namespaced"
)