Package io.envoyproxy.envoy.api.v2.route

Class CorsPolicy

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CorsPolicyOrBuilder, Serializable
    public final class CorsPolicy
extends com.google.protobuf.GeneratedMessageV3
implements CorsPolicyOrBuilder
     [#next-free-field: 12]
    Protobuf type envoy.api.v2.route.CorsPolicy
    See Also:
    Serialized Form

    • Field Detail

      • ALLOW_ORIGIN_FIELD_NUMBER

        public static final int ALLOW_ORIGIN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALLOW_ORIGIN_REGEX_FIELD_NUMBER

        public static final int ALLOW_ORIGIN_REGEX_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALLOW_ORIGIN_STRING_MATCH_FIELD_NUMBER

        public static final int ALLOW_ORIGIN_STRING_MATCH_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALLOW_METHODS_FIELD_NUMBER

        public static final int ALLOW_METHODS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALLOW_HEADERS_FIELD_NUMBER

        public static final int ALLOW_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXPOSE_HEADERS_FIELD_NUMBER

        public static final int EXPOSE_HEADERS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALLOW_CREDENTIALS_FIELD_NUMBER

        public static final int ALLOW_CREDENTIALS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FILTER_ENABLED_FIELD_NUMBER

        public static final int FILTER_ENABLED_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SHADOW_ENABLED_FIELD_NUMBER

        public static final int SHADOW_ENABLED_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()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getAllowOriginList

        @Deprecated
public com.google.protobuf.ProtocolStringList getAllowOriginList()
        Deprecated.
        envoy.api.v2.route.CorsPolicy.allow_origin is deprecated. See envoy/api/v2/route/route_components.proto;l=495
         Specifies the origins that will be allowed to do CORS requests.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 .. attention::
  This field has been deprecated in favor of `allow_origin_string_match`.
        repeated string allow_origin = 1 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Specified by:
        getAllowOriginList in interface CorsPolicyOrBuilder
        Returns:
        A list containing the allowOrigin.

      • getAllowOriginCount

        @Deprecated
public int getAllowOriginCount()
        Deprecated.
        envoy.api.v2.route.CorsPolicy.allow_origin is deprecated. See envoy/api/v2/route/route_components.proto;l=495
         Specifies the origins that will be allowed to do CORS requests.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 .. attention::
  This field has been deprecated in favor of `allow_origin_string_match`.
        repeated string allow_origin = 1 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Specified by:
        getAllowOriginCount in interface CorsPolicyOrBuilder
        Returns:
        The count of allowOrigin.

      • getAllowOrigin

        @Deprecated
public String getAllowOrigin​(int index)
        Deprecated.
        envoy.api.v2.route.CorsPolicy.allow_origin is deprecated. See envoy/api/v2/route/route_components.proto;l=495
         Specifies the origins that will be allowed to do CORS requests.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 .. attention::
  This field has been deprecated in favor of `allow_origin_string_match`.
        repeated string allow_origin = 1 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Specified by:
        getAllowOrigin in interface CorsPolicyOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The allowOrigin at the given index.

      • getAllowOriginBytes

        @Deprecated
public com.google.protobuf.ByteString getAllowOriginBytes​(int index)
        Deprecated.
        envoy.api.v2.route.CorsPolicy.allow_origin is deprecated. See envoy/api/v2/route/route_components.proto;l=495
         Specifies the origins that will be allowed to do CORS requests.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 .. attention::
  This field has been deprecated in favor of `allow_origin_string_match`.
        repeated string allow_origin = 1 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Specified by:
        getAllowOriginBytes in interface CorsPolicyOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the allowOrigin at the given index.

      • getAllowOriginRegexList

        @Deprecated
public com.google.protobuf.ProtocolStringList getAllowOriginRegexList()
        Deprecated.
        envoy.api.v2.route.CorsPolicy.allow_origin_regex is deprecated. See envoy/api/v2/route/route_components.proto;l=505
         Specifies regex patterns that match allowed origins.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 .. attention::
   This field has been deprecated in favor of `allow_origin_string_match` as it is not safe for
   use with untrusted input in all cases.
        repeated string allow_origin_regex = 8 [deprecated = true, (.validate.rules) = { ... }
        Specified by:
        getAllowOriginRegexList in interface CorsPolicyOrBuilder
        Returns:
        A list containing the allowOriginRegex.

      • getAllowOriginRegexCount

        @Deprecated
public int getAllowOriginRegexCount()
        Deprecated.
        envoy.api.v2.route.CorsPolicy.allow_origin_regex is deprecated. See envoy/api/v2/route/route_components.proto;l=505
         Specifies regex patterns that match allowed origins.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 .. attention::
   This field has been deprecated in favor of `allow_origin_string_match` as it is not safe for
   use with untrusted input in all cases.
        repeated string allow_origin_regex = 8 [deprecated = true, (.validate.rules) = { ... }
        Specified by:
        getAllowOriginRegexCount in interface CorsPolicyOrBuilder
        Returns:
        The count of allowOriginRegex.

      • getAllowOriginRegex

        @Deprecated
public String getAllowOriginRegex​(int index)
        Deprecated.
        envoy.api.v2.route.CorsPolicy.allow_origin_regex is deprecated. See envoy/api/v2/route/route_components.proto;l=505
         Specifies regex patterns that match allowed origins.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 .. attention::
   This field has been deprecated in favor of `allow_origin_string_match` as it is not safe for
   use with untrusted input in all cases.
        repeated string allow_origin_regex = 8 [deprecated = true, (.validate.rules) = { ... }
        Specified by:
        getAllowOriginRegex in interface CorsPolicyOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The allowOriginRegex at the given index.

      • getAllowOriginRegexBytes

        @Deprecated
public com.google.protobuf.ByteString getAllowOriginRegexBytes​(int index)
        Deprecated.
        envoy.api.v2.route.CorsPolicy.allow_origin_regex is deprecated. See envoy/api/v2/route/route_components.proto;l=505
         Specifies regex patterns that match allowed origins.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 .. attention::
   This field has been deprecated in favor of `allow_origin_string_match` as it is not safe for
   use with untrusted input in all cases.
        repeated string allow_origin_regex = 8 [deprecated = true, (.validate.rules) = { ... }
        Specified by:
        getAllowOriginRegexBytes in interface CorsPolicyOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the allowOriginRegex at the given index.

      • getAllowOriginStringMatchList

        public List<StringMatcher> getAllowOriginStringMatchList()
         Specifies string patterns that match allowed origins. An origin is allowed if any of the
 string matchers match.
        repeated .envoy.type.matcher.StringMatcher allow_origin_string_match = 11;
        Specified by:
        getAllowOriginStringMatchList in interface CorsPolicyOrBuilder

      • getAllowOriginStringMatchCount

        public int getAllowOriginStringMatchCount()
         Specifies string patterns that match allowed origins. An origin is allowed if any of the
 string matchers match.
        repeated .envoy.type.matcher.StringMatcher allow_origin_string_match = 11;
        Specified by:
        getAllowOriginStringMatchCount in interface CorsPolicyOrBuilder

      • getAllowOriginStringMatch

        public StringMatcher getAllowOriginStringMatch​(int index)
         Specifies string patterns that match allowed origins. An origin is allowed if any of the
 string matchers match.
        repeated .envoy.type.matcher.StringMatcher allow_origin_string_match = 11;
        Specified by:
        getAllowOriginStringMatch in interface CorsPolicyOrBuilder

      • getAllowOriginStringMatchOrBuilder

        public StringMatcherOrBuilder getAllowOriginStringMatchOrBuilder​(int index)
         Specifies string patterns that match allowed origins. An origin is allowed if any of the
 string matchers match.
        repeated .envoy.type.matcher.StringMatcher allow_origin_string_match = 11;
        Specified by:
        getAllowOriginStringMatchOrBuilder in interface CorsPolicyOrBuilder

      • getAllowMethods

        public String getAllowMethods()
         Specifies the content for the *access-control-allow-methods* header.
        string allow_methods = 2;
        Specified by:
        getAllowMethods in interface CorsPolicyOrBuilder
        Returns:
        The allowMethods.

      • getAllowMethodsBytes

        public com.google.protobuf.ByteString getAllowMethodsBytes()
         Specifies the content for the *access-control-allow-methods* header.
        string allow_methods = 2;
        Specified by:
        getAllowMethodsBytes in interface CorsPolicyOrBuilder
        Returns:
        The bytes for allowMethods.

      • getAllowHeaders

        public String getAllowHeaders()
         Specifies the content for the *access-control-allow-headers* header.
        string allow_headers = 3;
        Specified by:
        getAllowHeaders in interface CorsPolicyOrBuilder
        Returns:
        The allowHeaders.

      • getAllowHeadersBytes

        public com.google.protobuf.ByteString getAllowHeadersBytes()
         Specifies the content for the *access-control-allow-headers* header.
        string allow_headers = 3;
        Specified by:
        getAllowHeadersBytes in interface CorsPolicyOrBuilder
        Returns:
        The bytes for allowHeaders.

      • getExposeHeaders

        public String getExposeHeaders()
         Specifies the content for the *access-control-expose-headers* header.
        string expose_headers = 4;
        Specified by:
        getExposeHeaders in interface CorsPolicyOrBuilder
        Returns:
        The exposeHeaders.

      • getExposeHeadersBytes

        public com.google.protobuf.ByteString getExposeHeadersBytes()
         Specifies the content for the *access-control-expose-headers* header.
        string expose_headers = 4;
        Specified by:
        getExposeHeadersBytes in interface CorsPolicyOrBuilder
        Returns:
        The bytes for exposeHeaders.

      • getMaxAge

        public String getMaxAge()
         Specifies the content for the *access-control-max-age* header.
        string max_age = 5;
        Specified by:
        getMaxAge in interface CorsPolicyOrBuilder
        Returns:
        The maxAge.

      • getMaxAgeBytes

        public com.google.protobuf.ByteString getMaxAgeBytes()
         Specifies the content for the *access-control-max-age* header.
        string max_age = 5;
        Specified by:
        getMaxAgeBytes in interface CorsPolicyOrBuilder
        Returns:
        The bytes for maxAge.

      • hasAllowCredentials

        public boolean hasAllowCredentials()
         Specifies whether the resource allows credentials.
        .google.protobuf.BoolValue allow_credentials = 6;
        Specified by:
        hasAllowCredentials in interface CorsPolicyOrBuilder
        Returns:
        Whether the allowCredentials field is set.

      • getAllowCredentials

        public com.google.protobuf.BoolValue getAllowCredentials()
         Specifies whether the resource allows credentials.
        .google.protobuf.BoolValue allow_credentials = 6;
        Specified by:
        getAllowCredentials in interface CorsPolicyOrBuilder
        Returns:
        The allowCredentials.

      • getAllowCredentialsOrBuilder

        public com.google.protobuf.BoolValueOrBuilder getAllowCredentialsOrBuilder()
         Specifies whether the resource allows credentials.
        .google.protobuf.BoolValue allow_credentials = 6;
        Specified by:
        getAllowCredentialsOrBuilder in interface CorsPolicyOrBuilder

      • hasEnabled

        @Deprecated
public boolean hasEnabled()
        Deprecated.
        envoy.api.v2.route.CorsPolicy.enabled is deprecated. See envoy/api/v2/route/route_components.proto;l=534
         Specifies if the CORS filter is enabled. Defaults to true. Only effective on route.
 .. attention::
   **This field is deprecated**. Set the
   :ref:`filter_enabled<envoy_api_field_route.CorsPolicy.filter_enabled>` field instead.
        .google.protobuf.BoolValue enabled = 7 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Specified by:
        hasEnabled in interface CorsPolicyOrBuilder
        Returns:
        Whether the enabled field is set.

      • getEnabled

        @Deprecated
public com.google.protobuf.BoolValue getEnabled()
        Deprecated.
        envoy.api.v2.route.CorsPolicy.enabled is deprecated. See envoy/api/v2/route/route_components.proto;l=534
         Specifies if the CORS filter is enabled. Defaults to true. Only effective on route.
 .. attention::
   **This field is deprecated**. Set the
   :ref:`filter_enabled<envoy_api_field_route.CorsPolicy.filter_enabled>` field instead.
        .google.protobuf.BoolValue enabled = 7 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Specified by:
        getEnabled in interface CorsPolicyOrBuilder
        Returns:
        The enabled.

      • getEnabledOrBuilder

        @Deprecated
public com.google.protobuf.BoolValueOrBuilder getEnabledOrBuilder()
        Deprecated.
         Specifies if the CORS filter is enabled. Defaults to true. Only effective on route.
 .. attention::
   **This field is deprecated**. Set the
   :ref:`filter_enabled<envoy_api_field_route.CorsPolicy.filter_enabled>` field instead.
        .google.protobuf.BoolValue enabled = 7 [deprecated = true, (.envoy.annotations.disallowed_by_default) = true];
        Specified by:
        getEnabledOrBuilder in interface CorsPolicyOrBuilder

      • hasFilterEnabled

        public boolean hasFilterEnabled()
         Specifies the % of requests for which the CORS filter is enabled.
 If neither ``enabled``, ``filter_enabled``, nor ``shadow_enabled`` are specified, the CORS
 filter will be enabled for 100% of the requests.
 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.
        .envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9;
        Specified by:
        hasFilterEnabled in interface CorsPolicyOrBuilder
        Returns:
        Whether the filterEnabled field is set.

      • getFilterEnabled

        public RuntimeFractionalPercent getFilterEnabled()
         Specifies the % of requests for which the CORS filter is enabled.
 If neither ``enabled``, ``filter_enabled``, nor ``shadow_enabled`` are specified, the CORS
 filter will be enabled for 100% of the requests.
 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.
        .envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9;
        Specified by:
        getFilterEnabled in interface CorsPolicyOrBuilder
        Returns:
        The filterEnabled.

      • getFilterEnabledOrBuilder

        public RuntimeFractionalPercentOrBuilder getFilterEnabledOrBuilder()
         Specifies the % of requests for which the CORS filter is enabled.
 If neither ``enabled``, ``filter_enabled``, nor ``shadow_enabled`` are specified, the CORS
 filter will be enabled for 100% of the requests.
 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.
        .envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9;
        Specified by:
        getFilterEnabledOrBuilder in interface CorsPolicyOrBuilder

      • hasShadowEnabled

        public boolean hasShadowEnabled()
         Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not
 enforced.
 This field is intended to be used when ``filter_enabled`` and ``enabled`` are off. One of those
 fields have to explicitly disable the filter in order for this setting to take effect.
 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* to determine if it's valid but will not enforce any policies.
        .envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 10;
        Specified by:
        hasShadowEnabled in interface CorsPolicyOrBuilder
        Returns:
        Whether the shadowEnabled field is set.

      • getShadowEnabled

        public RuntimeFractionalPercent getShadowEnabled()
         Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not
 enforced.
 This field is intended to be used when ``filter_enabled`` and ``enabled`` are off. One of those
 fields have to explicitly disable the filter in order for this setting to take effect.
 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* to determine if it's valid but will not enforce any policies.
        .envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 10;
        Specified by:
        getShadowEnabled in interface CorsPolicyOrBuilder
        Returns:
        The shadowEnabled.

      • getShadowEnabledOrBuilder

        public RuntimeFractionalPercentOrBuilder getShadowEnabledOrBuilder()
         Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not
 enforced.
 This field is intended to be used when ``filter_enabled`` and ``enabled`` are off. One of those
 fields have to explicitly disable the filter in order for this setting to take effect.
 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* to determine if it's valid but will not enforce any policies.
        .envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 10;
        Specified by:
        getShadowEnabledOrBuilder in interface CorsPolicyOrBuilder

      • 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 CorsPolicy parseFrom​(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CorsPolicy parseFrom​(ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CorsPolicy parseFrom​(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CorsPolicy parseFrom​(com.google.protobuf.ByteString data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CorsPolicy parseFrom​(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CorsPolicy parseFrom​(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CorsPolicy parseFrom​(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static CorsPolicy getDefaultInstance()

      • parser

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

      • getParserForType

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