com.coralogix.zio.k8s.model.flowcontrol.v1beta1
ResourcePolicyRule
Companion object ResourcePolicyRule
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 thenamespaces
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 theclusterScope
field for that). This list may be empty, but only ifclusterScope
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.
- Alphabetic
- By Inheritance
- ResourcePolicyRule
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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 thenamespaces
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 theclusterScope
field for that). This list may be empty, but only ifclusterScope
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
-
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
- val apiGroups: Vector[String]
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
- val clusterScope: Optional[Boolean]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
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.
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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 thenamespaces
field must contain a non-empty list.If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
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 theclusterScope
field for that). This list may be empty, but only ifclusterScope
is true.If the field is not present, fails with com.coralogix.zio.k8s.client.UndefinedField.
-
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.
-
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.
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val namespaces: Optional[Vector[String]]
-
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 resources: Vector[String]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
- val verbs: Vector[String]
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated