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 TypeMethodDescriptioncom.google.protobuf.BoolValue
Specifies whether the resource allows credentials.com.google.protobuf.BoolValueOrBuilder
Specifies whether the resource allows credentials.Specifies the content for the ``access-control-allow-headers`` header.com.google.protobuf.ByteString
Specifies the content for the ``access-control-allow-headers`` header.Specifies the content for the ``access-control-allow-methods`` header.com.google.protobuf.ByteString
Specifies the content for the ``access-control-allow-methods`` header.getAllowOriginStringMatch
(int index) Specifies string patterns that match allowed origins.int
Specifies string patterns that match allowed origins.Specifies string patterns that match allowed origins.getAllowOriginStringMatchOrBuilder
(int index) Specifies string patterns that match allowed origins.List
<? extends StringMatcherOrBuilder> Specifies string patterns that match allowed origins.com.google.protobuf.BoolValue
Specify whether allow requests whose target server's IP address is more private than that from which the request initiator was fetched.com.google.protobuf.BoolValueOrBuilder
Specify whether allow requests whose target server's IP address is more private than that from which the request initiator was fetched.Specifies the content for the ``access-control-expose-headers`` header.com.google.protobuf.ByteString
Specifies the content for the ``access-control-expose-headers`` header.Specifies the % of requests for which the CORS filter is enabled.Specifies the % of requests for which the CORS filter is enabled.com.google.protobuf.BoolValue
Specifies if preflight requests not matching the configured allowed origin should be forwarded to the upstream.com.google.protobuf.BoolValueOrBuilder
Specifies if preflight requests not matching the configured allowed origin should be forwarded to the upstream.Specifies the content for the ``access-control-max-age`` header.com.google.protobuf.ByteString
Specifies the content for the ``access-control-max-age`` header.Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not enforced.Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not enforced.boolean
Specifies whether the resource allows credentials.boolean
Specify whether allow requests whose target server's IP address is more private than that from which the request initiator was fetched.boolean
Specifies the % of requests for which the CORS filter is enabled.boolean
Specifies if preflight requests not matching the configured allowed origin should be forwarded to the upstream.boolean
Specifies the % of requests for which the CORS policies will be evaluated and tracked, but not enforced.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
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
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
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;
- 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;
-
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_v3_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;
- 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_v3_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;
- 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_v3_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_v3_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;
- 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_v3_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;
- 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_v3_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;
-
hasAllowPrivateNetworkAccess
boolean hasAllowPrivateNetworkAccess()Specify whether allow requests whose target server's IP address is more private than that from which the request initiator was fetched. More details refer to https://developer.chrome.com/blog/private-network-access-preflight.
.google.protobuf.BoolValue allow_private_network_access = 12;
- Returns:
- Whether the allowPrivateNetworkAccess field is set.
-
getAllowPrivateNetworkAccess
com.google.protobuf.BoolValue getAllowPrivateNetworkAccess()Specify whether allow requests whose target server's IP address is more private than that from which the request initiator was fetched. More details refer to https://developer.chrome.com/blog/private-network-access-preflight.
.google.protobuf.BoolValue allow_private_network_access = 12;
- Returns:
- The allowPrivateNetworkAccess.
-
getAllowPrivateNetworkAccessOrBuilder
com.google.protobuf.BoolValueOrBuilder getAllowPrivateNetworkAccessOrBuilder()Specify whether allow requests whose target server's IP address is more private than that from which the request initiator was fetched. More details refer to https://developer.chrome.com/blog/private-network-access-preflight.
.google.protobuf.BoolValue allow_private_network_access = 12;
-
hasForwardNotMatchingPreflights
boolean hasForwardNotMatchingPreflights()Specifies if preflight requests not matching the configured allowed origin should be forwarded to the upstream. Default is true.
.google.protobuf.BoolValue forward_not_matching_preflights = 13;
- Returns:
- Whether the forwardNotMatchingPreflights field is set.
-
getForwardNotMatchingPreflights
com.google.protobuf.BoolValue getForwardNotMatchingPreflights()Specifies if preflight requests not matching the configured allowed origin should be forwarded to the upstream. Default is true.
.google.protobuf.BoolValue forward_not_matching_preflights = 13;
- Returns:
- The forwardNotMatchingPreflights.
-
getForwardNotMatchingPreflightsOrBuilder
com.google.protobuf.BoolValueOrBuilder getForwardNotMatchingPreflightsOrBuilder()Specifies if preflight requests not matching the configured allowed origin should be forwarded to the upstream. Default is true.
.google.protobuf.BoolValue forward_not_matching_preflights = 13;
-
getEnabledSpecifierCase
CorsPolicy.EnabledSpecifierCase getEnabledSpecifierCase()
-