--- WARNING: THIS IS AN AUTO-GENERATED FILE, DO NOT EDIT. PLEASE MODIFY THE ORIGINAL SOURCE IN THE 'https://github.com/istio/istio' REPO source_repo: https://github.com/istio/istio title: Denier description: Adapter that always returns a precondition denial. location: https://istio.io/docs/reference/config/policy-and-telemetry/adapters/denier.html layout: protoc-gen-docs generator: protoc-gen-docs supported_templates: listentry,quota,checknothing aliases: - /docs/reference/config/adapters/denier.html number_of_entries: 2 ---

The denier adapter is designed to always return a denial to precondition checks. You can specify the exact error to return for these denials.

This adapter supports the checknothing template, the listentry template, and the quota template.

Params

Configuration format for the Denier adapter.

Field Type Description Required
status Status

The error to return when denying a request.

No
validDuration Duration

The duration for which the denial is valid.

No
validUseCount int32

The number of times the denial may be used.

No

google.rpc.Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be:

Overview

The Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.

Language mapping

The Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.

Other uses

The error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.

Example uses of this error model include:

Field Type Description Required
code int32

The status code, which should be an enum value of google.rpc.Code.

No
message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

No
details Any[]

A list of messages that carry the error details. There is a common set of message types for APIs to use.

No