Class CustomResourceDefinitionSpec
- java.lang.Object
-
- io.fabric8.kubernetes.api.model.apiextensions.v1beta1.CustomResourceDefinitionSpec
-
- All Implemented Interfaces:
io.fabric8.kubernetes.api.builder.Editable<CustomResourceDefinitionSpecBuilder>,io.fabric8.kubernetes.api.model.KubernetesResource,Serializable
@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator") public class CustomResourceDefinitionSpec extends Object implements io.fabric8.kubernetes.api.builder.Editable<CustomResourceDefinitionSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
CustomResourceDefinitionSpec describes how a user wants their resource to appear- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CustomResourceDefinitionSpec()No args constructor for use in serializationCustomResourceDefinitionSpec(List<CustomResourceColumnDefinition> additionalPrinterColumns, CustomResourceConversion conversion, String group, CustomResourceDefinitionNames names, Boolean preserveUnknownFields, String scope, CustomResourceSubresources subresources, CustomResourceValidation validation, String version, List<CustomResourceDefinitionVersion> versions)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CustomResourceDefinitionSpecBuilderedit()List<CustomResourceColumnDefinition>getAdditionalPrinterColumns()additionalPrinterColumns specifies additional columns returned in Table output.Map<String,Object>getAdditionalProperties()CustomResourceConversiongetConversion()CustomResourceDefinitionSpec describes how a user wants their resource to appearStringgetGroup()group is the API group of the defined custom resource.CustomResourceDefinitionNamesgetNames()CustomResourceDefinitionSpec describes how a user wants their resource to appearBooleangetPreserveUnknownFields()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.StringgetScope()scope indicates whether the defined custom resource is cluster- or namespace-scoped.CustomResourceSubresourcesgetSubresources()CustomResourceDefinitionSpec describes how a user wants their resource to appearCustomResourceValidationgetValidation()CustomResourceDefinitionSpec describes how a user wants their resource to appearStringgetVersion()version is the API version of the defined custom resource.List<CustomResourceDefinitionVersion>getVersions()versions is the list of all API versions of the defined custom resource.voidsetAdditionalPrinterColumns(List<CustomResourceColumnDefinition> additionalPrinterColumns)additionalPrinterColumns specifies additional columns returned in Table output.voidsetAdditionalProperties(Map<String,Object> additionalProperties)voidsetAdditionalProperty(String name, Object value)voidsetConversion(CustomResourceConversion conversion)CustomResourceDefinitionSpec describes how a user wants their resource to appearvoidsetGroup(String group)group is the API group of the defined custom resource.voidsetNames(CustomResourceDefinitionNames names)CustomResourceDefinitionSpec describes how a user wants their resource to appearvoidsetPreserveUnknownFields(Boolean 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.voidsetScope(String scope)scope indicates whether the defined custom resource is cluster- or namespace-scoped.voidsetSubresources(CustomResourceSubresources subresources)CustomResourceDefinitionSpec describes how a user wants their resource to appearvoidsetValidation(CustomResourceValidation validation)CustomResourceDefinitionSpec describes how a user wants their resource to appearvoidsetVersion(String version)version is the API version of the defined custom resource.voidsetVersions(List<CustomResourceDefinitionVersion> versions)versions is the list of all API versions of the defined custom resource.CustomResourceDefinitionSpecBuildertoBuilder()
-
-
-
Constructor Detail
-
CustomResourceDefinitionSpec
public CustomResourceDefinitionSpec()
No args constructor for use in serialization
-
CustomResourceDefinitionSpec
public CustomResourceDefinitionSpec(List<CustomResourceColumnDefinition> additionalPrinterColumns, CustomResourceConversion conversion, String group, CustomResourceDefinitionNames names, Boolean preserveUnknownFields, String scope, CustomResourceSubresources subresources, CustomResourceValidation validation, String version, List<CustomResourceDefinitionVersion> versions)
-
-
Method Detail
-
getAdditionalPrinterColumns
public List<CustomResourceColumnDefinition> getAdditionalPrinterColumns()
additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If present, this field configures columns for all versions. Top-level and per-version columns are mutually exclusive. If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used.
-
setAdditionalPrinterColumns
public void setAdditionalPrinterColumns(List<CustomResourceColumnDefinition> additionalPrinterColumns)
additionalPrinterColumns specifies additional columns returned in Table output. See https://kubernetes.io/docs/reference/using-api/api-concepts/#receiving-resources-as-tables for details. If present, this field configures columns for all versions. Top-level and per-version columns are mutually exclusive. If no top-level or per-version columns are specified, a single column displaying the age of the custom resource is used.
-
getConversion
public CustomResourceConversion getConversion()
CustomResourceDefinitionSpec describes how a user wants their resource to appear
-
setConversion
public void setConversion(CustomResourceConversion conversion)
CustomResourceDefinitionSpec describes how a user wants their resource to appear
-
getGroup
public String getGroup()
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>`).
-
setGroup
public void setGroup(String 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>`).
-
getNames
public CustomResourceDefinitionNames getNames()
CustomResourceDefinitionSpec describes how a user wants their resource to appear
-
setNames
public void setNames(CustomResourceDefinitionNames names)
CustomResourceDefinitionSpec describes how a user wants their resource to appear
-
getPreserveUnknownFields
public Boolean getPreserveUnknownFields()
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. If false, schemas must be defined for all versions. Defaults to true in v1beta for backwards compatibility. Deprecated: will be required to be false in v1. Preservation of unknown fields can be specified in the validation schema using the `x-kubernetes-preserve-unknown-fields: true` extension. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
-
setPreserveUnknownFields
public void setPreserveUnknownFields(Boolean 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. If false, schemas must be defined for all versions. Defaults to true in v1beta for backwards compatibility. Deprecated: will be required to be false in v1. Preservation of unknown fields can be specified in the validation schema using the `x-kubernetes-preserve-unknown-fields: true` extension. See https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#pruning-versus-preserving-unknown-fields for details.
-
getScope
public String getScope()
scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`. Default is `Namespaced`.
-
setScope
public void setScope(String scope)
scope indicates whether the defined custom resource is cluster- or namespace-scoped. Allowed values are `Cluster` and `Namespaced`. Default is `Namespaced`.
-
getSubresources
public CustomResourceSubresources getSubresources()
CustomResourceDefinitionSpec describes how a user wants their resource to appear
-
setSubresources
public void setSubresources(CustomResourceSubresources subresources)
CustomResourceDefinitionSpec describes how a user wants their resource to appear
-
getValidation
public CustomResourceValidation getValidation()
CustomResourceDefinitionSpec describes how a user wants their resource to appear
-
setValidation
public void setValidation(CustomResourceValidation validation)
CustomResourceDefinitionSpec describes how a user wants their resource to appear
-
getVersion
public String getVersion()
version is the API version of the defined custom resource. The custom resources are served under `/apis/<group>/<version>/...`. Must match the name of the first item in the `versions` list if `version` and `versions` are both specified. Optional if `versions` is specified. Deprecated: use `versions` instead.
-
setVersion
public void setVersion(String version)
version is the API version of the defined custom resource. The custom resources are served under `/apis/<group>/<version>/...`. Must match the name of the first item in the `versions` list if `version` and `versions` are both specified. Optional if `versions` is specified. Deprecated: use `versions` instead.
-
getVersions
public List<CustomResourceDefinitionVersion> getVersions()
versions is the list of all API versions of the defined custom resource. Optional if `version` is specified. The name of the first item in the `versions` list must match the `version` field if `version` and `versions` are both specified. 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.
-
setVersions
public void setVersions(List<CustomResourceDefinitionVersion> versions)
versions is the list of all API versions of the defined custom resource. Optional if `version` is specified. The name of the first item in the `versions` list must match the `version` field if `version` and `versions` are both specified. 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.
-
edit
public CustomResourceDefinitionSpecBuilder edit()
- Specified by:
editin interfaceio.fabric8.kubernetes.api.builder.Editable<CustomResourceDefinitionSpecBuilder>
-
toBuilder
public CustomResourceDefinitionSpecBuilder toBuilder()
-
-