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) Specifies the origins that will be allowed to do CORS requests.
com.google.protobuf.ByteString	getAllowOriginBytes(int index) Specifies the origins that will be allowed to do CORS requests.
int	getAllowOriginCount() Specifies the origins that will be allowed to do CORS requests.
List<String>	getAllowOriginList() Specifies the origins that will be allowed to do CORS requests.
String	getAllowOriginRegex(int index) Specifies regex patterns that match allowed origins.
com.google.protobuf.ByteString	getAllowOriginRegexBytes(int index) Specifies regex patterns that match allowed origins.
int	getAllowOriginRegexCount() Specifies regex patterns that match allowed origins.
List<String>	getAllowOriginRegexList() Specifies regex 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 if CORS is enabled.
RuntimeFractionalPercentOrBuilder	getFilterEnabledOrBuilder() Specifies if CORS 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 if CORS policies are evaluated and tracked when filter is off but does not enforce any policies.
RuntimeFractionalPercentOrBuilder	getShadowEnabledOrBuilder() Specifies if CORS policies are evaluated and tracked when filter is off but does not enforce any policies.
boolean	hasAllowCredentials() Specifies whether the resource allows credentials.
boolean	hasEnabled() Deprecated.
boolean	hasFilterEnabled() Specifies if CORS is enabled.
boolean	hasShadowEnabled() Specifies if CORS policies are evaluated and tracked when filter is off but does not enforce any policies.

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

List<String> getAllowOriginList()

 Specifies the origins that will be allowed to do CORS requests.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 

repeated string allow_origin = 1;

getAllowOriginCount

int getAllowOriginCount()

 Specifies the origins that will be allowed to do CORS requests.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 

repeated string allow_origin = 1;

getAllowOrigin

String getAllowOrigin(int index)

 Specifies the origins that will be allowed to do CORS requests.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 

repeated string allow_origin = 1;

getAllowOriginBytes

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

 Specifies the origins that will be allowed to do CORS requests.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 

repeated string allow_origin = 1;

getAllowOriginRegexList

List<String> getAllowOriginRegexList()

 Specifies regex patterns that match allowed origins.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 

repeated string allow_origin_regex = 8 [(.validate.rules) = { ... }

getAllowOriginRegexCount

int getAllowOriginRegexCount()

 Specifies regex patterns that match allowed origins.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 

repeated string allow_origin_regex = 8 [(.validate.rules) = { ... }

getAllowOriginRegex

String getAllowOriginRegex(int index)

 Specifies regex patterns that match allowed origins.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 

repeated string allow_origin_regex = 8 [(.validate.rules) = { ... }

getAllowOriginRegexBytes

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

 Specifies regex patterns that match allowed origins.
 An origin is allowed if either allow_origin or allow_origin_regex match.
 

repeated string allow_origin_regex = 8 [(.validate.rules) = { ... }

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

getEnabled

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

Deprecated.

 Specifies if CORS 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];

getEnabledOrBuilder

@Deprecated
com.google.protobuf.BoolValueOrBuilder getEnabledOrBuilder()

Deprecated.

 Specifies if CORS 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];

hasFilterEnabled

boolean hasFilterEnabled()

 Specifies if CORS is enabled.
 More information on how this can be controlled via runtime can be found
 :ref:`here <cors-runtime>`.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
 

.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9;

getFilterEnabled

RuntimeFractionalPercent getFilterEnabled()

 Specifies if CORS is enabled.
 More information on how this can be controlled via runtime can be found
 :ref:`here <cors-runtime>`.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
 

.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9;

getFilterEnabledOrBuilder

RuntimeFractionalPercentOrBuilder getFilterEnabledOrBuilder()

 Specifies if CORS is enabled.
 More information on how this can be controlled via runtime can be found
 :ref:`here <cors-runtime>`.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
 

.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 9;

hasShadowEnabled

boolean hasShadowEnabled()

 Specifies if CORS policies are evaluated and tracked when filter is off but
 does not enforce any policies.
 More information on how this can be controlled via runtime can be found
 :ref:`here <cors-runtime>`.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
 

.envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 10;

getShadowEnabled

RuntimeFractionalPercent getShadowEnabled()

 Specifies if CORS policies are evaluated and tracked when filter is off but
 does not enforce any policies.
 More information on how this can be controlled via runtime can be found
 :ref:`here <cors-runtime>`.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
 

.envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 10;

getShadowEnabledOrBuilder

RuntimeFractionalPercentOrBuilder getShadowEnabledOrBuilder()

 Specifies if CORS policies are evaluated and tracked when filter is off but
 does not enforce any policies.
 More information on how this can be controlled via runtime can be found
 :ref:`here <cors-runtime>`.
 .. note::
   This field defaults to 100/:ref:`HUNDRED
   <envoy_api_enum_type.FractionalPercent.DenominatorType>`.
 

.envoy.api.v2.core.RuntimeFractionalPercent shadow_enabled = 10;

getEnabledSpecifierCase

CorsPolicy.EnabledSpecifierCase getEnabledSpecifierCase()