Class FilterStateValue
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.common.set_filter_state.v3.FilterStateValue
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,FilterStateValueOrBuilder,Serializable
public final class FilterStateValue
extends com.google.protobuf.GeneratedMessageV3
implements FilterStateValueOrBuilder
A filter state key and value pair. [#next-free-field: 7]Protobuf type
envoy.extensions.filters.common.set_filter_state.v3.FilterStateValue- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA filter state key and value pair.static enumstatic enumProtobuf enumenvoy.extensions.filters.common.set_filter_state.v3.FilterStateValue.SharedWithUpstreamstatic enumNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic FilterStateValuestatic final com.google.protobuf.Descriptors.DescriptorSpecifies which registered factory should be used to create the filter state object from the provided value.com.google.protobuf.ByteStringSpecifies which registered factory should be used to create the filter state object from the provided value.Uses the :ref:`format string <config_access_log_format_strings>` to instantiate the filter state object value.Uses the :ref:`format string <config_access_log_format_strings>` to instantiate the filter state object value.The name under which the filter state object will be stored and can be retrieved.com.google.protobuf.ByteStringThe name under which the filter state object will be stored and can be retrieved.com.google.protobuf.Parser<FilterStateValue>booleanIf marked as read-only, the filter state key value is locked, and cannot be overridden by any filter, including this filter.intConfigures the object to be shared with the upstream internal connections.intConfigures the object to be shared with the upstream internal connections.booleanSkip the update if the value evaluates to an empty string.booleanUses the :ref:`format string <config_access_log_format_strings>` to instantiate the filter state object value.inthashCode()booleanThe name under which the filter state object will be stored and can be retrieved.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic FilterStateValue.Builderstatic FilterStateValue.BuildernewBuilder(FilterStateValue prototype) protected FilterStateValue.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static FilterStateValueparseDelimitedFrom(InputStream input) static FilterStateValueparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FilterStateValueparseFrom(byte[] data) static FilterStateValueparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FilterStateValueparseFrom(com.google.protobuf.ByteString data) static FilterStateValueparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FilterStateValueparseFrom(com.google.protobuf.CodedInputStream input) static FilterStateValueparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FilterStateValueparseFrom(InputStream input) static FilterStateValueparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static FilterStateValueparseFrom(ByteBuffer data) static FilterStateValueparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<FilterStateValue>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
OBJECT_KEY_FIELD_NUMBER
public static final int OBJECT_KEY_FIELD_NUMBER- See Also:
-
FACTORY_KEY_FIELD_NUMBER
public static final int FACTORY_KEY_FIELD_NUMBER- See Also:
-
FORMAT_STRING_FIELD_NUMBER
public static final int FORMAT_STRING_FIELD_NUMBER- See Also:
-
READ_ONLY_FIELD_NUMBER
public static final int READ_ONLY_FIELD_NUMBER- See Also:
-
SHARED_WITH_UPSTREAM_FIELD_NUMBER
public static final int SHARED_WITH_UPSTREAM_FIELD_NUMBER- See Also:
-
SKIP_IF_EMPTY_FIELD_NUMBER
public static final int SKIP_IF_EMPTY_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
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
-
getKeyCase
- Specified by:
getKeyCasein interfaceFilterStateValueOrBuilder
-
getValueCase
- Specified by:
getValueCasein interfaceFilterStateValueOrBuilder
-
hasObjectKey
public boolean hasObjectKey()The name under which the filter state object will be stored and can be retrieved. When using :ref:`well-known filter state keys <well_known_filter_state>` (e.g., ``envoy.network.upstream_server_name``, ``envoy.tcp_proxy.cluster``), the object key serves dual purpose where it identifies both where the data is stored and which factory creates the object. In this case, :ref:`factory_key <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.factory_key>` is not needed. When using a custom key name which is not from the well-known list, you must also specify :ref:`factory_key <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.factory_key>` to indicate which factory should create the object from your value. Example using a well-known key where ``factory_key`` is not needed: .. code-block:: yaml object_key: envoy.tcp_proxy.cluster format_string: text_format_source: inline_string: "my-cluster" Example using a custom key which requires a ``factory_key``: .. code-block:: yaml object_key: my.custom.key factory_key: envoy.string format_string: text_format_source: inline_string: "my-value"string object_key = 1 [(.validate.rules) = { ... }- Specified by:
hasObjectKeyin interfaceFilterStateValueOrBuilder- Returns:
- Whether the objectKey field is set.
-
getObjectKey
The name under which the filter state object will be stored and can be retrieved. When using :ref:`well-known filter state keys <well_known_filter_state>` (e.g., ``envoy.network.upstream_server_name``, ``envoy.tcp_proxy.cluster``), the object key serves dual purpose where it identifies both where the data is stored and which factory creates the object. In this case, :ref:`factory_key <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.factory_key>` is not needed. When using a custom key name which is not from the well-known list, you must also specify :ref:`factory_key <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.factory_key>` to indicate which factory should create the object from your value. Example using a well-known key where ``factory_key`` is not needed: .. code-block:: yaml object_key: envoy.tcp_proxy.cluster format_string: text_format_source: inline_string: "my-cluster" Example using a custom key which requires a ``factory_key``: .. code-block:: yaml object_key: my.custom.key factory_key: envoy.string format_string: text_format_source: inline_string: "my-value"string object_key = 1 [(.validate.rules) = { ... }- Specified by:
getObjectKeyin interfaceFilterStateValueOrBuilder- Returns:
- The objectKey.
-
getObjectKeyBytes
public com.google.protobuf.ByteString getObjectKeyBytes()The name under which the filter state object will be stored and can be retrieved. When using :ref:`well-known filter state keys <well_known_filter_state>` (e.g., ``envoy.network.upstream_server_name``, ``envoy.tcp_proxy.cluster``), the object key serves dual purpose where it identifies both where the data is stored and which factory creates the object. In this case, :ref:`factory_key <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.factory_key>` is not needed. When using a custom key name which is not from the well-known list, you must also specify :ref:`factory_key <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.factory_key>` to indicate which factory should create the object from your value. Example using a well-known key where ``factory_key`` is not needed: .. code-block:: yaml object_key: envoy.tcp_proxy.cluster format_string: text_format_source: inline_string: "my-cluster" Example using a custom key which requires a ``factory_key``: .. code-block:: yaml object_key: my.custom.key factory_key: envoy.string format_string: text_format_source: inline_string: "my-value"string object_key = 1 [(.validate.rules) = { ... }- Specified by:
getObjectKeyBytesin interfaceFilterStateValueOrBuilder- Returns:
- The bytes for objectKey.
-
getFactoryKey
Specifies which registered factory should be used to create the filter state object from the provided value. This field is required when :ref:`object_key <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.object_key>` is a custom name not found in the :ref:`well-known filter state keys <well_known_filter_state>`. Each well-known key has a factory registered with the same name (e.g., the key ``envoy.tcp_proxy.cluster`` has a factory also named ``envoy.tcp_proxy.cluster``). For custom keys, use one of the following generic factories: * ``envoy.string``: Creates a generic string object. Use this for arbitrary string values that will be accessed via ``StringAccessor``. If not specified, defaults to the value of ``object_key``.
string factory_key = 6;- Specified by:
getFactoryKeyin interfaceFilterStateValueOrBuilder- Returns:
- The factoryKey.
-
getFactoryKeyBytes
public com.google.protobuf.ByteString getFactoryKeyBytes()Specifies which registered factory should be used to create the filter state object from the provided value. This field is required when :ref:`object_key <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.object_key>` is a custom name not found in the :ref:`well-known filter state keys <well_known_filter_state>`. Each well-known key has a factory registered with the same name (e.g., the key ``envoy.tcp_proxy.cluster`` has a factory also named ``envoy.tcp_proxy.cluster``). For custom keys, use one of the following generic factories: * ``envoy.string``: Creates a generic string object. Use this for arbitrary string values that will be accessed via ``StringAccessor``. If not specified, defaults to the value of ``object_key``.
string factory_key = 6;- Specified by:
getFactoryKeyBytesin interfaceFilterStateValueOrBuilder- Returns:
- The bytes for factoryKey.
-
hasFormatString
public boolean hasFormatString()Uses the :ref:`format string <config_access_log_format_strings>` to instantiate the filter state object value.
.envoy.config.core.v3.SubstitutionFormatString format_string = 2;- Specified by:
hasFormatStringin interfaceFilterStateValueOrBuilder- Returns:
- Whether the formatString field is set.
-
getFormatString
Uses the :ref:`format string <config_access_log_format_strings>` to instantiate the filter state object value.
.envoy.config.core.v3.SubstitutionFormatString format_string = 2;- Specified by:
getFormatStringin interfaceFilterStateValueOrBuilder- Returns:
- The formatString.
-
getFormatStringOrBuilder
Uses the :ref:`format string <config_access_log_format_strings>` to instantiate the filter state object value.
.envoy.config.core.v3.SubstitutionFormatString format_string = 2;- Specified by:
getFormatStringOrBuilderin interfaceFilterStateValueOrBuilder
-
getReadOnly
public boolean getReadOnly()If marked as read-only, the filter state key value is locked, and cannot be overridden by any filter, including this filter.
bool read_only = 3;- Specified by:
getReadOnlyin interfaceFilterStateValueOrBuilder- Returns:
- The readOnly.
-
getSkipIfEmpty
public boolean getSkipIfEmpty()Skip the update if the value evaluates to an empty string. This option can be used to supply multiple alternatives for the same filter state object key.
bool skip_if_empty = 5;- Specified by:
getSkipIfEmptyin interfaceFilterStateValueOrBuilder- Returns:
- The skipIfEmpty.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static FilterStateValue parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FilterStateValue parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FilterStateValue parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FilterStateValue parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FilterStateValue parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static FilterStateValue parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static FilterStateValue parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static FilterStateValue parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static FilterStateValue parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static FilterStateValue parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected FilterStateValue.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-