io.envoyproxy.envoy.config.route.v3

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

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.v3.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.v3.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.v3.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.v3.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.v3.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;

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_config.core.v3.RuntimeFractionalPercent.runtime_key>` is
 specified, Envoy will lookup the runtime key to get the percentage of requests to filter.
 

.envoy.config.core.v3.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_config.core.v3.RuntimeFractionalPercent.runtime_key>` is
 specified, Envoy will lookup the runtime key to get the percentage of requests to filter.
 

.envoy.config.core.v3.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_config.core.v3.RuntimeFractionalPercent.runtime_key>` is
 specified, Envoy will lookup the runtime key to get the percentage of requests to filter.
 

.envoy.config.core.v3.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_config.core.v3.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.config.core.v3.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_config.core.v3.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.config.core.v3.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_config.core.v3.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.config.core.v3.RuntimeFractionalPercent shadow_enabled = 10;

getEnabledSpecifierCase

CorsPolicy.EnabledSpecifierCase getEnabledSpecifierCase()