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

Class CheckSettings

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.envoyproxy.envoy.extensions.filters.http.ext_authz.v3.CheckSettings

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CheckSettingsOrBuilder, Serializable

public final class CheckSettings
extends com.google.protobuf.GeneratedMessageV3
implements CheckSettingsOrBuilder

 Extra settings for the check request.
 

Protobuf type envoy.extensions.filters.http.ext_authz.v3.CheckSettings

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckSettings.Builder Extra settings for the check request.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTEXT_EXTENSIONS_FIELD_NUMBER
static int	DISABLE_REQUEST_BODY_BUFFERING_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsContextExtensions(String key) Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v3.AttributeContext.context_extensions>` You can use this to provide extra context for the external authorization server on specific virtual hosts/routes.
boolean	equals(Object obj)
Map<String,String>	getContextExtensions() Deprecated.
int	getContextExtensionsCount() Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v3.AttributeContext.context_extensions>` You can use this to provide extra context for the external authorization server on specific virtual hosts/routes.
Map<String,String>	getContextExtensionsMap() Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v3.AttributeContext.context_extensions>` You can use this to provide extra context for the external authorization server on specific virtual hosts/routes.
String	getContextExtensionsOrDefault(String key, String defaultValue) Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v3.AttributeContext.context_extensions>` You can use this to provide extra context for the external authorization server on specific virtual hosts/routes.
String	getContextExtensionsOrThrow(String key) Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v3.AttributeContext.context_extensions>` You can use this to provide extra context for the external authorization server on specific virtual hosts/routes.
static CheckSettings	getDefaultInstance()
CheckSettings	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getDisableRequestBodyBuffering() When set to true, disable the configured :ref:`with_request_body <envoy_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>` for a route.
com.google.protobuf.Parser<CheckSettings>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static CheckSettings.Builder	newBuilder()
static CheckSettings.Builder	newBuilder(CheckSettings prototype)
CheckSettings.Builder	newBuilderForType()
protected CheckSettings.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static CheckSettings	parseDelimitedFrom(InputStream input)
static CheckSettings	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckSettings	parseFrom(byte[] data)
static CheckSettings	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckSettings	parseFrom(ByteBuffer data)
static CheckSettings	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckSettings	parseFrom(com.google.protobuf.ByteString data)
static CheckSettings	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckSettings	parseFrom(com.google.protobuf.CodedInputStream input)
static CheckSettings	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static CheckSettings	parseFrom(InputStream input)
static CheckSettings	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<CheckSettings>	parser()
CheckSettings.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CONTEXT_EXTENSIONS_FIELD_NUMBER

public static final int CONTEXT_EXTENSIONS_FIELD_NUMBER

See Also:

Constant Field Values

DISABLE_REQUEST_BODY_BUFFERING_FIELD_NUMBER

public static final int DISABLE_REQUEST_BODY_BUFFERING_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getContextExtensionsCount

public int getContextExtensionsCount()

Description copied from interface: CheckSettingsOrBuilder

 Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v3.AttributeContext.context_extensions>`
 You can use this to provide extra context for the external authorization server on specific
 virtual hosts/routes. For example, adding a context extension on the virtual host level can
 give the ext-authz server information on what virtual host is used without needing to parse the
 host header. If CheckSettings is specified in multiple per-filter-configs, they will be merged
 in order, and the result will be used.
 Merge semantics for this field are such that keys from more specific configs override.
 .. note::
   These settings are only applied to a filter configured with a
   :ref:`grpc_service<envoy_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
 

map<string, string> context_extensions = 1;

Specified by:

getContextExtensionsCount in interface CheckSettingsOrBuilder

containsContextExtensions

public boolean containsContextExtensions(String key)

 Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v3.AttributeContext.context_extensions>`
 You can use this to provide extra context for the external authorization server on specific
 virtual hosts/routes. For example, adding a context extension on the virtual host level can
 give the ext-authz server information on what virtual host is used without needing to parse the
 host header. If CheckSettings is specified in multiple per-filter-configs, they will be merged
 in order, and the result will be used.
 Merge semantics for this field are such that keys from more specific configs override.
 .. note::
   These settings are only applied to a filter configured with a
   :ref:`grpc_service<envoy_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
 

map<string, string> context_extensions = 1;

Specified by:

containsContextExtensions in interface CheckSettingsOrBuilder

getContextExtensions

@Deprecated
public Map<String,String> getContextExtensions()

Deprecated.

Use getContextExtensionsMap() instead.

Specified by:

getContextExtensions in interface CheckSettingsOrBuilder

getContextExtensionsMap

public Map<String,String> getContextExtensionsMap()

 Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v3.AttributeContext.context_extensions>`
 You can use this to provide extra context for the external authorization server on specific
 virtual hosts/routes. For example, adding a context extension on the virtual host level can
 give the ext-authz server information on what virtual host is used without needing to parse the
 host header. If CheckSettings is specified in multiple per-filter-configs, they will be merged
 in order, and the result will be used.
 Merge semantics for this field are such that keys from more specific configs override.
 .. note::
   These settings are only applied to a filter configured with a
   :ref:`grpc_service<envoy_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
 

map<string, string> context_extensions = 1;

Specified by:

getContextExtensionsMap in interface CheckSettingsOrBuilder

getContextExtensionsOrDefault

public String getContextExtensionsOrDefault(String key,
                                            String defaultValue)

 Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v3.AttributeContext.context_extensions>`
 You can use this to provide extra context for the external authorization server on specific
 virtual hosts/routes. For example, adding a context extension on the virtual host level can
 give the ext-authz server information on what virtual host is used without needing to parse the
 host header. If CheckSettings is specified in multiple per-filter-configs, they will be merged
 in order, and the result will be used.
 Merge semantics for this field are such that keys from more specific configs override.
 .. note::
   These settings are only applied to a filter configured with a
   :ref:`grpc_service<envoy_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
 

map<string, string> context_extensions = 1;

Specified by:

getContextExtensionsOrDefault in interface CheckSettingsOrBuilder

getContextExtensionsOrThrow

public String getContextExtensionsOrThrow(String key)

 Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v3.AttributeContext.context_extensions>`
 You can use this to provide extra context for the external authorization server on specific
 virtual hosts/routes. For example, adding a context extension on the virtual host level can
 give the ext-authz server information on what virtual host is used without needing to parse the
 host header. If CheckSettings is specified in multiple per-filter-configs, they will be merged
 in order, and the result will be used.
 Merge semantics for this field are such that keys from more specific configs override.
 .. note::
   These settings are only applied to a filter configured with a
   :ref:`grpc_service<envoy_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
 

map<string, string> context_extensions = 1;

Specified by:

getContextExtensionsOrThrow in interface CheckSettingsOrBuilder

getDisableRequestBodyBuffering

public boolean getDisableRequestBodyBuffering()

 When set to true, disable the configured :ref:`with_request_body
 <envoy_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>` for a route.
 

bool disable_request_body_buffering = 2;

Specified by:

getDisableRequestBodyBuffering in interface CheckSettingsOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static CheckSettings parseFrom(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckSettings parseFrom(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckSettings parseFrom(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckSettings parseFrom(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckSettings parseFrom(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckSettings parseFrom(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static CheckSettings parseFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static CheckSettings parseFrom(InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static CheckSettings parseDelimitedFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static CheckSettings parseDelimitedFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseFrom

public static CheckSettings parseFrom(com.google.protobuf.CodedInputStream input)
                               throws IOException

Throws:

IOException

parseFrom

public static CheckSettings parseFrom(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

newBuilderForType

public CheckSettings.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static CheckSettings.Builder newBuilder()

newBuilder

public static CheckSettings.Builder newBuilder(CheckSettings prototype)

toBuilder

public CheckSettings.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected CheckSettings.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static CheckSettings getDefaultInstance()

parser

public static com.google.protobuf.Parser<CheckSettings> parser()

getParserForType

public com.google.protobuf.Parser<CheckSettings> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public CheckSettings getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder