Package io.envoyproxy.envoy.config.filter.http.csrf.v2

Class CsrfPolicy.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CsrfPolicyOrBuilder, Cloneable
    Enclosing class:
    CsrfPolicy
    public static final class CsrfPolicy.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<CsrfPolicy.Builder>
implements CsrfPolicyOrBuilder
     CSRF filter config.
    Protobuf type envoy.config.filter.http.csrf.v2.CsrfPolicy

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

      • clear

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

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

      • clearField

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

      • clearOneof

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • isInitialized

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

      • mergeFrom

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

      • hasFilterEnabled

        public boolean hasFilterEnabled()
         Specifies the % of requests for which the CSRF filter is enabled.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests to filter.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
        .envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }
        Specified by:
        hasFilterEnabled in interface CsrfPolicyOrBuilder
        Returns:
        Whether the filterEnabled field is set.

      • getFilterEnabled

        public RuntimeFractionalPercent getFilterEnabled()
         Specifies the % of requests for which the CSRF filter is enabled.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests to filter.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
        .envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }
        Specified by:
        getFilterEnabled in interface CsrfPolicyOrBuilder
        Returns:
        The filterEnabled.

      • setFilterEnabled

        public CsrfPolicy.Builder setFilterEnabled​(RuntimeFractionalPercent value)
         Specifies the % of requests for which the CSRF filter is enabled.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests to filter.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
        .envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }

      • setFilterEnabled

        public CsrfPolicy.Builder setFilterEnabled​(RuntimeFractionalPercent.Builder builderForValue)
         Specifies the % of requests for which the CSRF filter is enabled.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests to filter.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
        .envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }

      • mergeFilterEnabled

        public CsrfPolicy.Builder mergeFilterEnabled​(RuntimeFractionalPercent value)
         Specifies the % of requests for which the CSRF filter is enabled.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests to filter.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
        .envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }

      • clearFilterEnabled

        public CsrfPolicy.Builder clearFilterEnabled()
         Specifies the % of requests for which the CSRF filter is enabled.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests to filter.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
        .envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }

      • getFilterEnabledBuilder

        public RuntimeFractionalPercent.Builder getFilterEnabledBuilder()
         Specifies the % of requests for which the CSRF filter is enabled.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests to filter.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
        .envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }

      • getFilterEnabledOrBuilder

        public RuntimeFractionalPercentOrBuilder getFilterEnabledOrBuilder()
         Specifies the % of requests for which the CSRF filter is enabled.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests to filter.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
        .envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }
        Specified by:
        getFilterEnabledOrBuilder in interface CsrfPolicyOrBuilder

      • hasShadowEnabled

        public boolean hasShadowEnabled()
         Specifies that CSRF policies will be evaluated and tracked, but not enforced.
 This is intended to be used when ``filter_enabled`` is off and will be ignored otherwise.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
 and track the request's *Origin* and *Destination* to determine if it's valid, but will not
 enforce any policies.
        .envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 2;
        Specified by:
        hasShadowEnabled in interface CsrfPolicyOrBuilder
        Returns:
        Whether the shadowEnabled field is set.

      • getShadowEnabled

        public RuntimeFractionalPercent getShadowEnabled()
         Specifies that CSRF policies will be evaluated and tracked, but not enforced.
 This is intended to be used when ``filter_enabled`` is off and will be ignored otherwise.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
 and track the request's *Origin* and *Destination* to determine if it's valid, but will not
 enforce any policies.
        .envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 2;
        Specified by:
        getShadowEnabled in interface CsrfPolicyOrBuilder
        Returns:
        The shadowEnabled.

      • setShadowEnabled

        public CsrfPolicy.Builder setShadowEnabled​(RuntimeFractionalPercent value)
         Specifies that CSRF policies will be evaluated and tracked, but not enforced.
 This is intended to be used when ``filter_enabled`` is off and will be ignored otherwise.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
 and track the request's *Origin* and *Destination* to determine if it's valid, but will not
 enforce any policies.
        .envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 2;

      • setShadowEnabled

        public CsrfPolicy.Builder setShadowEnabled​(RuntimeFractionalPercent.Builder builderForValue)
         Specifies that CSRF policies will be evaluated and tracked, but not enforced.
 This is intended to be used when ``filter_enabled`` is off and will be ignored otherwise.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
 and track the request's *Origin* and *Destination* to determine if it's valid, but will not
 enforce any policies.
        .envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 2;

      • mergeShadowEnabled

        public CsrfPolicy.Builder mergeShadowEnabled​(RuntimeFractionalPercent value)
         Specifies that CSRF policies will be evaluated and tracked, but not enforced.
 This is intended to be used when ``filter_enabled`` is off and will be ignored otherwise.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
 and track the request's *Origin* and *Destination* to determine if it's valid, but will not
 enforce any policies.
        .envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 2;

      • clearShadowEnabled

        public CsrfPolicy.Builder clearShadowEnabled()
         Specifies that CSRF policies will be evaluated and tracked, but not enforced.
 This is intended to be used when ``filter_enabled`` is off and will be ignored otherwise.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
 and track the request's *Origin* and *Destination* to determine if it's valid, but will not
 enforce any policies.
        .envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 2;

      • getShadowEnabledBuilder

        public RuntimeFractionalPercent.Builder getShadowEnabledBuilder()
         Specifies that CSRF policies will be evaluated and tracked, but not enforced.
 This is intended to be used when ``filter_enabled`` is off and will be ignored otherwise.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
 and track the request's *Origin* and *Destination* to determine if it's valid, but will not
 enforce any policies.
        .envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 2;

      • getShadowEnabledOrBuilder

        public RuntimeFractionalPercentOrBuilder getShadowEnabledOrBuilder()
         Specifies that CSRF policies will be evaluated and tracked, but not enforced.
 This is intended to be used when ``filter_enabled`` is off and will be ignored otherwise.
 If :ref:`runtime_key <envoy_api_field_core.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
 and track the request's *Origin* and *Destination* to determine if it's valid, but will not
 enforce any policies.
        .envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 2;
        Specified by:
        getShadowEnabledOrBuilder in interface CsrfPolicyOrBuilder

      • getAdditionalOriginsList

        public List<StringMatcher> getAdditionalOriginsList()
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;
        Specified by:
        getAdditionalOriginsList in interface CsrfPolicyOrBuilder

      • getAdditionalOriginsCount

        public int getAdditionalOriginsCount()
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;
        Specified by:
        getAdditionalOriginsCount in interface CsrfPolicyOrBuilder

      • getAdditionalOrigins

        public StringMatcher getAdditionalOrigins​(int index)
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;
        Specified by:
        getAdditionalOrigins in interface CsrfPolicyOrBuilder

      • setAdditionalOrigins

        public CsrfPolicy.Builder setAdditionalOrigins​(int index,
                                               StringMatcher value)
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;

      • setAdditionalOrigins

        public CsrfPolicy.Builder setAdditionalOrigins​(int index,
                                               StringMatcher.Builder builderForValue)
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;

      • addAdditionalOrigins

        public CsrfPolicy.Builder addAdditionalOrigins​(StringMatcher value)
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;

      • addAdditionalOrigins

        public CsrfPolicy.Builder addAdditionalOrigins​(int index,
                                               StringMatcher value)
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;

      • addAdditionalOrigins

        public CsrfPolicy.Builder addAdditionalOrigins​(StringMatcher.Builder builderForValue)
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;

      • addAdditionalOrigins

        public CsrfPolicy.Builder addAdditionalOrigins​(int index,
                                               StringMatcher.Builder builderForValue)
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;

      • addAllAdditionalOrigins

        public CsrfPolicy.Builder addAllAdditionalOrigins​(Iterable<? extends StringMatcher> values)
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;

      • clearAdditionalOrigins

        public CsrfPolicy.Builder clearAdditionalOrigins()
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;

      • removeAdditionalOrigins

        public CsrfPolicy.Builder removeAdditionalOrigins​(int index)
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;

      • getAdditionalOriginsBuilder

        public StringMatcher.Builder getAdditionalOriginsBuilder​(int index)
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;

      • getAdditionalOriginsOrBuilder

        public StringMatcherOrBuilder getAdditionalOriginsOrBuilder​(int index)
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;
        Specified by:
        getAdditionalOriginsOrBuilder in interface CsrfPolicyOrBuilder

      • getAdditionalOriginsOrBuilderList

        public List<? extends StringMatcherOrBuilder> getAdditionalOriginsOrBuilderList()
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;
        Specified by:
        getAdditionalOriginsOrBuilderList in interface CsrfPolicyOrBuilder

      • addAdditionalOriginsBuilder

        public StringMatcher.Builder addAdditionalOriginsBuilder()
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;

      • addAdditionalOriginsBuilder

        public StringMatcher.Builder addAdditionalOriginsBuilder​(int index)
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;

      • getAdditionalOriginsBuilderList

        public List<StringMatcher.Builder> getAdditionalOriginsBuilderList()
         Specifies additional source origins that will be allowed in addition to
 the destination origin.
 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
        repeated .envoy.type.matcher.StringMatcher additional_origins = 3;

      • setUnknownFields

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

      • mergeUnknownFields

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