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

Class ExtAuthz.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

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_api_msg_service.auth.v3.CheckRequest>`.
 A failed check will cause this filter to close the TCP connection.
 [#next-free-field: 7]
 

Protobuf type envoy.extensions.filters.network.ext_authz.v3.ExtAuthz

Method Summary

Modifier and Type	Method and Description
ExtAuthz.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ExtAuthz	build()
ExtAuthz	buildPartial()
ExtAuthz.Builder	clear()
ExtAuthz.Builder	clearFailureModeAllow() The filter's behaviour in case the external authorization service does not respond back.
ExtAuthz.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ExtAuthz.Builder	clearFilterEnabledMetadata() Specifies if the filter is enabled with metadata matcher.
ExtAuthz.Builder	clearGrpcService() The external authorization gRPC service configuration.
ExtAuthz.Builder	clearIncludePeerCertificate() Specifies if the peer certificate is sent to the external service.
ExtAuthz.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ExtAuthz.Builder	clearStatPrefix() The prefix to use when emitting statistics.
ExtAuthz.Builder	clearTransportApiVersion() API version for ext_authz transport protocol.
ExtAuthz.Builder	clone()
ExtAuthz	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getFailureModeAllow() The filter's behaviour in case the external authorization service does not respond back.
MetadataMatcher	getFilterEnabledMetadata() Specifies if the filter is enabled with metadata matcher.
MetadataMatcher.Builder	getFilterEnabledMetadataBuilder() Specifies if the filter is enabled with metadata matcher.
MetadataMatcherOrBuilder	getFilterEnabledMetadataOrBuilder() Specifies if the filter is enabled with metadata matcher.
GrpcService	getGrpcService() The external authorization gRPC service configuration.
GrpcService.Builder	getGrpcServiceBuilder() The external authorization gRPC service configuration.
GrpcServiceOrBuilder	getGrpcServiceOrBuilder() The external authorization gRPC service configuration.
boolean	getIncludePeerCertificate() Specifies if the peer certificate is sent to the external service.
String	getStatPrefix() The prefix to use when emitting statistics.
com.google.protobuf.ByteString	getStatPrefixBytes() The prefix to use when emitting statistics.
ApiVersion	getTransportApiVersion() API version for ext_authz transport protocol.
int	getTransportApiVersionValue() API version for ext_authz transport protocol.
boolean	hasFilterEnabledMetadata() Specifies if the filter is enabled with metadata matcher.
boolean	hasGrpcService() The external authorization gRPC service configuration.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ExtAuthz.Builder	mergeFilterEnabledMetadata(MetadataMatcher value) Specifies if the filter is enabled with metadata matcher.
ExtAuthz.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ExtAuthz.Builder	mergeFrom(ExtAuthz other)
ExtAuthz.Builder	mergeFrom(com.google.protobuf.Message other)
ExtAuthz.Builder	mergeGrpcService(GrpcService value) The external authorization gRPC service configuration.
ExtAuthz.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ExtAuthz.Builder	setFailureModeAllow(boolean value) The filter's behaviour in case the external authorization service does not respond back.
ExtAuthz.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ExtAuthz.Builder	setFilterEnabledMetadata(MetadataMatcher.Builder builderForValue) Specifies if the filter is enabled with metadata matcher.
ExtAuthz.Builder	setFilterEnabledMetadata(MetadataMatcher value) Specifies if the filter is enabled with metadata matcher.
ExtAuthz.Builder	setGrpcService(GrpcService.Builder builderForValue) The external authorization gRPC service configuration.
ExtAuthz.Builder	setGrpcService(GrpcService value) The external authorization gRPC service configuration.
ExtAuthz.Builder	setIncludePeerCertificate(boolean value) Specifies if the peer certificate is sent to the external service.
ExtAuthz.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ExtAuthz.Builder	setStatPrefix(String value) The prefix to use when emitting statistics.
ExtAuthz.Builder	setStatPrefixBytes(com.google.protobuf.ByteString value) The prefix to use when emitting statistics.
ExtAuthz.Builder	setTransportApiVersion(ApiVersion value) API version for ext_authz transport protocol.
ExtAuthz.Builder	setTransportApiVersionValue(int value) API version for ext_authz transport protocol.
ExtAuthz.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>

clear

public ExtAuthz.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>

getDefaultInstanceForType

public ExtAuthz getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ExtAuthz build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ExtAuthz buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ExtAuthz.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>

setField

public ExtAuthz.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>

clearField

public ExtAuthz.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>

clearOneof

public ExtAuthz.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>

setRepeatedField

public ExtAuthz.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>

addRepeatedField

public ExtAuthz.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>

mergeFrom

public ExtAuthz.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExtAuthz.Builder>

mergeFrom

public ExtAuthz.Builder mergeFrom(ExtAuthz other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.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:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ExtAuthz.Builder>

Throws:

IOException

getStatPrefix

public String getStatPrefix()

 The prefix to use when emitting statistics.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

Specified by:

getStatPrefix in interface ExtAuthzOrBuilder

getStatPrefixBytes

public com.google.protobuf.ByteString getStatPrefixBytes()

 The prefix to use when emitting statistics.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

Specified by:

getStatPrefixBytes in interface ExtAuthzOrBuilder

setStatPrefix

public ExtAuthz.Builder setStatPrefix(String value)

 The prefix to use when emitting statistics.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

clearStatPrefix

public ExtAuthz.Builder clearStatPrefix()

 The prefix to use when emitting statistics.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

setStatPrefixBytes

public ExtAuthz.Builder setStatPrefixBytes(com.google.protobuf.ByteString value)

 The prefix to use when emitting statistics.
 

string stat_prefix = 1 [(.validate.rules) = { ... }

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:

hasGrpcService in interface ExtAuthzOrBuilder

getGrpcService

public 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;

Specified by:

getGrpcService in interface ExtAuthzOrBuilder

setGrpcService

public ExtAuthz.Builder setGrpcService(GrpcService value)

 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

public ExtAuthz.Builder setGrpcService(GrpcService.Builder builderForValue)

 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

public ExtAuthz.Builder mergeGrpcService(GrpcService value)

 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

public ExtAuthz.Builder 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

public GrpcService.Builder 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

public 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;

Specified by:

getGrpcServiceOrBuilder in interface ExtAuthzOrBuilder

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:

getFailureModeAllow in interface ExtAuthzOrBuilder

setFailureModeAllow

public ExtAuthz.Builder setFailureModeAllow(boolean value)

 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;

clearFailureModeAllow

public ExtAuthz.Builder 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;

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_api_field_service.auth.v3.AttributeContext.Peer.certificate>`.
 

