Package io.envoyproxy.envoy.extensions.filters.common.set_filter_state.v3

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:

  • 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

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • getKeyCase

      public FilterStateValue.KeyCase getKeyCase()
      Specified by:
      getKeyCase in interface FilterStateValueOrBuilder

    • getValueCase

      public FilterStateValue.ValueCase getValueCase()
      Specified by:
      getValueCase in interface FilterStateValueOrBuilder

    • hasObjectKey

      public boolean hasObjectKey()
       Filter state object key. The key is used to lookup the object factory, unless :ref:`factory_key
 <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.factory_key>` is set. See
 :ref:`the well-known filter state keys <well_known_filter_state>` for a list of valid object keys.
      string object_key = 1 [(.validate.rules) = { ... }
      Specified by:
      hasObjectKey in interface FilterStateValueOrBuilder
      Returns:
      Whether the objectKey field is set.

    • getObjectKey

      public String getObjectKey()
       Filter state object key. The key is used to lookup the object factory, unless :ref:`factory_key
 <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.factory_key>` is set. See
 :ref:`the well-known filter state keys <well_known_filter_state>` for a list of valid object keys.
      string object_key = 1 [(.validate.rules) = { ... }
      Specified by:
      getObjectKey in interface FilterStateValueOrBuilder
      Returns:
      The objectKey.

    • getObjectKeyBytes

      public com.google.protobuf.ByteString getObjectKeyBytes()
       Filter state object key. The key is used to lookup the object factory, unless :ref:`factory_key
 <envoy_v3_api_field_extensions.filters.common.set_filter_state.v3.FilterStateValue.factory_key>` is set. See
 :ref:`the well-known filter state keys <well_known_filter_state>` for a list of valid object keys.
      string object_key = 1 [(.validate.rules) = { ... }
      Specified by:
      getObjectKeyBytes in interface FilterStateValueOrBuilder
      Returns:
      The bytes for objectKey.

    • getFactoryKey

      public String getFactoryKey()
       Optional filter object factory lookup key. See :ref:`the well-known filter state keys <well_known_filter_state>`
 for a list of valid factory keys.
      string factory_key = 6;
      Specified by:
      getFactoryKey in interface FilterStateValueOrBuilder
      Returns:
      The factoryKey.

    • getFactoryKeyBytes

      public com.google.protobuf.ByteString getFactoryKeyBytes()
       Optional filter object factory lookup key. See :ref:`the well-known filter state keys <well_known_filter_state>`
 for a list of valid factory keys.
      string factory_key = 6;
      Specified by:
      getFactoryKeyBytes in interface FilterStateValueOrBuilder
      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:
      hasFormatString in interface FilterStateValueOrBuilder
      Returns:
      Whether the formatString field is set.

    • getFormatString

      public SubstitutionFormatString 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:
      getFormatString in interface FilterStateValueOrBuilder
      Returns:
      The formatString.

    • getFormatStringOrBuilder

      public SubstitutionFormatStringOrBuilder 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:
      getFormatStringOrBuilder in interface FilterStateValueOrBuilder

    • 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:
      getReadOnly in interface FilterStateValueOrBuilder
      Returns:
      The readOnly.

    • getSharedWithUpstreamValue

      public int getSharedWithUpstreamValue()
       Configures the object to be shared with the upstream internal connections. See :ref:`internal upstream
 transport <config_internal_upstream_transport>` for more details on the filter state sharing with
 the internal connections.
      .envoy.extensions.filters.common.set_filter_state.v3.FilterStateValue.SharedWithUpstream shared_with_upstream = 4;
      Specified by:
      getSharedWithUpstreamValue in interface FilterStateValueOrBuilder
      Returns:
      The enum numeric value on the wire for sharedWithUpstream.

    • getSharedWithUpstream

      public FilterStateValue.SharedWithUpstream getSharedWithUpstream()
       Configures the object to be shared with the upstream internal connections. See :ref:`internal upstream
 transport <config_internal_upstream_transport>` for more details on the filter state sharing with
 the internal connections.
      .envoy.extensions.filters.common.set_filter_state.v3.FilterStateValue.SharedWithUpstream shared_with_upstream = 4;
      Specified by:
      getSharedWithUpstream in interface FilterStateValueOrBuilder
      Returns:
      The sharedWithUpstream.

    • 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:
      getSkipIfEmpty in interface FilterStateValueOrBuilder
      Returns:
      The skipIfEmpty.

    • 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 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

      public static FilterStateValue parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static FilterStateValue parseDelimitedFrom(InputStream input) throws IOException
      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

      public FilterStateValue.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static FilterStateValue.Builder newBuilder()

    • newBuilder

      public static FilterStateValue.Builder newBuilder(FilterStateValue prototype)

    • toBuilder

      public FilterStateValue.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected FilterStateValue.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static FilterStateValue getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FilterStateValue> 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 FilterStateValue getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder