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 Summary

Modifier and Type	Method and Description
com.google.protobuf.BoolValue	getAllowCredentials() Specifies whether the resource allows credentials.
com.google.protobuf.BoolValueOrBuilder	getAllowCredentialsOrBuilder() Specifies whether the resource allows credentials.
String	getAllowHeaders() Specifies the content for the *access-control-allow-headers* header.
com.google.protobuf.ByteString	getAllowHeadersBytes() Specifies the content for the *access-control-allow-headers* header.
String	getAllowMethods() Specifies the content for the *access-control-allow-methods* header.
com.google.protobuf.ByteString	getAllowMethodsBytes() Specifies the content for the *access-control-allow-methods* header.
String	getAllowOrigin(int index) Deprecated.
com.google.protobuf.ByteString	getAllowOriginBytes(int index) Deprecated.
int	getAllowOriginCount() Deprecated.
List<String>	getAllowOriginList() Deprecated.
String	getAllowOriginRegex(int index) Deprecated.
com.google.protobuf.ByteString	getAllowOriginRegexBytes(int index) Deprecated.
int	getAllowOriginRegexCount() Deprecated.
List<String>	getAllowOriginRegexList() Deprecated.
StringMatcher	getAllowOriginStringMatch(int index) Specifies string patterns that match allowed origins.
int	getAllowOriginStringMatchCount() Specifies string patterns that match allowed origins.
List<StringMatcher>	getAllowOriginStringMatchList() Specifies string patterns that match allowed origins.
StringMatcherOrBuilder	getAllowOriginStringMatchOrBuilder(int index) Specifies string patterns that match allowed origins.
List<? extends StringMatcherOrBuilder>	getAllowOriginStringMatchOrBuilderList() Specifies string patterns that match allowed origins.
com.google.protobuf.BoolValue	getEnabled() Deprecated.
com.google.protobuf.BoolValueOrBuilder	getEnabledOrBuilder() Deprecated.
CorsPolicy.EnabledSpecifierCase	getEnabledSpecifierCase()
String	getExposeHeaders() Specifies the content for the *access-control-expose-headers* header.
com.google.protobuf.ByteString	getExposeHeadersBytes() Specifies the content for the *access-control-expose-headers* header.
RuntimeFractionalPercent	getFilterEnabled() Specifies the % of requests for which the CORS filter is enabled.
RuntimeFractionalPercentOrBuilder	getFilterEnabledOrBuilder() Specifies the % of requests for which the CORS filter is enabled.
String	getMaxAge() Specifies the content for the *access-control-max-age* header.
com.google.protobuf.ByteString	getMaxAgeBytes() Specifies the content for the *access-control-max-age* header.
RuntimeFractionalPercent	getShadowEnabled() Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not enforced.
RuntimeFractionalPercentOrBuilder	getShadowEnabledOrBuilder() Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not enforced.
boolean	hasAllowCredentials() Specifies whether the resource allows credentials.
boolean	hasEnabled() Deprecated.
boolean	hasFilterEnabled() Specifies the % of requests for which the CORS filter is enabled.
boolean	hasShadowEnabled() Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not enforced.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getAllowOriginList

@Deprecated
List<String> getAllowOriginList()

Deprecated.

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

getAllowOriginCount

@Deprecated
int getAllowOriginCount()

Deprecated.

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

getAllowOrigin

@Deprecated
String getAllowOrigin(int index)

Deprecated.

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

getAllowOriginBytes

@Deprecated
com.google.protobuf.ByteString getAllowOriginBytes(int index)

Deprecated.

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

getAllowOriginRegexList

@Deprecated
List<String> getAllowOriginRegexList()

Deprecated.

 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) = { ... }

getAllowOriginRegexCount

@Deprecated
int getAllowOriginRegexCount()

Deprecated.

 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) = { ... }

getAllowOriginRegex

@Deprecated
String getAllowOriginRegex(int index)

Deprecated.

 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) = { ... }

getAllowOriginRegexBytes

@Deprecated
com.google.protobuf.ByteString getAllowOriginRegexBytes(int index)

Deprecated.

 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) = { ... }

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;

getAllowMethodsBytes

com.google.protobuf.ByteString getAllowMethodsBytes()

 Specifies the content for the *access-control-allow-methods* header.
 

string allow_methods = 2;

getAllowHeaders

String getAllowHeaders()

 Specifies the content for the *access-control-allow-headers* header.
 

string allow_headers = 3;

getAllowHeadersBytes

com.google.protobuf.ByteString getAllowHeadersBytes()

 Specifies the content for the *access-control-allow-headers* header.
 

string allow_headers = 3;

getExposeHeaders

String getExposeHeaders()

 Specifies the content for the *access-control-expose-headers* header.
 

string expose_headers = 4;

getExposeHeadersBytes

com.google.protobuf.ByteString getExposeHeadersBytes()

 Specifies the content for the *access-control-expose-headers* header.
 

string expose_headers = 4;

getMaxAge

String getMaxAge()

 Specifies the content for the *access-control-max-age* header.
 

string max_age = 5;

getMaxAgeBytes

com.google.protobuf.ByteString getMaxAgeBytes()

 Specifies the content for the *access-control-max-age* header.
 

string max_age = 5;

hasAllowCredentials

boolean hasAllowCredentials()

 Specifies whether the resource allows credentials.
 

.google.protobuf.BoolValue allow_credentials = 6;

getAllowCredentials

com.google.protobuf.BoolValue getAllowCredentials()

 Specifies whether the resource allows credentials.
 

.google.protobuf.BoolValue allow_credentials = 6;

getAllowCredentialsOrBuilder

com.google.protobuf.BoolValueOrBuilder getAllowCredentialsOrBuilder()

 Specifies whether the resource allows credentials.
 

.google.protobuf.BoolValue allow_credentials = 6;

hasEnabled

@Deprecated
boolean hasEnabled()

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

getEnabled

@Deprecated
com.google.protobuf.BoolValue getEnabled()

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

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;

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;

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;

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;

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;

getEnabledSpecifierCase

CorsPolicy.EnabledSpecifierCase getEnabledSpecifierCase()