APIResource

case class APIResource(categories: Optional[Vector[String]], group: Optional[String], kind: String, name: String, namespaced: Boolean, shortNames: Optional[Vector[String]], singularName: String, storageVersionHash: Optional[String], verbs: Vector[String], version: Optional[String])

APIResource specifies the name of a resource and whether it is namespaced.

APIResource specifies the name of a resource and whether it is namespaced.

Value Params
categories

categories is a list of the grouped resources this resource belongs to (e.g. 'all')

group

group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".

kind

kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')

name

name is the plural name of the resource.

namespaced

namespaced indicates if a resource is namespaced or not.

shortNames

shortNames is a list of suggested short names of the resource.

singularName

singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.

storageVersionHash

The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.

verbs

verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)

version

version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".

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 the grouped resources this resource belongs to (e.g. 'all')

categories is a list of the grouped resources this resource belongs to (e.g. 'all')

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

def getGroup: IO[K8sFailure, String]

group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".

group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".

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

def getKind: IO[K8sFailure, String]

kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')

kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')

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

def getName: IO[K8sFailure, String]

name is the plural name of the resource.

name is the plural name of the resource.

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

def getNamespaced: IO[K8sFailure, Boolean]

namespaced indicates if a resource is namespaced or not.

namespaced indicates if a resource is namespaced or not.

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

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

shortNames is a list of suggested short names of the resource.

shortNames is a list of suggested short names of the resource.

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

def getSingularName: IO[K8sFailure, String]

singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.

singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.

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

The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.

The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.

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

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

verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)

verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)

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

def getVersion: IO[K8sFailure, String]

version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".

version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".

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