Reference documentation and code samples for the Compute V1 Client class CorsPolicy.
The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard.
Generated from protobuf message google.cloud.compute.v1.CorsPolicy
Namespace
Google \ Cloud \ Compute \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ allow_credentials |
bool
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. |
↳ allow_headers |
array
Specifies the content for the Access-Control-Allow-Headers header. |
↳ allow_methods |
array
Specifies the content for the Access-Control-Allow-Methods header. |
↳ allow_origin_regexes |
array
Specifies a regular expression that matches allowed origins. For more information, see regular expression 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. |
↳ allow_origins |
array
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. |
↳ disabled |
bool
If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect. |
↳ expose_headers |
array
Specifies the content for the Access-Control-Expose-Headers header. |
↳ max_age |
int
Specifies how long results of a preflight request can be cached in seconds. This field translates to the Access-Control-Max-Age header. |
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.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasAllowCredentials
clearAllowCredentials
setAllowCredentials
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAllowHeaders
Specifies the content for the Access-Control-Allow-Headers header.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAllowHeaders
Specifies the content for the Access-Control-Allow-Headers header.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAllowMethods
Specifies the content for the Access-Control-Allow-Methods header.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAllowMethods
Specifies the content for the Access-Control-Allow-Methods header.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAllowOriginRegexes
Specifies a regular expression that matches allowed origins. For more information, see regular expression 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAllowOriginRegexes
Specifies a regular expression that matches allowed origins. For more information, see regular expression 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAllowOrigins
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAllowOrigins
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisabled
If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasDisabled
clearDisabled
setDisabled
If true, disables the CORS policy. The default value is false, which indicates that the CORS policy is in effect.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getExposeHeaders
Specifies the content for the Access-Control-Expose-Headers header.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setExposeHeaders
Specifies the content for the Access-Control-Expose-Headers header.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxAge
Specifies how long results of a preflight request can be cached in seconds. This field translates to the Access-Control-Max-Age header.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasMaxAge
clearMaxAge
setMaxAge
Specifies how long results of a preflight request can be cached in seconds. This field translates to the Access-Control-Max-Age header.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|