Documentation

Overview

Package v1beta1 is the v1beta1 version of the API. +groupName=apiextensions.k8s.io

Package v1beta1 is a generated protocol buffer package.

It is generated from these files:
	k8s.io/kubernetes/vendor/k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1/generated.proto

It has these top-level messages:
	CustomResourceDefinition
	CustomResourceDefinitionCondition
	CustomResourceDefinitionList
	CustomResourceDefinitionNames
	CustomResourceDefinitionSpec
	CustomResourceDefinitionStatus

Index

Constants

View Source
const CustomResourceCleanupFinalizer = "customresourcecleanup.apiextensions.k8s.io"

CustomResourceCleanupFinalizer is the name of the finalizer which will delete instances of a CustomResourceDefinition

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

Variables

View Source
var (
	ErrInvalidLengthGenerated = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowGenerated   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes, addDefaultingFuncs)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: "v1beta1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Convert_apiextensions_CustomResourceDefinitionCondition_To_v1beta1_CustomResourceDefinitionCondition

func Convert_apiextensions_CustomResourceDefinitionCondition_To_v1beta1_CustomResourceDefinitionCondition(in *apiextensions.CustomResourceDefinitionCondition, out *CustomResourceDefinitionCondition, s conversion.Scope) error

Convert_apiextensions_CustomResourceDefinitionCondition_To_v1beta1_CustomResourceDefinitionCondition is an autogenerated conversion function.

func Convert_apiextensions_CustomResourceDefinitionList_To_v1beta1_CustomResourceDefinitionList

func Convert_apiextensions_CustomResourceDefinitionList_To_v1beta1_CustomResourceDefinitionList(in *apiextensions.CustomResourceDefinitionList, out *CustomResourceDefinitionList, s conversion.Scope) error

Convert_apiextensions_CustomResourceDefinitionList_To_v1beta1_CustomResourceDefinitionList is an autogenerated conversion function.

func Convert_apiextensions_CustomResourceDefinitionNames_To_v1beta1_CustomResourceDefinitionNames

func Convert_apiextensions_CustomResourceDefinitionNames_To_v1beta1_CustomResourceDefinitionNames(in *apiextensions.CustomResourceDefinitionNames, out *CustomResourceDefinitionNames, s conversion.Scope) error

Convert_apiextensions_CustomResourceDefinitionNames_To_v1beta1_CustomResourceDefinitionNames is an autogenerated conversion function.

func Convert_apiextensions_CustomResourceDefinitionSpec_To_v1beta1_CustomResourceDefinitionSpec

func Convert_apiextensions_CustomResourceDefinitionSpec_To_v1beta1_CustomResourceDefinitionSpec(in *apiextensions.CustomResourceDefinitionSpec, out *CustomResourceDefinitionSpec, s conversion.Scope) error

Convert_apiextensions_CustomResourceDefinitionSpec_To_v1beta1_CustomResourceDefinitionSpec is an autogenerated conversion function.

func Convert_apiextensions_CustomResourceDefinitionStatus_To_v1beta1_CustomResourceDefinitionStatus

func Convert_apiextensions_CustomResourceDefinitionStatus_To_v1beta1_CustomResourceDefinitionStatus(in *apiextensions.CustomResourceDefinitionStatus, out *CustomResourceDefinitionStatus, s conversion.Scope) error

Convert_apiextensions_CustomResourceDefinitionStatus_To_v1beta1_CustomResourceDefinitionStatus is an autogenerated conversion function.

func Convert_apiextensions_CustomResourceDefinition_To_v1beta1_CustomResourceDefinition

func Convert_apiextensions_CustomResourceDefinition_To_v1beta1_CustomResourceDefinition(in *apiextensions.CustomResourceDefinition, out *CustomResourceDefinition, s conversion.Scope) error

Convert_apiextensions_CustomResourceDefinition_To_v1beta1_CustomResourceDefinition is an autogenerated conversion function.

func Convert_v1beta1_CustomResourceDefinitionCondition_To_apiextensions_CustomResourceDefinitionCondition

func Convert_v1beta1_CustomResourceDefinitionCondition_To_apiextensions_CustomResourceDefinitionCondition(in *CustomResourceDefinitionCondition, out *apiextensions.CustomResourceDefinitionCondition, s conversion.Scope) error

