Package io.envoyproxy.envoy.extensions.filters.network.ext_authz.v3

Interface ExtAuthzOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ExtAuthz, ExtAuthz.Builder
    public interface ExtAuthzOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getStatPrefix

        String getStatPrefix()
         The prefix to use when emitting statistics.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Returns:
        The statPrefix.

      • getStatPrefixBytes

        com.google.protobuf.ByteString getStatPrefixBytes()
         The prefix to use when emitting statistics.
        string stat_prefix = 1 [(.validate.rules) = { ... }
        Returns:
        The bytes for statPrefix.

      • hasGrpcService

        boolean hasGrpcService()
         The external authorization gRPC service configuration.
 The default timeout is set to 200ms by this filter.
        .envoy.config.core.v3.GrpcService grpc_service = 2;
        Returns:
        Whether the grpcService field is set.

      • getGrpcService

        GrpcService getGrpcService()
         The external authorization gRPC service configuration.
 The default timeout is set to 200ms by this filter.
        .envoy.config.core.v3.GrpcService grpc_service = 2;
        Returns:
        The grpcService.

      • getGrpcServiceOrBuilder

        GrpcServiceOrBuilder getGrpcServiceOrBuilder()
         The external authorization gRPC service configuration.
 The default timeout is set to 200ms by this filter.
        .envoy.config.core.v3.GrpcService grpc_service = 2;

      • getFailureModeAllow

        boolean getFailureModeAllow()
         The filter's behaviour in case the external authorization service does
 not respond back. When it is set to true, Envoy will also allow traffic in case of
 communication failure between authorization service and the proxy.
 Defaults to false.
        bool failure_mode_allow = 3;
        Returns:
        The failureModeAllow.

      • getIncludePeerCertificate

        boolean getIncludePeerCertificate()
         Specifies if the peer certificate is sent to the external service.
 When this field is true, Envoy will include the peer X.509 certificate, if available, in the
 :ref:`certificate<envoy_v3_api_field_service.auth.v3.AttributeContext.Peer.certificate>`.
        bool include_peer_certificate = 4;
        Returns:
        The includePeerCertificate.

      • getTransportApiVersionValue

        int getTransportApiVersionValue()
         API version for ext_authz transport protocol. This describes the ext_authz gRPC endpoint and
 version of Check{Request,Response} used on the wire.
        .envoy.config.core.v3.ApiVersion transport_api_version = 5 [(.validate.rules) = { ... }
        Returns:
        The enum numeric value on the wire for transportApiVersion.

      • getTransportApiVersion

        ApiVersion getTransportApiVersion()
         API version for ext_authz transport protocol. This describes the ext_authz gRPC endpoint and
 version of Check{Request,Response} used on the wire.
        .envoy.config.core.v3.ApiVersion transport_api_version = 5 [(.validate.rules) = { ... }
        Returns:
        The transportApiVersion.

      • hasFilterEnabledMetadata

        boolean hasFilterEnabledMetadata()
         Specifies if the filter is enabled with metadata matcher.
 If this field is not specified, the filter will be enabled for all requests.
        .envoy.type.matcher.v3.MetadataMatcher filter_enabled_metadata = 6;
        Returns:
        Whether the filterEnabledMetadata field is set.

      • getFilterEnabledMetadata

        MetadataMatcher getFilterEnabledMetadata()
         Specifies if the filter is enabled with metadata matcher.
 If this field is not specified, the filter will be enabled for all requests.
        .envoy.type.matcher.v3.MetadataMatcher filter_enabled_metadata = 6;
        Returns:
        The filterEnabledMetadata.

      • getFilterEnabledMetadataOrBuilder

        MetadataMatcherOrBuilder getFilterEnabledMetadataOrBuilder()
         Specifies if the filter is enabled with metadata matcher.
 If this field is not specified, the filter will be enabled for all requests.
        .envoy.type.matcher.v3.MetadataMatcher filter_enabled_metadata = 6;

      • getBootstrapMetadataLabelsKey

        String getBootstrapMetadataLabelsKey()
         Optional labels that will be passed to :ref:`labels<envoy_v3_api_field_service.auth.v3.AttributeContext.Peer.labels>` in
 :ref:`destination<envoy_v3_api_field_service.auth.v3.AttributeContext.destination>`.
 The labels will be read from :ref:`metadata<envoy_v3_api_msg_config.core.v3.Node>` with the specified key.
        string bootstrap_metadata_labels_key = 7;
        Returns:
        The bootstrapMetadataLabelsKey.

      • getBootstrapMetadataLabelsKeyBytes

        com.google.protobuf.ByteString getBootstrapMetadataLabelsKeyBytes()
         Optional labels that will be passed to :ref:`labels<envoy_v3_api_field_service.auth.v3.AttributeContext.Peer.labels>` in
 :ref:`destination<envoy_v3_api_field_service.auth.v3.AttributeContext.destination>`.
 The labels will be read from :ref:`metadata<envoy_v3_api_msg_config.core.v3.Node>` with the specified key.
        string bootstrap_metadata_labels_key = 7;
        Returns:
        The bytes for bootstrapMetadataLabelsKey.