io.k8s.api.flowcontrol.v1beta3.ResourcePolicyRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bl-k8s130 Show documentation
Programmatic resource management for Kubernetes
There is a newer version: 1.30.4
package io.k8s.api.flowcontrol.v1beta3;

import java.lang.Boolean;
import java.lang.String;
import java.util.List;

/**
 * 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.
 */
public class ResourcePolicyRule {
  public List apiGroups;

  public Boolean clusterScope;

  public List namespaces;

  public List resources;

  public List verbs;

  /**
   * `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.
   */
  public ResourcePolicyRule apiGroups(List apiGroups) {
    this.apiGroups = apiGroups;
    return this;
  }

  /**
   * `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.
   */
  public ResourcePolicyRule clusterScope(Boolean clusterScope) {
    this.clusterScope = clusterScope;
    return this;
  }

  /**
   * `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.
   */
  public ResourcePolicyRule namespaces(List namespaces) {
    this.namespaces = namespaces;
    return this;
  }

  /**
   * `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.
   */
  public ResourcePolicyRule resources(List resources) {
    this.resources = resources;
    return this;
  }

  /**
   * `verbs` is a list of matching verbs and may not be empty. "*" matches all verbs and, if present, must be the only entry. Required.
   */
  public ResourcePolicyRule verbs(List verbs) {
    this.verbs = verbs;
    return this;
  }

  public static ResourcePolicyRule resourcePolicyRule() {
    return new ResourcePolicyRule();
  }
}