case class ResourcePolicyRule(apiGroups: Vector[String], clusterScope: Optional[Boolean] = Optional.Absent, namespaces: Optional[Vector[String]] = Optional.Absent, resources: Vector[String], verbs: Vector[String]) extends Product with Serializable

ResourcePolicyRule is a predicate that matches some resource requests, testing the request's verb and the target resource. A ResourcePolicyRule matches a resource request if and only if: (a) at least one member of verbs matches the request, (b) at least one member of apiGroups matches the request, (c) at least one member of resources matches the request, and (d) either (d1) the request does not specify a namespace (i.e., Namespace=="") and clusterScope is true or (d2) the request specifies a namespace and least one member of namespaces matches the request's namespace.

apiGroups

apiGroups is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.

clusterScope

clusterScope indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the namespaces field must contain a non-empty list.

namespaces

namespaces is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the clusterScope field for that). This list may be empty, but only if clusterScope is true.

resources

resources is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required.

verbs

verbs is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ResourcePolicyRule
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ResourcePolicyRule(apiGroups: Vector[String], clusterScope: Optional[Boolean] = Optional.Absent, namespaces: Optional[Vector[String]] = Optional.Absent, resources: Vector[String], verbs: Vector[String])

    apiGroups

    apiGroups is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.

    clusterScope

    clusterScope indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the namespaces field must contain a non-empty list.

    namespaces

    namespaces is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the clusterScope field for that). This list may be empty, but only if clusterScope is true.

    resources

    resources is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required.

    verbs

    verbs is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.

Value Members

  1. val apiGroups: Vector[String]
  2. val clusterScope: Optional[Boolean]
  3. def getApiGroups: IO[K8sFailure, Vector[String]]

    apiGroups is a list of matching API groups and may not be empty.

    apiGroups is a list of matching API groups and may not be empty. "*" matches all API groups and, if present, must be the only entry. Required.

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

  4. def getClusterScope: IO[K8sFailure, Boolean]

    clusterScope indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces).

    clusterScope indicates whether to match requests that do not specify a namespace (which happens either because the resource is not namespaced or the request targets all namespaces). If this field is omitted or false then the namespaces field must contain a non-empty list.

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

  5. def getNamespaces: IO[K8sFailure, Vector[String]]

    namespaces is a list of target namespaces that restricts matches.

    namespaces is a list of target namespaces that restricts matches. A request that specifies a target namespace matches only if either (a) this list contains that target namespace or (b) this list contains "*". Note that "*" matches any specified namespace but does not match a request that _does not specify_ a namespace (see the clusterScope field for that). This list may be empty, but only if clusterScope is true.

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

  6. def getResources: IO[K8sFailure, Vector[String]]

    resources is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource.

    resources is a list of matching resources (i.e., lowercase and plural) with, if desired, subresource. For example, [ "services", "nodes/status" ]. This list may not be empty. "*" matches all resources and, if present, must be the only entry. Required.

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

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

    verbs is a list of matching verbs and may not be empty.

    verbs is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.

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

  8. val namespaces: Optional[Vector[String]]
  9. val resources: Vector[String]
  10. val verbs: Vector[String]