Package io.fabric8.kubernetes.api.model.admissionregistration.v1beta1

Class ValidatingWebhook

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<ValidatingWebhookBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class ValidatingWebhook
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<ValidatingWebhookBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    ValidatingWebhook describes an admission webhook and the resources and operations it applies to.
    See Also:
    Serialized Form

    • Constructor Detail

      • ValidatingWebhook

        public ValidatingWebhook()
        No args constructor for use in serialization

    • Method Detail

      • getAdmissionReviewVersions

        public List<String> getAdmissionReviewVersions()
        AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. Default to `['v1beta1']`.

      • setAdmissionReviewVersions

        public void setAdmissionReviewVersions​(List<String> admissionReviewVersions)
        AdmissionReviewVersions is an ordered list of preferred `AdmissionReview` versions the Webhook expects. API server will try to use first version in the list which it supports. If none of the versions specified in this list supported by API server, validation will fail for this object. If a persisted webhook configuration specifies allowed versions and does not include any versions known to the API Server, calls to the webhook will fail and be subject to the failure policy. Default to `['v1beta1']`.

      • getClientConfig

        public WebhookClientConfig getClientConfig()
        ValidatingWebhook describes an admission webhook and the resources and operations it applies to.

      • setClientConfig

        public void setClientConfig​(WebhookClientConfig clientConfig)
        ValidatingWebhook describes an admission webhook and the resources and operations it applies to.

      • getFailurePolicy

        public String getFailurePolicy()
        FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore.

      • setFailurePolicy

        public void setFailurePolicy​(String failurePolicy)
        FailurePolicy defines how unrecognized errors from the admission endpoint are handled - allowed values are Ignore or Fail. Defaults to Ignore.

      • getMatchPolicy

        public String getMatchPolicy()
        matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent".


        - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook.


        - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook.


        Defaults to "Exact"

      • setMatchPolicy

        public void setMatchPolicy​(String matchPolicy)
        matchPolicy defines how the "rules" list is used to match incoming requests. Allowed values are "Exact" or "Equivalent".


        - Exact: match a request only if it exactly matches a specified rule. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, but "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would not be sent to the webhook.


        - Equivalent: match a request if modifies a resource listed in rules, even via another API group or version. For example, if deployments can be modified via apps/v1, apps/v1beta1, and extensions/v1beta1, and "rules" only included `apiGroups:["apps"], apiVersions:["v1"], resources: ["deployments"]`, a request to apps/v1beta1 or extensions/v1beta1 would be converted to apps/v1 and sent to the webhook.


        Defaults to "Exact"

      • getName

        public String getName()
        The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required.

      • setName

        public void setName​(String name)
        The name of the admission webhook. Name should be fully qualified, e.g., imagepolicy.kubernetes.io, where "imagepolicy" is the name of the webhook, and kubernetes.io is the name of the organization. Required.

      • getNamespaceSelector

        public io.fabric8.kubernetes.api.model.LabelSelector getNamespaceSelector()
        ValidatingWebhook describes an admission webhook and the resources and operations it applies to.

      • setNamespaceSelector

        public void setNamespaceSelector​(io.fabric8.kubernetes.api.model.LabelSelector namespaceSelector)
        ValidatingWebhook describes an admission webhook and the resources and operations it applies to.

      • getObjectSelector

        public io.fabric8.kubernetes.api.model.LabelSelector getObjectSelector()
        ValidatingWebhook describes an admission webhook and the resources and operations it applies to.

      • setObjectSelector

        public void setObjectSelector​(io.fabric8.kubernetes.api.model.LabelSelector objectSelector)
        ValidatingWebhook describes an admission webhook and the resources and operations it applies to.

      • getRules

        public List<RuleWithOperations> getRules()
        Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects.

      • setRules

        public void setRules​(List<RuleWithOperations> rules)
        Rules describes what operations on what resources/subresources the webhook cares about. The webhook cares about an operation if it matches _any_ Rule. However, in order to prevent ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks from putting the cluster in a state which cannot be recovered from without completely disabling the plugin, ValidatingAdmissionWebhooks and MutatingAdmissionWebhooks are never called on admission requests for ValidatingWebhookConfiguration and MutatingWebhookConfiguration objects.

      • getSideEffects

        public String getSideEffects()
        SideEffects states whether this webhook has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown.

      • setSideEffects

        public void setSideEffects​(String sideEffects)
        SideEffects states whether this webhook has side effects. Acceptable values are: Unknown, None, Some, NoneOnDryRun Webhooks with side effects MUST implement a reconciliation system, since a request may be rejected by a future step in the admission chain and the side effects therefore need to be undone. Requests with the dryRun attribute will be auto-rejected if they match a webhook with sideEffects == Unknown or Some. Defaults to Unknown.

      • getTimeoutSeconds

        public Integer getTimeoutSeconds()
        TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 30 seconds.

      • setTimeoutSeconds

        public void setTimeoutSeconds​(Integer timeoutSeconds)
        TimeoutSeconds specifies the timeout for this webhook. After the timeout passes, the webhook call will be ignored or the API call will fail based on the failure policy. The timeout value must be between 1 and 30 seconds. Default to 30 seconds.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

        public void setAdditionalProperties​(Map<String,​Object> additionalProperties)