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

Interface CorsPolicyOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    CorsPolicy, CorsPolicy.Builder
    public interface CorsPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getAllowOriginList

        @Deprecated
List<String> 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];
        Returns:
        A list containing the allowOrigin.

      • getAllowOriginCount

        @Deprecated
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];
        Returns:
        The count of allowOrigin.

      • getAllowOrigin

        @Deprecated
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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The allowOrigin at the given index.

      • getAllowOriginBytes

        @Deprecated
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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the allowOrigin at the given index.

      • getAllowOriginRegexList

        @Deprecated
List<String> 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) = { ... }
        Returns:
        A list containing the allowOriginRegex.

      • getAllowOriginRegexCount

        @Deprecated
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) = { ... }
        Returns:
        The count of allowOriginRegex.

      • getAllowOriginRegex

        @Deprecated
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) = { ... }
        Parameters:
        index - The index of the element to return.
        Returns:
        The allowOriginRegex at the given index.

      • getAllowOriginRegexBytes

        @Deprecated
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) = { ... }
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the allowOriginRegex at the given index.

      • getAllowOriginStringMatchList

        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;

      • getAllowOriginStringMatch

        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;

      • getAllowOriginStringMatchCount

        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;

      • getAllowOriginStringMatchOrBuilderList

        List<? extends StringMatcherOrBuilder> getAllowOriginStringMatchOrBuilderList()
         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;

      • getAllowOriginStringMatchOrBuilder

        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;

      • getAllowMethods

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

      • getAllowMethodsBytes

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

      • getAllowHeaders

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

      • getAllowHeadersBytes

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

      • getExposeHeaders

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

      • getExposeHeadersBytes

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

      • getMaxAge

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

      • getMaxAgeBytes

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

      • hasAllowCredentials

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

      • getAllowCredentials

        com.google.protobuf.BoolValue getAllowCredentials()
         Specifies whether the resource allows credentials.
        .google.protobuf.BoolValue allow_credentials = 6;
        Returns:
        The allowCredentials.

      • getAllowCredentialsOrBuilder

        com.google.protobuf.BoolValueOrBuilder getAllowCredentialsOrBuilder()
         Specifies whether the resource allows credentials.
        .google.protobuf.BoolValue allow_credentials = 6;

      • hasEnabled

        @Deprecated
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];
        Returns:
        Whether the enabled field is set.

      • getEnabled

        @Deprecated
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];
        Returns:
        The enabled.

      • getEnabledOrBuilder

        @Deprecated
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];

      • hasFilterEnabled

        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;
        Returns:
        Whether the filterEnabled field is set.

      • getFilterEnabled

        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;
        Returns:
        The filterEnabled.

      • getFilterEnabledOrBuilder

        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;

      • hasShadowEnabled

        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;
        Returns:
        Whether the shadowEnabled field is set.

      • getShadowEnabled

        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;
        Returns:
        The shadowEnabled.

      • getShadowEnabledOrBuilder

        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;