Interface CorsPolicyOrBuilder (1.20.0)

Version 1.20.0

• 1.62.0 (latest)
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public interface CorsPolicyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAllowCredentials()

public abstract boolean getAllowCredentials()

In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false.

optional bool allow_credentials = 481263366;

Returns

Type	Description
boolean	The allowCredentials.

getAllowHeaders(int index)

public abstract String getAllowHeaders(int index)

Specifies the content for the Access-Control-Allow-Headers header.

repeated string allow_headers = 45179024;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The allowHeaders at the given index.

getAllowHeadersBytes(int index)

public abstract ByteString getAllowHeadersBytes(int index)

Specifies the content for the Access-Control-Allow-Headers header.

repeated string allow_headers = 45179024;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the allowHeaders at the given index.

getAllowHeadersCount()

public abstract int getAllowHeadersCount()

Specifies the content for the Access-Control-Allow-Headers header.

repeated string allow_headers = 45179024;

Returns

Type	Description
int	The count of allowHeaders.

getAllowHeadersList()

public abstract List<String> getAllowHeadersList()

Specifies the content for the Access-Control-Allow-Headers header.

repeated string allow_headers = 45179024;

Returns

Type	Description
List<String>	A list containing the allowHeaders.

getAllowMethods(int index)

public abstract String getAllowMethods(int index)

Specifies the content for the Access-Control-Allow-Methods header.

repeated string allow_methods = 205405372;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The allowMethods at the given index.

getAllowMethodsBytes(int index)

public abstract ByteString getAllowMethodsBytes(int index)

Specifies the content for the Access-Control-Allow-Methods header.

repeated string allow_methods = 205405372;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the allowMethods at the given index.

getAllowMethodsCount()

public abstract int getAllowMethodsCount()

Specifies the content for the Access-Control-Allow-Methods header.

repeated string allow_methods = 205405372;

Returns

Type	Description
int	The count of allowMethods.

getAllowMethodsList()

public abstract List<String> getAllowMethodsList()

Specifies the content for the Access-Control-Allow-Methods header.

repeated string allow_methods = 205405372;

Returns

Type	Description
List<String>	A list containing the allowMethods.

getAllowOriginRegexes(int index)

public abstract String getAllowOriginRegexes(int index)

Specifies a regular expression that matches allowed origins. For more information about the regular expression syntax, see Syntax. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

repeated string allow_origin_regexes = 215385810;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The allowOriginRegexes at the given index.

getAllowOriginRegexesBytes(int index)

public abstract ByteString getAllowOriginRegexesBytes(int index)

Specifies a regular expression that matches allowed origins. For more information about the regular expression syntax, see Syntax. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

repeated string allow_origin_regexes = 215385810;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the allowOriginRegexes at the given index.

getAllowOriginRegexesCount()

public abstract int getAllowOriginRegexesCount()

Specifies a regular expression that matches allowed origins. For more information about the regular expression syntax, see Syntax. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

repeated string allow_origin_regexes = 215385810;

Returns

Type	Description
int	The count of allowOriginRegexes.

getAllowOriginRegexesList()

public abstract List<String> getAllowOriginRegexesList()

Specifies a regular expression that matches allowed origins. For more information about the regular expression syntax, see Syntax. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes. Regular expressions can only be used when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.

repeated string allow_origin_regexes = 215385810;

Returns

Type	Description
List<String>	A list containing the allowOriginRegexes.

getAllowOrigins(int index)

public abstract String getAllowOrigins(int index)

Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

repeated string allow_origins = 194914071;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The allowOrigins at the given index.

getAllowOriginsBytes(int index)

public abstract ByteString getAllowOriginsBytes(int index)

Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

repeated string allow_origins = 194914071;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the allowOrigins at the given index.

getAllowOriginsCount()

public abstract int getAllowOriginsCount()

Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

repeated string allow_origins = 194914071;

Returns

Type	Description
int	The count of allowOrigins.

getAllowOriginsList()

public abstract List<String> getAllowOriginsList()

Specifies the list of origins that is allowed to do CORS requests. An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

repeated string allow_origins = 194914071;

Returns

Type	Description
List<String>	A list containing the allowOrigins.

getDisabled()

public abstract boolean getDisabled()

If true, the setting specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

optional bool disabled = 270940796;

Returns

Type	Description
boolean	The disabled.

getExposeHeaders(int index)

public abstract String getExposeHeaders(int index)

Specifies the content for the Access-Control-Expose-Headers header.

repeated string expose_headers = 247604747;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The exposeHeaders at the given index.

getExposeHeadersBytes(int index)

public abstract ByteString getExposeHeadersBytes(int index)

Specifies the content for the Access-Control-Expose-Headers header.

repeated string expose_headers = 247604747;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the exposeHeaders at the given index.

getExposeHeadersCount()

public abstract int getExposeHeadersCount()

Specifies the content for the Access-Control-Expose-Headers header.

repeated string expose_headers = 247604747;

Returns

Type	Description
int	The count of exposeHeaders.

getExposeHeadersList()

public abstract List<String> getExposeHeadersList()

Specifies the content for the Access-Control-Expose-Headers header.

repeated string expose_headers = 247604747;

Returns

Type	Description
List<String>	A list containing the exposeHeaders.

getMaxAge()

public abstract int getMaxAge()

Specifies how long results of a preflight request can be cached in seconds. This field translates to the Access-Control-Max-Age header.

optional int32 max_age = 307559332;

Returns

Type	Description
int	The maxAge.

hasAllowCredentials()

public abstract boolean hasAllowCredentials()

In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This field translates to the Access-Control-Allow-Credentials header. Default is false.

optional bool allow_credentials = 481263366;

Returns

Type	Description
boolean	Whether the allowCredentials field is set.

hasDisabled()

public abstract boolean hasDisabled()

If true, the setting specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.

optional bool disabled = 270940796;

Returns

Type	Description
boolean	Whether the disabled field is set.

hasMaxAge()

public abstract boolean hasMaxAge()

Specifies how long results of a preflight request can be cached in seconds. This field translates to the Access-Control-Max-Age header.

optional int32 max_age = 307559332;

Returns

Type	Description
boolean	Whether the maxAge field is set.