Class HttpRoute.CorsPolicy (0.3.0)

public static final class HttpRoute.CorsPolicy extends GeneratedMessageV3 implements HttpRoute.CorsPolicyOrBuilder

The Specification for allowing client side cross-origin requests.

Protobuf type google.cloud.networkservices.v1.HttpRoute.CorsPolicy

Static Fields

ALLOW_CREDENTIALS_FIELD_NUMBER

public static final int ALLOW_CREDENTIALS_FIELD_NUMBER
Field Value
Type Description
int

ALLOW_HEADERS_FIELD_NUMBER

public static final int ALLOW_HEADERS_FIELD_NUMBER
Field Value
Type Description
int

ALLOW_METHODS_FIELD_NUMBER

public static final int ALLOW_METHODS_FIELD_NUMBER
Field Value
Type Description
int

ALLOW_ORIGINS_FIELD_NUMBER

public static final int ALLOW_ORIGINS_FIELD_NUMBER
Field Value
Type Description
int

ALLOW_ORIGIN_REGEXES_FIELD_NUMBER

public static final int ALLOW_ORIGIN_REGEXES_FIELD_NUMBER
Field Value
Type Description
int

DISABLED_FIELD_NUMBER

public static final int DISABLED_FIELD_NUMBER
Field Value
Type Description
int

EXPOSE_HEADERS_FIELD_NUMBER

public static final int EXPOSE_HEADERS_FIELD_NUMBER
Field Value
Type Description
int

MAX_AGE_FIELD_NUMBER

public static final int MAX_AGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HttpRoute.CorsPolicy getDefaultInstance()
Returns
Type Description
HttpRoute.CorsPolicy

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static HttpRoute.CorsPolicy.Builder newBuilder()
Returns
Type Description
HttpRoute.CorsPolicy.Builder

newBuilder(HttpRoute.CorsPolicy prototype)

public static HttpRoute.CorsPolicy.Builder newBuilder(HttpRoute.CorsPolicy prototype)
Parameter
Name Description
prototype HttpRoute.CorsPolicy
Returns
Type Description
HttpRoute.CorsPolicy.Builder

parseDelimitedFrom(InputStream input)

public static HttpRoute.CorsPolicy parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpRoute.CorsPolicy
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRoute.CorsPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRoute.CorsPolicy
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HttpRoute.CorsPolicy parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HttpRoute.CorsPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HttpRoute.CorsPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRoute.CorsPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HttpRoute.CorsPolicy parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HttpRoute.CorsPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HttpRoute.CorsPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRoute.CorsPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HttpRoute.CorsPolicy parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HttpRoute.CorsPolicy
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRoute.CorsPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRoute.CorsPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HttpRoute.CorsPolicy parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HttpRoute.CorsPolicy
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HttpRoute.CorsPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRoute.CorsPolicy
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HttpRoute.CorsPolicy parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HttpRoute.CorsPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HttpRoute.CorsPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HttpRoute.CorsPolicy
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HttpRoute.CorsPolicy> parser()
Returns
Type Description
Parser<CorsPolicy>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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 translates to the Access-Control-Allow-Credentials header.

Default value is false.

bool allow_credentials = 7;

Returns
Type Description
boolean

The allowCredentials.

getAllowHeaders(int index)

public String getAllowHeaders(int index)

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

repeated string allow_headers = 4;

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 ByteString getAllowHeadersBytes(int index)

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

repeated string allow_headers = 4;

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 int getAllowHeadersCount()

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

repeated string allow_headers = 4;

Returns
Type Description
int

The count of allowHeaders.

getAllowHeadersList()

public ProtocolStringList getAllowHeadersList()

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

repeated string allow_headers = 4;

Returns
Type Description
ProtocolStringList

A list containing the allowHeaders.

getAllowMethods(int index)

public String getAllowMethods(int index)

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

repeated string allow_methods = 3;

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 ByteString getAllowMethodsBytes(int index)

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

repeated string allow_methods = 3;

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 int getAllowMethodsCount()

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

repeated string allow_methods = 3;

Returns
Type Description
int

The count of allowMethods.

getAllowMethodsList()

public ProtocolStringList getAllowMethodsList()

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

repeated string allow_methods = 3;

Returns
Type Description
ProtocolStringList

A list containing the allowMethods.

getAllowOriginRegexes(int index)

public String getAllowOriginRegexes(int index)

Specifies the regular expression patterns that match allowed origins. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax.

repeated string allow_origin_regexes = 2;

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 ByteString getAllowOriginRegexesBytes(int index)

Specifies the regular expression patterns that match allowed origins. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax.

repeated string allow_origin_regexes = 2;

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 int getAllowOriginRegexesCount()

Specifies the regular expression patterns that match allowed origins. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax.

repeated string allow_origin_regexes = 2;

Returns
Type Description
int

The count of allowOriginRegexes.

getAllowOriginRegexesList()

public ProtocolStringList getAllowOriginRegexesList()

Specifies the regular expression patterns that match allowed origins. For regular expression grammar, please see https://github.com/google/re2/wiki/Syntax.

repeated string allow_origin_regexes = 2;

Returns
Type Description
ProtocolStringList

A list containing the allowOriginRegexes.

getAllowOrigins(int index)

public String getAllowOrigins(int index)

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

repeated string allow_origins = 1;

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 ByteString getAllowOriginsBytes(int index)

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

repeated string allow_origins = 1;

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 int getAllowOriginsCount()

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

repeated string allow_origins = 1;

Returns
Type Description
int

The count of allowOrigins.

getAllowOriginsList()

public ProtocolStringList getAllowOriginsList()

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

repeated string allow_origins = 1;

Returns
Type Description
ProtocolStringList

A list containing the allowOrigins.

getDefaultInstanceForType()

public HttpRoute.CorsPolicy getDefaultInstanceForType()
Returns
Type Description
HttpRoute.CorsPolicy

getDisabled()

public boolean getDisabled()

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

bool disabled = 8;

Returns
Type Description
boolean

The disabled.

getExposeHeaders(int index)

public String getExposeHeaders(int index)

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

repeated string expose_headers = 5;

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 ByteString getExposeHeadersBytes(int index)

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

repeated string expose_headers = 5;

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 int getExposeHeadersCount()

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

repeated string expose_headers = 5;

Returns
Type Description
int

The count of exposeHeaders.

getExposeHeadersList()

public ProtocolStringList getExposeHeadersList()

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

repeated string expose_headers = 5;

Returns
Type Description
ProtocolStringList

A list containing the exposeHeaders.

getMaxAge()

public String getMaxAge()

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

string max_age = 6;

Returns
Type Description
String

The maxAge.

getMaxAgeBytes()

public ByteString getMaxAgeBytes()

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

string max_age = 6;

Returns
Type Description
ByteString

The bytes for maxAge.

getParserForType()

public Parser<HttpRoute.CorsPolicy> getParserForType()
Returns
Type Description
Parser<CorsPolicy>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HttpRoute.CorsPolicy.Builder newBuilderForType()
Returns
Type Description
HttpRoute.CorsPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected HttpRoute.CorsPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HttpRoute.CorsPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public HttpRoute.CorsPolicy.Builder toBuilder()
Returns
Type Description
HttpRoute.CorsPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException