CustomResourceDefinitionNames

case class CustomResourceDefinitionNames(categories: Optional[Vector[String]], kind: String, listKind: Optional[String], plural: String, shortNames: Optional[Vector[String]], singular: Optional[String])

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

CustomResourceDefinitionNames indicates the names to serve this CustomResourceDefinition

Value Params
categories

categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like kubectl get all.

kind

kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the kind attribute in API calls.

listKind

listKind is the serialized kind of the list for this resource. Defaults to "kindList".

plural

plural is the plural name of the resource to serve. The custom resources are served under /apis/<group>/<version>/.../<plural>. Must match the name of the CustomResourceDefinition (in the form <names.plural>.<group>). Must be all lowercase.

shortNames

shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like kubectl get <shortname>. It must be all lowercase.

singular

singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.

Companion
object
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def getCategories: IO[K8sFailure, Vector[String]]

categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like kubectl get all.

categories is a list of grouped resources this custom resource belongs to (e.g. 'all'). This is published in API discovery documents, and used by clients to support invocations like kubectl get all.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getKind: IO[K8sFailure, String]

kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the kind attribute in API calls.

kind is the serialized kind of the resource. It is normally CamelCase and singular. Custom resource instances will use this value as the kind attribute in API calls.

This effect always succeeds, it is safe to use the field kind directly.

def getListKind: IO[K8sFailure, String]

listKind is the serialized kind of the list for this resource. Defaults to "kindList".

listKind is the serialized kind of the list for this resource. Defaults to "kindList".

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getPlural: IO[K8sFailure, String]

plural is the plural name of the resource to serve. The custom resources are served under /apis/<group>/<version>/.../<plural>. Must match the name of the CustomResourceDefinition (in the form <names.plural>.<group>). Must be all lowercase.

plural is the plural name of the resource to serve. The custom resources are served under /apis/<group>/<version>/.../<plural>. Must match the name of the CustomResourceDefinition (in the form <names.plural>.<group>). Must be all lowercase.

This effect always succeeds, it is safe to use the field plural directly.

def getShortNames: IO[K8sFailure, Vector[String]]

shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like kubectl get <shortname>. It must be all lowercase.

shortNames are short names for the resource, exposed in API discovery documents, and used by clients to support invocations like kubectl get <shortname>. It must be all lowercase.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

def getSingular: IO[K8sFailure, String]

singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.

singular is the singular name of the resource. It must be all lowercase. Defaults to lowercased kind.

If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.

Inherited methods

def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product