io.k8s.apiextensionsapiserver.pkg.apis.apiextensions.v1
CustomResourceDefinitionSpec
Companion object CustomResourceDefinitionSpec
case class CustomResourceDefinitionSpec(group: String, names: CustomResourceDefinitionNames, scope: String, versions: Seq[CustomResourceDefinitionVersion], conversion: Option[CustomResourceConversion] = None, preserveUnknownFields: Option[Boolean] = None) extends Product with Serializable
CustomResourceDefinitionSpec describes how a user wants their resource to appear
- group
group is the API group of the defined custom resource. The custom resources are served under
/apis/<group>/.... Must match the name of the CustomResourceDefinition (in the form<names.plural>.<group>).- names
names specify the resource and kind names for the custom resource.
- scope
scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are
ClusterandNamespaced.- versions
versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
- conversion
conversion defines conversion settings for the CRD.
- preserveUnknownFields
preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting
x-preserve-unknown-fieldsto true inspec.versions[*].schema.openAPIV3Schema. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
- Alphabetic
- By Inheritance
- CustomResourceDefinitionSpec
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CustomResourceDefinitionSpec(group: String, names: CustomResourceDefinitionNames, scope: String, versions: Seq[CustomResourceDefinitionVersion], conversion: Option[CustomResourceConversion] = None, preserveUnknownFields: Option[Boolean] = None)
- group
group is the API group of the defined custom resource. The custom resources are served under
/apis/<group>/.... Must match the name of the CustomResourceDefinition (in the form<names.plural>.<group>).- names
names specify the resource and kind names for the custom resource.
- scope
scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are
ClusterandNamespaced.- versions
versions is the list of all API versions of the defined custom resource. Version names are used to compute the order in which served versions are listed in API discovery. If the version string is "kube-like", it will sort above non "kube-like" version strings, which are ordered lexicographically. "Kube-like" versions start with a "v", then are followed by a number (the major version), then optionally the string "alpha" or "beta" and another number (the minor version). These are sorted first by GA > beta > alpha (where GA is a version with no suffix such as beta or alpha), and then by comparing major version, then minor version. An example sorted list of versions: v10, v2, v1, v11beta2, v10beta3, v3beta1, v12alpha1, v11alpha2, foo1, foo10.
- conversion
conversion defines conversion settings for the CRD.
- preserveUnknownFields
preserveUnknownFields indicates that object fields which are not specified in the OpenAPI schema should be preserved when persisting to storage. apiVersion, kind, metadata and known fields inside metadata are always preserved. This field is deprecated in favor of setting
x-preserve-unknown-fieldsto true inspec.versions[*].schema.openAPIV3Schema. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val conversion: Option[CustomResourceConversion]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val group: String
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val names: CustomResourceDefinitionNames
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val preserveUnknownFields: Option[Boolean]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val scope: String
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val versions: Seq[CustomResourceDefinitionVersion]
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated