Class CorsPolicy (1.41.0)

public final class CorsPolicy extends GeneratedMessageV3 implements CorsPolicyOrBuilder

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.

Protobuf type google.cloud.compute.v1.CorsPolicy

Implements

CorsPolicyOrBuilder

Static Fields

ALLOW_CREDENTIALS_FIELD_NUMBER

public static final int ALLOW_CREDENTIALS_FIELD_NUMBER
Field Value
TypeDescription
int

ALLOW_HEADERS_FIELD_NUMBER

public static final int ALLOW_HEADERS_FIELD_NUMBER
Field Value
TypeDescription
int

ALLOW_METHODS_FIELD_NUMBER

public static final int ALLOW_METHODS_FIELD_NUMBER
Field Value
TypeDescription
int

ALLOW_ORIGINS_FIELD_NUMBER

public static final int ALLOW_ORIGINS_FIELD_NUMBER
Field Value
TypeDescription
int

ALLOW_ORIGIN_REGEXES_FIELD_NUMBER

public static final int ALLOW_ORIGIN_REGEXES_FIELD_NUMBER
Field Value
TypeDescription
int

DISABLED_FIELD_NUMBER

public static final int DISABLED_FIELD_NUMBER
Field Value
TypeDescription
int

EXPOSE_HEADERS_FIELD_NUMBER

public static final int EXPOSE_HEADERS_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_AGE_FIELD_NUMBER

public static final int MAX_AGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CorsPolicy getDefaultInstance()
Returns
TypeDescription
CorsPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CorsPolicy.Builder newBuilder()
Returns
TypeDescription
CorsPolicy.Builder

newBuilder(CorsPolicy prototype)

public static CorsPolicy.Builder newBuilder(CorsPolicy prototype)
Parameter
NameDescription
prototypeCorsPolicy
Returns
TypeDescription
CorsPolicy.Builder

parseDelimitedFrom(InputStream input)

public static CorsPolicy parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CorsPolicy
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CorsPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CorsPolicy
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CorsPolicy parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CorsPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CorsPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CorsPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CorsPolicy parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CorsPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CorsPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CorsPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CorsPolicy parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CorsPolicy
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CorsPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CorsPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CorsPolicy parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CorsPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CorsPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CorsPolicy
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CorsPolicy parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CorsPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CorsPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CorsPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CorsPolicy> parser()
Returns
TypeDescription
Parser<CorsPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAllowCredentials()

public 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
TypeDescription
boolean

The allowCredentials.

getAllowHeaders(int index)

public String getAllowHeaders(int index)

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

repeated string allow_headers = 45179024;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The allowHeaders at the given index.

getAllowHeadersBytes(int index)

public ByteString getAllowHeadersBytes(int index)

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

repeated string allow_headers = 45179024;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the allowHeaders at the given index.

getAllowHeadersCount()

public int getAllowHeadersCount()

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

repeated string allow_headers = 45179024;

Returns
TypeDescription
int

The count of allowHeaders.

getAllowHeadersList()

public ProtocolStringList getAllowHeadersList()

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

repeated string allow_headers = 45179024;

Returns
TypeDescription
ProtocolStringList

A list containing the allowHeaders.

getAllowMethods(int index)

public String getAllowMethods(int index)

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

repeated string allow_methods = 205405372;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The allowMethods at the given index.

getAllowMethodsBytes(int index)

public ByteString getAllowMethodsBytes(int index)

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

repeated string allow_methods = 205405372;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the allowMethods at the given index.

getAllowMethodsCount()

public int getAllowMethodsCount()

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

repeated string allow_methods = 205405372;

Returns
TypeDescription
int

The count of allowMethods.

getAllowMethodsList()

public ProtocolStringList getAllowMethodsList()

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

repeated string allow_methods = 205405372;

Returns
TypeDescription
ProtocolStringList

A list containing the allowMethods.

getAllowOriginRegexes(int index)

public 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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The allowOriginRegexes at the given index.

getAllowOriginRegexesBytes(int index)

public 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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the allowOriginRegexes at the given index.

getAllowOriginRegexesCount()

public 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
TypeDescription
int

The count of allowOriginRegexes.

getAllowOriginRegexesList()

public ProtocolStringList 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
TypeDescription
ProtocolStringList

A list containing the allowOriginRegexes.

getAllowOrigins(int index)

public 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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The allowOrigins at the given index.

getAllowOriginsBytes(int index)

public 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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the allowOrigins at the given index.

getAllowOriginsCount()

public 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
TypeDescription
int

The count of allowOrigins.

getAllowOriginsList()

public ProtocolStringList 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
TypeDescription
ProtocolStringList

A list containing the allowOrigins.

getDefaultInstanceForType()

public CorsPolicy getDefaultInstanceForType()
Returns
TypeDescription
CorsPolicy

getDisabled()

public 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
TypeDescription
boolean

The disabled.

getExposeHeaders(int index)

public String getExposeHeaders(int index)

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

repeated string expose_headers = 247604747;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The exposeHeaders at the given index.

getExposeHeadersBytes(int index)

public ByteString getExposeHeadersBytes(int index)

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

repeated string expose_headers = 247604747;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the exposeHeaders at the given index.

getExposeHeadersCount()

public int getExposeHeadersCount()

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

repeated string expose_headers = 247604747;

Returns
TypeDescription
int

The count of exposeHeaders.

getExposeHeadersList()

public ProtocolStringList getExposeHeadersList()

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

repeated string expose_headers = 247604747;

Returns
TypeDescription
ProtocolStringList

A list containing the exposeHeaders.

getMaxAge()

public 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
TypeDescription
int

The maxAge.

getParserForType()

public Parser<CorsPolicy> getParserForType()
Returns
TypeDescription
Parser<CorsPolicy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasAllowCredentials()

public 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
TypeDescription
boolean

Whether the allowCredentials field is set.

hasDisabled()

public 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
TypeDescription
boolean

Whether the disabled field is set.

hasMaxAge()

public 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
TypeDescription
boolean

Whether the maxAge field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CorsPolicy.Builder newBuilderForType()
Returns
TypeDescription
CorsPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CorsPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CorsPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CorsPolicy.Builder toBuilder()
Returns
TypeDescription
CorsPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException