com.google.api.services.compute.model

Class CorsPolicy

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.CorsPolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class CorsPolicy
extends GenericJson

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CorsPolicy()

Method Summary

Modifier and Type	Method and Description
CorsPolicy	clone()
Boolean	getAllowCredentials() In response to a preflight request, setting this to true indicates that the actual request can include user credentials.
List<String>	getAllowHeaders() Specifies the content for the Access-Control-Allow-Headers header.
List<String>	getAllowMethods() Specifies the content for the Access-Control-Allow-Methods header.
List<String>	getAllowOriginRegexes() Specifies the regualar expression patterns that match allowed origins.
List<String>	getAllowOrigins() Specifies the list of origins that will be allowed to do CORS requests.
Boolean	getDisabled() If true, specifies the CORS policy is disabled.
List<String>	getExposeHeaders() Specifies the content for the Access-Control-Expose-Headers header.
Integer	getMaxAge() Specifies how long results of a preflight request can be cached in seconds.
CorsPolicy	set(String fieldName, Object value)
CorsPolicy	setAllowCredentials(Boolean allowCredentials) In response to a preflight request, setting this to true indicates that the actual request can include user credentials.
CorsPolicy	setAllowHeaders(List<String> allowHeaders) Specifies the content for the Access-Control-Allow-Headers header.
CorsPolicy	setAllowMethods(List<String> allowMethods) Specifies the content for the Access-Control-Allow-Methods header.
CorsPolicy	setAllowOriginRegexes(List<String> allowOriginRegexes) Specifies the regualar expression patterns that match allowed origins.
CorsPolicy	setAllowOrigins(List<String> allowOrigins) Specifies the list of origins that will be allowed to do CORS requests.
CorsPolicy	setDisabled(Boolean disabled) If true, specifies the CORS policy is disabled.
CorsPolicy	setExposeHeaders(List<String> exposeHeaders) Specifies the content for the Access-Control-Expose-Headers header.
CorsPolicy	setMaxAge(Integer maxAge) Specifies how long results of a preflight request can be cached in seconds.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CorsPolicy

public CorsPolicy()

Method Detail

getAllowCredentials

public Boolean getAllowCredentials()

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

Returns:

value or null for none

setAllowCredentials

public CorsPolicy setAllowCredentials(Boolean allowCredentials)

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

Parameters:

allowCredentials - allowCredentials or null for none

getAllowHeaders

public List<String> getAllowHeaders()

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

Returns:

value or null for none

setAllowHeaders

public CorsPolicy setAllowHeaders(List<String> allowHeaders)

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

Parameters:

allowHeaders - allowHeaders or null for none

getAllowMethods

public List<String> getAllowMethods()

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

Returns:

value or null for none

setAllowMethods

public CorsPolicy setAllowMethods(List<String> allowMethods)

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

Parameters:

allowMethods - allowMethods or null for none

getAllowOriginRegexes

public List<String> getAllowOriginRegexes()

Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Returns:

value or null for none

setAllowOriginRegexes

public CorsPolicy setAllowOriginRegexes(List<String> allowOriginRegexes)

Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.

Parameters:

allowOriginRegexes - allowOriginRegexes or null for none

getAllowOrigins

public List<String> getAllowOrigins()

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

Returns:

value or null for none

setAllowOrigins

public CorsPolicy setAllowOrigins(List<String> allowOrigins)

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

Parameters:

allowOrigins - allowOrigins or null for none

getDisabled

public Boolean getDisabled()

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

Returns:

value or null for none

setDisabled

public CorsPolicy setDisabled(Boolean disabled)

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

Parameters:

disabled - disabled or null for none

getExposeHeaders

public List<String> getExposeHeaders()

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

Returns:

value or null for none

setExposeHeaders

public CorsPolicy setExposeHeaders(List<String> exposeHeaders)

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

Parameters:

exposeHeaders - exposeHeaders or null for none

getMaxAge

public Integer getMaxAge()

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

Returns:

value or null for none

setMaxAge

public CorsPolicy setMaxAge(Integer maxAge)

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

Parameters:

maxAge - maxAge or null for none

set

public CorsPolicy set(String fieldName,
                      Object value)

Overrides:

set in class GenericJson

clone

public CorsPolicy clone()

Overrides:

clone in class GenericJson