bool include_peer_certificate = 4;

Specified by:

getIncludePeerCertificate in interface ExtAuthzOrBuilder

setIncludePeerCertificate

public ExtAuthz.Builder setIncludePeerCertificate(boolean value)

 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_api_field_service.auth.v3.AttributeContext.Peer.certificate>`.
 

bool include_peer_certificate = 4;

clearIncludePeerCertificate

public ExtAuthz.Builder 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_api_field_service.auth.v3.AttributeContext.Peer.certificate>`.
 

bool include_peer_certificate = 4;

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:

getTransportApiVersionValue in interface ExtAuthzOrBuilder

setTransportApiVersionValue

public ExtAuthz.Builder setTransportApiVersionValue(int value)

 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) = { ... }

getTransportApiVersion

public 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) = { ... }

Specified by:

getTransportApiVersion in interface ExtAuthzOrBuilder

setTransportApiVersion

public ExtAuthz.Builder setTransportApiVersion(ApiVersion value)

 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) = { ... }

clearTransportApiVersion

public ExtAuthz.Builder 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) = { ... }

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:

hasFilterEnabledMetadata in interface ExtAuthzOrBuilder

getFilterEnabledMetadata

public 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;

Specified by:

getFilterEnabledMetadata in interface ExtAuthzOrBuilder

setFilterEnabledMetadata

public ExtAuthz.Builder setFilterEnabledMetadata(MetadataMatcher value)

 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

public ExtAuthz.Builder setFilterEnabledMetadata(MetadataMatcher.Builder builderForValue)

 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

public ExtAuthz.Builder mergeFilterEnabledMetadata(MetadataMatcher value)

 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

public ExtAuthz.Builder 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

public MetadataMatcher.Builder 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

public 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;

Specified by:

getFilterEnabledMetadataOrBuilder in interface ExtAuthzOrBuilder

setUnknownFields

public final ExtAuthz.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>

mergeUnknownFields

public final ExtAuthz.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ExtAuthz.Builder>