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

Class FilterStateValue.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, FilterStateValueOrBuilder, Cloneable
    Enclosing class:
    FilterStateValue
    public static final class FilterStateValue.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FilterStateValue.Builder>
implements FilterStateValueOrBuilder
     A filter state key and value pair.
 [#next-free-field: 6]
    Protobuf type envoy.extensions.filters.common.set_filter_state.v3.FilterStateValue

    • 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<FilterStateValue.Builder>

      • clear

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

      • getDefaultInstanceForType

        public FilterStateValue getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FilterStateValue.Builder>

      • mergeFrom

        public FilterStateValue.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<FilterStateValue.Builder>
        Throws:
        IOException

      • hasObjectKey

        public boolean hasObjectKey()
         Filter state object key. The key is expected to be registered via an object factory, see
 :ref:`the well-known filter state keys <well_known_filter_state>`.
        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 expected to be registered via an object factory, see
 :ref:`the well-known filter state keys <well_known_filter_state>`.
        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 expected to be registered via an object factory, see
 :ref:`the well-known filter state keys <well_known_filter_state>`.
        string object_key = 1 [(.validate.rules) = { ... }
        Specified by:
        getObjectKeyBytes in interface FilterStateValueOrBuilder
        Returns:
        The bytes for objectKey.

      • setObjectKey

        public FilterStateValue.Builder setObjectKey​(String value)
         Filter state object key. The key is expected to be registered via an object factory, see
 :ref:`the well-known filter state keys <well_known_filter_state>`.
        string object_key = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The objectKey to set.
        Returns:
        This builder for chaining.

      • clearObjectKey

        public FilterStateValue.Builder clearObjectKey()
         Filter state object key. The key is expected to be registered via an object factory, see
 :ref:`the well-known filter state keys <well_known_filter_state>`.
        string object_key = 1 [(.validate.rules) = { ... }
        Returns:
        This builder for chaining.

      • setObjectKeyBytes

        public FilterStateValue.Builder setObjectKeyBytes​(com.google.protobuf.ByteString value)
         Filter state object key. The key is expected to be registered via an object factory, see
 :ref:`the well-known filter state keys <well_known_filter_state>`.
        string object_key = 1 [(.validate.rules) = { ... }
        Parameters:
        value - The bytes for objectKey to set.
        Returns:
        This builder for chaining.

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

      • setFormatString

        public FilterStateValue.Builder setFormatString​(SubstitutionFormatString value)
         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;

      • setFormatString

        public FilterStateValue.Builder setFormatString​(SubstitutionFormatString.Builder builderForValue)
         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;

      • mergeFormatString

        public FilterStateValue.Builder mergeFormatString​(SubstitutionFormatString value)
         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;

      • clearFormatString

        public FilterStateValue.Builder clearFormatString()
         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;

      • getFormatStringBuilder

        public SubstitutionFormatString.Builder getFormatStringBuilder()
         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;

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

      • setReadOnly

        public FilterStateValue.Builder setReadOnly​(boolean value)
         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;
        Parameters:
        value - The readOnly to set.
        Returns:
        This builder for chaining.

      • clearReadOnly

        public FilterStateValue.Builder clearReadOnly()
         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;
        Returns:
        This builder for chaining.

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

      • setSharedWithUpstreamValue

        public FilterStateValue.Builder setSharedWithUpstreamValue​(int value)
         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;
        Parameters:
        value - The enum numeric value on the wire for sharedWithUpstream to set.
        Returns:
        This builder for chaining.

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

      • setSharedWithUpstream

        public FilterStateValue.Builder setSharedWithUpstream​(FilterStateValue.SharedWithUpstream value)
         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;
        Parameters:
        value - The sharedWithUpstream to set.
        Returns:
        This builder for chaining.

      • clearSharedWithUpstream

        public FilterStateValue.Builder clearSharedWithUpstream()
         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;
        Returns:
        This builder for chaining.

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

      • setSkipIfEmpty

        public FilterStateValue.Builder setSkipIfEmpty​(boolean value)
         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;
        Parameters:
        value - The skipIfEmpty to set.
        Returns:
        This builder for chaining.

      • clearSkipIfEmpty

        public FilterStateValue.Builder clearSkipIfEmpty()
         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;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final FilterStateValue.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<FilterStateValue.Builder>

      • mergeUnknownFields

        public final FilterStateValue.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<FilterStateValue.Builder>