Class ExtAuthz.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
io.envoyproxy.envoy.extensions.filters.network.ext_authz.v3.ExtAuthz.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,ExtAuthzOrBuilder,Cloneable
- Enclosing class:
- ExtAuthz
public static final class ExtAuthz.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
implements ExtAuthzOrBuilder
External Authorization filter calls out to an external service over the gRPC Authorization API defined by :ref:`CheckRequest <envoy_v3_api_msg_service.auth.v3.CheckRequest>`. A failed check will cause this filter to close the TCP connection. [#next-free-field: 12]Protobuf type
envoy.extensions.filters.network.ext_authz.v3.ExtAuthz-
Method Summary
Modifier and TypeMethodDescriptionSpecifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.addMetadataContextNamespacesBytes(com.google.protobuf.ByteString value) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.addTypedMetadataContextNamespacesBytes(com.google.protobuf.ByteString value) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.build()clear()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 filter's behaviour in case the external authorization service does not respond back.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) Specifies if the filter is enabled with metadata matcher.The external authorization gRPC service configuration.Specifies if the peer certificate is sent to the external service.Specifies if the TLS session level details like SNI are sent to the external service.Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) When set to ``true``, the filter will send a TLS ``access_denied(49)`` alert before closing the connection when authorization is denied.The prefix to use when emitting statistics.API version for ext_authz transport protocol.Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.clone()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>`.com.google.protobuf.ByteStringOptional 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>`.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorbooleanThe filter's behaviour in case the external authorization service does not respond back.Specifies if the filter is enabled with metadata matcher.Specifies if the filter is enabled with metadata matcher.Specifies if the filter is enabled with metadata matcher.The external authorization gRPC service configuration.The external authorization gRPC service configuration.The external authorization gRPC service configuration.booleanSpecifies if the peer certificate is sent to the external service.booleanSpecifies if the TLS session level details like SNI are sent to the external service.getMetadataContextNamespaces(int index) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.com.google.protobuf.ByteStringgetMetadataContextNamespacesBytes(int index) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.intSpecifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.com.google.protobuf.ProtocolStringListSpecifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.booleanWhen set to ``true``, the filter will send a TLS ``access_denied(49)`` alert before closing the connection when authorization is denied.The prefix to use when emitting statistics.com.google.protobuf.ByteStringThe prefix to use when emitting statistics.API version for ext_authz transport protocol.intAPI version for ext_authz transport protocol.getTypedMetadataContextNamespaces(int index) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.com.google.protobuf.ByteStringgetTypedMetadataContextNamespacesBytes(int index) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.intSpecifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.com.google.protobuf.ProtocolStringListSpecifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.booleanSpecifies if the filter is enabled with metadata matcher.booleanThe external authorization gRPC service configuration.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanSpecifies if the filter is enabled with metadata matcher.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeGrpcService(GrpcService value) The external authorization gRPC service configuration.final ExtAuthz.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) 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>`.setBootstrapMetadataLabelsKeyBytes(com.google.protobuf.ByteString value) 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>`.setFailureModeAllow(boolean value) The filter's behaviour in case the external authorization service does not respond back.Specifies if the filter is enabled with metadata matcher.setFilterEnabledMetadata(MetadataMatcher.Builder builderForValue) Specifies if the filter is enabled with metadata matcher.setGrpcService(GrpcService value) The external authorization gRPC service configuration.setGrpcService(GrpcService.Builder builderForValue) The external authorization gRPC service configuration.setIncludePeerCertificate(boolean value) Specifies if the peer certificate is sent to the external service.setIncludeTlsSession(boolean value) Specifies if the TLS session level details like SNI are sent to the external service.setMetadataContextNamespaces(int index, String value) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setSendTlsAlertOnDenial(boolean value) When set to ``true``, the filter will send a TLS ``access_denied(49)`` alert before closing the connection when authorization is denied.setStatPrefix(String value) The prefix to use when emitting statistics.setStatPrefixBytes(com.google.protobuf.ByteString value) The prefix to use when emitting statistics.setTransportApiVersion(ApiVersion value) API version for ext_authz transport protocol.setTransportApiVersionValue(int value) API version for ext_authz transport protocol.setTypedMetadataContextNamespaces(int index, String value) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service.final ExtAuthz.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
setField
public ExtAuthz.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
setRepeatedField
public ExtAuthz.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
addRepeatedField
public ExtAuthz.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ExtAuthz.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
mergeFrom
public ExtAuthz.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ExtAuthz.Builder>- Throws:
IOException
-
getStatPrefix
The prefix to use when emitting statistics.
string stat_prefix = 1 [(.validate.rules) = { ... }- Specified by:
getStatPrefixin interfaceExtAuthzOrBuilder- Returns:
- The statPrefix.
-
getStatPrefixBytes
public com.google.protobuf.ByteString getStatPrefixBytes()The prefix to use when emitting statistics.
string stat_prefix = 1 [(.validate.rules) = { ... }- Specified by:
getStatPrefixBytesin interfaceExtAuthzOrBuilder- Returns:
- The bytes for statPrefix.
-
setStatPrefix
The prefix to use when emitting statistics.
string stat_prefix = 1 [(.validate.rules) = { ... }- Parameters:
value- The statPrefix to set.- Returns:
- This builder for chaining.
-
clearStatPrefix
The prefix to use when emitting statistics.
string stat_prefix = 1 [(.validate.rules) = { ... }- Returns:
- This builder for chaining.
-
setStatPrefixBytes
The prefix to use when emitting statistics.
string stat_prefix = 1 [(.validate.rules) = { ... }- Parameters:
value- The bytes for statPrefix to set.- Returns:
- This builder for chaining.
-
hasGrpcService
public 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;- Specified by:
hasGrpcServicein interfaceExtAuthzOrBuilder- Returns:
- Whether the grpcService field is set.
-
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;- Specified by:
getGrpcServicein interfaceExtAuthzOrBuilder- Returns:
- The grpcService.
-
setGrpcService
The external authorization gRPC service configuration. The default timeout is set to 200ms by this filter.
.envoy.config.core.v3.GrpcService grpc_service = 2; -
setGrpcService
The external authorization gRPC service configuration. The default timeout is set to 200ms by this filter.
.envoy.config.core.v3.GrpcService grpc_service = 2; -
mergeGrpcService
The external authorization gRPC service configuration. The default timeout is set to 200ms by this filter.
.envoy.config.core.v3.GrpcService grpc_service = 2; -
clearGrpcService
The external authorization gRPC service configuration. The default timeout is set to 200ms by this filter.
.envoy.config.core.v3.GrpcService grpc_service = 2; -
getGrpcServiceBuilder
The external authorization gRPC service configuration. The default timeout is set to 200ms by this filter.
.envoy.config.core.v3.GrpcService grpc_service = 2; -
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;- Specified by:
getGrpcServiceOrBuilderin interfaceExtAuthzOrBuilder
-
getFailureModeAllow
public 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;- Specified by:
getFailureModeAllowin interfaceExtAuthzOrBuilder- Returns:
- The failureModeAllow.
-
setFailureModeAllow
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;- Parameters:
value- The failureModeAllow to set.- Returns:
- This builder for chaining.
-
clearFailureModeAllow
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:
- This builder for chaining.
-
getIncludePeerCertificate
public 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;- Specified by:
getIncludePeerCertificatein interfaceExtAuthzOrBuilder- Returns:
- The includePeerCertificate.
-
setIncludePeerCertificate
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;- Parameters:
value- The includePeerCertificate to set.- Returns:
- This builder for chaining.
-
clearIncludePeerCertificate
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:
- This builder for chaining.
-
getTransportApiVersionValue
public 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) = { ... }- Specified by:
getTransportApiVersionValuein interfaceExtAuthzOrBuilder- Returns:
- The enum numeric value on the wire for transportApiVersion.
-
setTransportApiVersionValue
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) = { ... }- Parameters:
value- The enum numeric value on the wire for transportApiVersion to set.- Returns:
- This builder for chaining.
-
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) = { ... }- Specified by:
getTransportApiVersionin interfaceExtAuthzOrBuilder- Returns:
- The transportApiVersion.
-
setTransportApiVersion
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) = { ... }- Parameters:
value- The transportApiVersion to set.- Returns:
- This builder for chaining.
-
clearTransportApiVersion
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:
- This builder for chaining.
-
hasFilterEnabledMetadata
public 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;- Specified by:
hasFilterEnabledMetadatain interfaceExtAuthzOrBuilder- Returns:
- Whether the filterEnabledMetadata field is set.
-
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;- Specified by:
getFilterEnabledMetadatain interfaceExtAuthzOrBuilder- Returns:
- The filterEnabledMetadata.
-
setFilterEnabledMetadata
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; -
setFilterEnabledMetadata
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; -
mergeFilterEnabledMetadata
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; -
clearFilterEnabledMetadata
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; -
getFilterEnabledMetadataBuilder
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; -
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;- Specified by:
getFilterEnabledMetadataOrBuilderin interfaceExtAuthzOrBuilder
-
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;- Specified by:
getBootstrapMetadataLabelsKeyin interfaceExtAuthzOrBuilder- Returns:
- The bootstrapMetadataLabelsKey.
-
getBootstrapMetadataLabelsKeyBytes
public 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;- Specified by:
getBootstrapMetadataLabelsKeyBytesin interfaceExtAuthzOrBuilder- Returns:
- The bytes for bootstrapMetadataLabelsKey.
-
setBootstrapMetadataLabelsKey
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;- Parameters:
value- The bootstrapMetadataLabelsKey to set.- Returns:
- This builder for chaining.
-
clearBootstrapMetadataLabelsKey
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:
- This builder for chaining.
-
setBootstrapMetadataLabelsKeyBytes
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;- Parameters:
value- The bytes for bootstrapMetadataLabelsKey to set.- Returns:
- This builder for chaining.
-
getIncludeTlsSession
public boolean getIncludeTlsSession()Specifies if the TLS session level details like SNI are sent to the external service. When this field is true, Envoy will include the SNI name used for TLSClientHello, if available, in the :ref:`tls_session<envoy_v3_api_field_service.auth.v3.AttributeContext.tls_session>`.
bool include_tls_session = 8;- Specified by:
getIncludeTlsSessionin interfaceExtAuthzOrBuilder- Returns:
- The includeTlsSession.
-
setIncludeTlsSession
Specifies if the TLS session level details like SNI are sent to the external service. When this field is true, Envoy will include the SNI name used for TLSClientHello, if available, in the :ref:`tls_session<envoy_v3_api_field_service.auth.v3.AttributeContext.tls_session>`.
bool include_tls_session = 8;- Parameters:
value- The includeTlsSession to set.- Returns:
- This builder for chaining.
-
clearIncludeTlsSession
Specifies if the TLS session level details like SNI are sent to the external service. When this field is true, Envoy will include the SNI name used for TLSClientHello, if available, in the :ref:`tls_session<envoy_v3_api_field_service.auth.v3.AttributeContext.tls_session>`.
bool include_tls_session = 8;- Returns:
- This builder for chaining.
-
getSendTlsAlertOnDenial
public boolean getSendTlsAlertOnDenial()When set to ``true``, the filter will send a TLS ``access_denied(49)`` alert before closing the connection when authorization is denied. This provides better visibility to TLS clients about the reason for connection closure. This alert is only sent for TLS connections. The non-TLS connections will be closed without sending an alert. Defaults to ``false``.
bool send_tls_alert_on_denial = 9;- Specified by:
getSendTlsAlertOnDenialin interfaceExtAuthzOrBuilder- Returns:
- The sendTlsAlertOnDenial.
-
setSendTlsAlertOnDenial
When set to ``true``, the filter will send a TLS ``access_denied(49)`` alert before closing the connection when authorization is denied. This provides better visibility to TLS clients about the reason for connection closure. This alert is only sent for TLS connections. The non-TLS connections will be closed without sending an alert. Defaults to ``false``.
bool send_tls_alert_on_denial = 9;- Parameters:
value- The sendTlsAlertOnDenial to set.- Returns:
- This builder for chaining.
-
clearSendTlsAlertOnDenial
When set to ``true``, the filter will send a TLS ``access_denied(49)`` alert before closing the connection when authorization is denied. This provides better visibility to TLS clients about the reason for connection closure. This alert is only sent for TLS connections. The non-TLS connections will be closed without sending an alert. Defaults to ``false``.
bool send_tls_alert_on_denial = 9;- Returns:
- This builder for chaining.
-
getMetadataContextNamespacesList
public com.google.protobuf.ProtocolStringList getMetadataContextNamespacesList()Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque ``protobuf::Struct``. For example, if the ``proxy_protocol`` listener filter is used and populates TLV metadata, then the following will pass that metadata to the authorization server for making decisions based on proxy protocol information. .. code-block:: yaml metadata_context_namespaces: - envoy.filters.listener.proxy_protocolrepeated string metadata_context_namespaces = 10;- Specified by:
getMetadataContextNamespacesListin interfaceExtAuthzOrBuilder- Returns:
- A list containing the metadataContextNamespaces.
-
getMetadataContextNamespacesCount
public int getMetadataContextNamespacesCount()Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque ``protobuf::Struct``. For example, if the ``proxy_protocol`` listener filter is used and populates TLV metadata, then the following will pass that metadata to the authorization server for making decisions based on proxy protocol information. .. code-block:: yaml metadata_context_namespaces: - envoy.filters.listener.proxy_protocolrepeated string metadata_context_namespaces = 10;- Specified by:
getMetadataContextNamespacesCountin interfaceExtAuthzOrBuilder- Returns:
- The count of metadataContextNamespaces.
-
getMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque ``protobuf::Struct``. For example, if the ``proxy_protocol`` listener filter is used and populates TLV metadata, then the following will pass that metadata to the authorization server for making decisions based on proxy protocol information. .. code-block:: yaml metadata_context_namespaces: - envoy.filters.listener.proxy_protocolrepeated string metadata_context_namespaces = 10;- Specified by:
getMetadataContextNamespacesin interfaceExtAuthzOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The metadataContextNamespaces at the given index.
-
getMetadataContextNamespacesBytes
public com.google.protobuf.ByteString getMetadataContextNamespacesBytes(int index) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque ``protobuf::Struct``. For example, if the ``proxy_protocol`` listener filter is used and populates TLV metadata, then the following will pass that metadata to the authorization server for making decisions based on proxy protocol information. .. code-block:: yaml metadata_context_namespaces: - envoy.filters.listener.proxy_protocolrepeated string metadata_context_namespaces = 10;- Specified by:
getMetadataContextNamespacesBytesin interfaceExtAuthzOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the metadataContextNamespaces at the given index.
-
setMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque ``protobuf::Struct``. For example, if the ``proxy_protocol`` listener filter is used and populates TLV metadata, then the following will pass that metadata to the authorization server for making decisions based on proxy protocol information. .. code-block:: yaml metadata_context_namespaces: - envoy.filters.listener.proxy_protocolrepeated string metadata_context_namespaces = 10;- Parameters:
index- The index to set the value at.value- The metadataContextNamespaces to set.- Returns:
- This builder for chaining.
-
addMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque ``protobuf::Struct``. For example, if the ``proxy_protocol`` listener filter is used and populates TLV metadata, then the following will pass that metadata to the authorization server for making decisions based on proxy protocol information. .. code-block:: yaml metadata_context_namespaces: - envoy.filters.listener.proxy_protocolrepeated string metadata_context_namespaces = 10;- Parameters:
value- The metadataContextNamespaces to add.- Returns:
- This builder for chaining.
-
addAllMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque ``protobuf::Struct``. For example, if the ``proxy_protocol`` listener filter is used and populates TLV metadata, then the following will pass that metadata to the authorization server for making decisions based on proxy protocol information. .. code-block:: yaml metadata_context_namespaces: - envoy.filters.listener.proxy_protocolrepeated string metadata_context_namespaces = 10;- Parameters:
values- The metadataContextNamespaces to add.- Returns:
- This builder for chaining.
-
clearMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque ``protobuf::Struct``. For example, if the ``proxy_protocol`` listener filter is used and populates TLV metadata, then the following will pass that metadata to the authorization server for making decisions based on proxy protocol information. .. code-block:: yaml metadata_context_namespaces: - envoy.filters.listener.proxy_protocolrepeated string metadata_context_namespaces = 10;- Returns:
- This builder for chaining.
-
addMetadataContextNamespacesBytes
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque ``protobuf::Struct``. For example, if the ``proxy_protocol`` listener filter is used and populates TLV metadata, then the following will pass that metadata to the authorization server for making decisions based on proxy protocol information. .. code-block:: yaml metadata_context_namespaces: - envoy.filters.listener.proxy_protocolrepeated string metadata_context_namespaces = 10;- Parameters:
value- The bytes of the metadataContextNamespaces to add.- Returns:
- This builder for chaining.
-
getTypedMetadataContextNamespacesList
public com.google.protobuf.ProtocolStringList getTypedMetadataContextNamespacesList()Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as a ``protobuf::Any``. This works similarly to ``metadata_context_namespaces`` but allows Envoy and the ext_authz server to share the protobuf message definition in order to perform safe parsing.
repeated string typed_metadata_context_namespaces = 11;- Specified by:
getTypedMetadataContextNamespacesListin interfaceExtAuthzOrBuilder- Returns:
- A list containing the typedMetadataContextNamespaces.
-
getTypedMetadataContextNamespacesCount
public int getTypedMetadataContextNamespacesCount()Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as a ``protobuf::Any``. This works similarly to ``metadata_context_namespaces`` but allows Envoy and the ext_authz server to share the protobuf message definition in order to perform safe parsing.
repeated string typed_metadata_context_namespaces = 11;- Specified by:
getTypedMetadataContextNamespacesCountin interfaceExtAuthzOrBuilder- Returns:
- The count of typedMetadataContextNamespaces.
-
getTypedMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as a ``protobuf::Any``. This works similarly to ``metadata_context_namespaces`` but allows Envoy and the ext_authz server to share the protobuf message definition in order to perform safe parsing.
repeated string typed_metadata_context_namespaces = 11;- Specified by:
getTypedMetadataContextNamespacesin interfaceExtAuthzOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The typedMetadataContextNamespaces at the given index.
-
getTypedMetadataContextNamespacesBytes
public com.google.protobuf.ByteString getTypedMetadataContextNamespacesBytes(int index) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as a ``protobuf::Any``. This works similarly to ``metadata_context_namespaces`` but allows Envoy and the ext_authz server to share the protobuf message definition in order to perform safe parsing.
repeated string typed_metadata_context_namespaces = 11;- Specified by:
getTypedMetadataContextNamespacesBytesin interfaceExtAuthzOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the typedMetadataContextNamespaces at the given index.
-
setTypedMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as a ``protobuf::Any``. This works similarly to ``metadata_context_namespaces`` but allows Envoy and the ext_authz server to share the protobuf message definition in order to perform safe parsing.
repeated string typed_metadata_context_namespaces = 11;- Parameters:
index- The index to set the value at.value- The typedMetadataContextNamespaces to set.- Returns:
- This builder for chaining.
-
addTypedMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as a ``protobuf::Any``. This works similarly to ``metadata_context_namespaces`` but allows Envoy and the ext_authz server to share the protobuf message definition in order to perform safe parsing.
repeated string typed_metadata_context_namespaces = 11;- Parameters:
value- The typedMetadataContextNamespaces to add.- Returns:
- This builder for chaining.
-
addAllTypedMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as a ``protobuf::Any``. This works similarly to ``metadata_context_namespaces`` but allows Envoy and the ext_authz server to share the protobuf message definition in order to perform safe parsing.
repeated string typed_metadata_context_namespaces = 11;- Parameters:
values- The typedMetadataContextNamespaces to add.- Returns:
- This builder for chaining.
-
clearTypedMetadataContextNamespaces
Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as a ``protobuf::Any``. This works similarly to ``metadata_context_namespaces`` but allows Envoy and the ext_authz server to share the protobuf message definition in order to perform safe parsing.
repeated string typed_metadata_context_namespaces = 11;- Returns:
- This builder for chaining.
-
addTypedMetadataContextNamespacesBytes
public ExtAuthz.Builder addTypedMetadataContextNamespacesBytes(com.google.protobuf.ByteString value) Specifies a list of metadata namespaces whose values, if present, will be passed to the ext_authz service. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as a ``protobuf::Any``. This works similarly to ``metadata_context_namespaces`` but allows Envoy and the ext_authz server to share the protobuf message definition in order to perform safe parsing.
repeated string typed_metadata_context_namespaces = 11;- Parameters:
value- The bytes of the typedMetadataContextNamespaces to add.- Returns:
- This builder for chaining.
-
setUnknownFields
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-
mergeUnknownFields
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>
-