Convert_v1beta1_CustomResourceDefinitionCondition_To_apiextensions_CustomResourceDefinitionCondition is an autogenerated conversion function.

func Convert_v1beta1_CustomResourceDefinitionList_To_apiextensions_CustomResourceDefinitionList

func Convert_v1beta1_CustomResourceDefinitionList_To_apiextensions_CustomResourceDefinitionList(in *CustomResourceDefinitionList, out *apiextensions.CustomResourceDefinitionList, s conversion.Scope) error

Convert_v1beta1_CustomResourceDefinitionList_To_apiextensions_CustomResourceDefinitionList is an autogenerated conversion function.

func Convert_v1beta1_CustomResourceDefinitionNames_To_apiextensions_CustomResourceDefinitionNames

func Convert_v1beta1_CustomResourceDefinitionNames_To_apiextensions_CustomResourceDefinitionNames(in *CustomResourceDefinitionNames, out *apiextensions.CustomResourceDefinitionNames, s conversion.Scope) error

Convert_v1beta1_CustomResourceDefinitionNames_To_apiextensions_CustomResourceDefinitionNames is an autogenerated conversion function.

func Convert_v1beta1_CustomResourceDefinitionSpec_To_apiextensions_CustomResourceDefinitionSpec

func Convert_v1beta1_CustomResourceDefinitionSpec_To_apiextensions_CustomResourceDefinitionSpec(in *CustomResourceDefinitionSpec, out *apiextensions.CustomResourceDefinitionSpec, s conversion.Scope) error

Convert_v1beta1_CustomResourceDefinitionSpec_To_apiextensions_CustomResourceDefinitionSpec is an autogenerated conversion function.

func Convert_v1beta1_CustomResourceDefinitionStatus_To_apiextensions_CustomResourceDefinitionStatus

func Convert_v1beta1_CustomResourceDefinitionStatus_To_apiextensions_CustomResourceDefinitionStatus(in *CustomResourceDefinitionStatus, out *apiextensions.CustomResourceDefinitionStatus, s conversion.Scope) error

Convert_v1beta1_CustomResourceDefinitionStatus_To_apiextensions_CustomResourceDefinitionStatus is an autogenerated conversion function.

func Convert_v1beta1_CustomResourceDefinition_To_apiextensions_CustomResourceDefinition

func Convert_v1beta1_CustomResourceDefinition_To_apiextensions_CustomResourceDefinition(in *CustomResourceDefinition, out *apiextensions.CustomResourceDefinition, s conversion.Scope) error

Convert_v1beta1_CustomResourceDefinition_To_apiextensions_CustomResourceDefinition is an autogenerated conversion function.

func DeepCopy_v1beta1_CustomResourceDefinition

func DeepCopy_v1beta1_CustomResourceDefinition(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_v1beta1_CustomResourceDefinition is an autogenerated deepcopy function.

func DeepCopy_v1beta1_CustomResourceDefinitionCondition

func DeepCopy_v1beta1_CustomResourceDefinitionCondition(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_v1beta1_CustomResourceDefinitionCondition is an autogenerated deepcopy function.

func DeepCopy_v1beta1_CustomResourceDefinitionList

func DeepCopy_v1beta1_CustomResourceDefinitionList(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_v1beta1_CustomResourceDefinitionList is an autogenerated deepcopy function.

func DeepCopy_v1beta1_CustomResourceDefinitionNames

func DeepCopy_v1beta1_CustomResourceDefinitionNames(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_v1beta1_CustomResourceDefinitionNames is an autogenerated deepcopy function.

func DeepCopy_v1beta1_CustomResourceDefinitionSpec

func DeepCopy_v1beta1_CustomResourceDefinitionSpec(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_v1beta1_CustomResourceDefinitionSpec is an autogenerated deepcopy function.

func DeepCopy_v1beta1_CustomResourceDefinitionStatus

func DeepCopy_v1beta1_CustomResourceDefinitionStatus(in interface{}, out interface{}, c *conversion.Cloner) error

DeepCopy_v1beta1_CustomResourceDefinitionStatus is an autogenerated deepcopy function.

func Kind

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func RegisterConversions

func RegisterConversions(scheme *runtime.Scheme) error

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

func RegisterDeepCopies

func RegisterDeepCopies(scheme *runtime.Scheme) error

RegisterDeepCopies adds deep-copy functions to the given scheme. Public to allow building arbitrary schemes.

func RegisterDefaults

func RegisterDefaults(scheme *runtime.Scheme) error

RegisterDefaults adds defaulters functions to the given scheme. Public to allow building arbitrary schemes. All generated defaulters are covering - they call all nested defaulters.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns back a Group qualified GroupResource

func SetDefaults_CustomResourceDefinition

func SetDefaults_CustomResourceDefinition(obj *CustomResourceDefinition)

func SetDefaults_CustomResourceDefinitionSpec

func SetDefaults_CustomResourceDefinitionSpec(obj *CustomResourceDefinitionSpec)

func SetObjectDefaults_CustomResourceDefinition

func SetObjectDefaults_CustomResourceDefinition(in *CustomResourceDefinition)

func SetObjectDefaults_CustomResourceDefinitionList

func SetObjectDefaults_CustomResourceDefinitionList(in *CustomResourceDefinitionList)

Types

type ConditionStatus

type ConditionStatus string
const (
	ConditionTrue    ConditionStatus = "True"
	ConditionFalse   ConditionStatus = "False"
	ConditionUnknown ConditionStatus = "Unknown"
)

These are valid condition statuses. "ConditionTrue" means a resource is in the condition. "ConditionFalse" means a resource is not in the condition. "ConditionUnknown" means kubernetes can't decide if a resource is in the condition or not. In the future, we could add other intermediate conditions, e.g. ConditionDegraded.

type CustomResourceDefinition

type CustomResourceDefinition struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Spec describes how the user wants the resources to appear
	Spec CustomResourceDefinitionSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
	// Status indicates the actual state of the CustomResourceDefinition
	Status CustomResourceDefinitionStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}

CustomResourceDefinition represents a resource that should be exposed on the API server. Its name MUST be in the format <.spec.name>.<.spec.group>.

func (*CustomResourceDefinition) Descriptor

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

func (*CustomResourceDefinition) Marshal

func (m *CustomResourceDefinition) Marshal() (dAtA []byte, err error)

func (*CustomResourceDefinition) MarshalTo

func (m *CustomResourceDefinition) MarshalTo(dAtA []byte) (int, error)

func (*CustomResourceDefinition) ProtoMessage

func (*CustomResourceDefinition) ProtoMessage()

func (*CustomResourceDefinition) Reset

func (m *CustomResourceDefinition) Reset()

func (*CustomResourceDefinition) Size

func (m *CustomResourceDefinition) Size() (n int)

func (*CustomResourceDefinition) String

func (this *CustomResourceDefinition) String() string

func (*CustomResourceDefinition) Unmarshal

func (m *CustomResourceDefinition) Unmarshal(dAtA []byte) error

type CustomResourceDefinitionCondition

type CustomResourceDefinitionCondition struct {
	// Type is the type of the condition.
	Type CustomResourceDefinitionConditionType `json:"type" protobuf:"bytes,1,opt,name=type,casttype=CustomResourceDefinitionConditionType"`
	// Status is the status of the condition.
	// Can be True, False, Unknown.
	Status ConditionStatus `json:"status" protobuf:"bytes,2,opt,name=status,casttype=ConditionStatus"`
	// Last time the condition transitioned from one status to another.
	// +optional
	LastTransitionTime metav1.Time `json:"lastTransitionTime,omitempty" protobuf:"bytes,3,opt,name=lastTransitionTime"`
	// Unique, one-word, CamelCase reason for the condition's last transition.
	// +optional
	Reason string `json:"reason,omitempty" protobuf:"bytes,4,opt,name=reason"`
	// Human-readable message indicating details about last transition.
	// +optional
	Message string `json:"message,omitempty" protobuf:"bytes,5,opt,name=message"`
}

CustomResourceDefinitionCondition contains details for the current condition of this pod.

func (*CustomResourceDefinitionCondition) Descriptor

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

func (*CustomResourceDefinitionCondition) Marshal

func (m *CustomResourceDefinitionCondition) Marshal() (dAtA []byte, err error)

func (*CustomResourceDefinitionCondition) MarshalTo

func (m *CustomResourceDefinitionCondition) MarshalTo(dAtA []byte) (int, error)

func (*CustomResourceDefinitionCondition) ProtoMessage

func (*CustomResourceDefinitionCondition) ProtoMessage()

func (*CustomResourceDefinitionCondition) Reset

func (*CustomResourceDefinitionCondition) Size

func (m *CustomResourceDefinitionCondition) Size() (n int)

func (*CustomResourceDefinitionCondition) String

func (*CustomResourceDefinitionCondition) Unmarshal

func (m *CustomResourceDefinitionCondition) Unmarshal(dAtA []byte) error

type CustomResourceDefinitionConditionType

type CustomResourceDefinitionConditionType string

CustomResourceDefinitionConditionType is a valid value for CustomResourceDefinitionCondition.Type

const (
	// Established means that the resource has become active. A resource is established when all names are
	// accepted without a conflict for the first time. A resource stays established until deleted, even during
	// a later NamesAccepted due to changed names. Note that not all names can be changed.
	Established CustomResourceDefinitionConditionType = "Established"
	// NamesAccepted means the names chosen for this CustomResourceDefinition do not conflict with others in
	// the group and are therefore accepted.
	NamesAccepted CustomResourceDefinitionConditionType = "NamesAccepted"
	// Terminating means that the CustomResourceDefinition has been deleted and is cleaning up.
	Terminating CustomResourceDefinitionConditionType = "Terminating"
)

type CustomResourceDefinitionList

type CustomResourceDefinitionList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Items individual CustomResourceDefinitions
	Items []CustomResourceDefinition `json:"items" protobuf:"bytes,2,rep,name=items"`
}

CustomResourceDefinitionList is a list of CustomResourceDefinition objects.

func (*CustomResourceDefinitionList) Descriptor

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

func (*CustomResourceDefinitionList) Marshal

func (m *CustomResourceDefinitionList) Marshal() (dAtA []byte, err error)

func (*CustomResourceDefinitionList) MarshalTo

func (m *CustomResourceDefinitionList) MarshalTo(dAtA []byte) (int, error)

func (*CustomResourceDefinitionList) ProtoMessage

func (*CustomResourceDefinitionList) ProtoMessage()

func (*CustomResourceDefinitionList) Reset

func (m *CustomResourceDefinitionList) Reset()

func (*CustomResourceDefinitionList) Size

func (m *CustomResourceDefinitionList) Size() (n int)

func (*CustomResourceDefinitionList) String

func (this *CustomResourceDefinitionList) String() string

func (*CustomResourceDefinitionList) Unmarshal

func (m *CustomResourceDefinitionList) Unmarshal(dAtA []byte) error

type CustomResourceDefinitionNames

type CustomResourceDefinitionNames struct {
	// Plural is the plural name of the resource to serve.  It must match the name of the CustomResourceDefinition-registration
	// too: plural.group and it must be all lowercase.
	Plural string `json:"plural" protobuf:"bytes,1,opt,name=plural"`
	// Singular is the singular name of the resource.  It must be all lowercase  Defaults to lowercased <kind>
	Singular string `json:"singular,omitempty" protobuf:"bytes,2,opt,name=singular"`
	// ShortNames are short names for the resource.  It must be all lowercase.
	ShortNames []string `json:"shortNames,omitempty" protobuf:"bytes,3,opt,name=shortNames"`
	// Kind is the serialized kind of the resource.  It is normally CamelCase and singular.
	Kind string `json:"kind" protobuf:"bytes,4,opt,name=kind"`
	// ListKind is the serialized kind of the list for this resource.  Defaults to <kind>List.
	ListKind string `json:"listKind,omitempty" protobuf:"bytes,5,opt,name=listKind"`
}

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

func (*CustomResourceDefinitionNames) Descriptor

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

func (*CustomResourceDefinitionNames) Marshal

func (m *CustomResourceDefinitionNames) Marshal() (dAtA []byte, err error)

func (*CustomResourceDefinitionNames) MarshalTo

func (m *CustomResourceDefinitionNames) MarshalTo(dAtA []byte) (int, error)

func (*CustomResourceDefinitionNames) ProtoMessage

func (*CustomResourceDefinitionNames) ProtoMessage()

func (*CustomResourceDefinitionNames) Reset

func (m *CustomResourceDefinitionNames) Reset()

func (*CustomResourceDefinitionNames) Size

func (m *CustomResourceDefinitionNames) Size() (n int)

func (*CustomResourceDefinitionNames) String

func (this *CustomResourceDefinitionNames) String() string

func (*CustomResourceDefinitionNames) Unmarshal

func (m *CustomResourceDefinitionNames) Unmarshal(dAtA []byte) error

type CustomResourceDefinitionSpec

type CustomResourceDefinitionSpec struct {
	// Group is the group this resource belongs in
	Group string `json:"group" protobuf:"bytes,1,opt,name=group"`
	// Version is the version this resource belongs in
	Version string `json:"version" protobuf:"bytes,2,opt,name=version"`
	// Names are the names used to describe this custom resource
	Names CustomResourceDefinitionNames `json:"names" protobuf:"bytes,3,opt,name=names"`

	// Scope indicates whether this resource is cluster or namespace scoped.  Default is namespaced
	Scope ResourceScope `json:"scope" protobuf:"bytes,4,opt,name=scope,casttype=ResourceScope"`
}

CustomResourceDefinitionSpec describes how a user wants their resource to appear

func (*CustomResourceDefinitionSpec) Descriptor

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

func (*CustomResourceDefinitionSpec) Marshal

func (m *CustomResourceDefinitionSpec) Marshal() (dAtA []byte, err error)

func (*CustomResourceDefinitionSpec) MarshalTo

func (m *CustomResourceDefinitionSpec) MarshalTo(dAtA []byte) (int, error)

func (*CustomResourceDefinitionSpec) ProtoMessage

func (*CustomResourceDefinitionSpec) ProtoMessage()

func (*CustomResourceDefinitionSpec) Reset

func (m *CustomResourceDefinitionSpec) Reset()

func (*CustomResourceDefinitionSpec) Size

func (m *CustomResourceDefinitionSpec) Size() (n int)

func (*CustomResourceDefinitionSpec) String

func (this *CustomResourceDefinitionSpec) String() string

func (*CustomResourceDefinitionSpec) Unmarshal

func (m *CustomResourceDefinitionSpec) Unmarshal(dAtA []byte) error

type CustomResourceDefinitionStatus

type CustomResourceDefinitionStatus struct {
	// Conditions indicate state for particular aspects of a CustomResourceDefinition
	Conditions []CustomResourceDefinitionCondition `json:"conditions" protobuf:"bytes,1,opt,name=conditions"`

	// AcceptedNames are the names that are actually being used to serve discovery
	// They may be different than the names in spec.
	AcceptedNames CustomResourceDefinitionNames `json:"acceptedNames" protobuf:"bytes,2,opt,name=acceptedNames"`
}

CustomResourceDefinitionStatus indicates the state of the CustomResourceDefinition

func (*CustomResourceDefinitionStatus) Descriptor

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

func (*CustomResourceDefinitionStatus) Marshal

func (m *CustomResourceDefinitionStatus) Marshal() (dAtA []byte, err error)

func (*CustomResourceDefinitionStatus) MarshalTo

func (m *CustomResourceDefinitionStatus) MarshalTo(dAtA []byte) (int, error)

func (*CustomResourceDefinitionStatus) ProtoMessage

func (*CustomResourceDefinitionStatus) ProtoMessage()

func (*CustomResourceDefinitionStatus) Reset

func (m *CustomResourceDefinitionStatus) Reset()

func (*CustomResourceDefinitionStatus) Size

func (m *CustomResourceDefinitionStatus) Size() (n int)

func (*CustomResourceDefinitionStatus) String

func (this *CustomResourceDefinitionStatus) String() string

func (*CustomResourceDefinitionStatus) Unmarshal

func (m *CustomResourceDefinitionStatus) Unmarshal(dAtA []byte) error

type ResourceScope

type ResourceScope string

ResourceScope is an enum defining the different scopes availabe to a custom resource

const (
	ClusterScoped   ResourceScope = "Cluster"
	NamespaceScoped ResourceScope = "Namespaced"
)