Share via

CorsPolicy Class

  • Reference
Package:
com.azure.resourcemanager.cosmos.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.1
  • java.lang.Object
    • com.azure.resourcemanager.cosmos.models.CorsPolicy

Implements

JsonSerializable<CorsPolicy>

public final class CorsPolicy
implements JsonSerializable<CorsPolicy>

The CORS policy for the Cosmos DB database account.

Constructor Summary

Constructor Description
CorsPolicy()

Creates an instance of CorsPolicy class.

Method Summary

Modifier and Type Method and Description
String allowedHeaders()

Get the allowedHeaders property: The request headers that the origin domain may specify on the CORS request.
String allowedMethods()

Get the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request.
String allowedOrigins()

Get the allowedOrigins property: The origin domains that are permitted to make a request against the service via CORS.
String exposedHeaders()

Get the exposedHeaders property: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
static CorsPolicy fromJson(JsonReader jsonReader)

Reads an instance of CorsPolicy from the JsonReader.
Long maxAgeInSeconds()

Get the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request.
JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.
CorsPolicy withAllowedHeaders(String allowedHeaders)

Set the allowedHeaders property: The request headers that the origin domain may specify on the CORS request.
CorsPolicy withAllowedMethods(String allowedMethods)

Set the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request.
CorsPolicy withAllowedOrigins(String allowedOrigins)

Set the allowedOrigins property: The origin domains that are permitted to make a request against the service via CORS.
CorsPolicy withExposedHeaders(String exposedHeaders)

Set the exposedHeaders property: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.
CorsPolicy withMaxAgeInSeconds(Long maxAgeInSeconds)

Set the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CorsPolicy

public CorsPolicy()

Creates an instance of CorsPolicy class.

Method Details

allowedHeaders

public String allowedHeaders()

Get the allowedHeaders property: The request headers that the origin domain may specify on the CORS request.

Returns:

the allowedHeaders value.

allowedMethods

public String allowedMethods()

Get the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request.

Returns:

the allowedMethods value.

allowedOrigins

public String allowedOrigins()

Get the allowedOrigins property: The origin domains that are permitted to make a request against the service via CORS.

Returns:

the allowedOrigins value.

exposedHeaders

public String exposedHeaders()

Get the exposedHeaders property: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

Returns:

the exposedHeaders value.

fromJson

public static CorsPolicy fromJson(JsonReader jsonReader)

Reads an instance of CorsPolicy from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CorsPolicy if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

maxAgeInSeconds

public Long maxAgeInSeconds()

Get the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request.

Returns:

the maxAgeInSeconds value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withAllowedHeaders

public CorsPolicy withAllowedHeaders(String allowedHeaders)

Set the allowedHeaders property: The request headers that the origin domain may specify on the CORS request.

Parameters:

allowedHeaders - the allowedHeaders value to set.

Returns:

the CorsPolicy object itself.

withAllowedMethods

public CorsPolicy withAllowedMethods(String allowedMethods)

Set the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request.

Parameters:

allowedMethods - the allowedMethods value to set.

Returns:

the CorsPolicy object itself.

withAllowedOrigins

public CorsPolicy withAllowedOrigins(String allowedOrigins)

Set the allowedOrigins property: The origin domains that are permitted to make a request against the service via CORS.

Parameters:

allowedOrigins - the allowedOrigins value to set.

Returns:

the CorsPolicy object itself.

withExposedHeaders

public CorsPolicy withExposedHeaders(String exposedHeaders)

Set the exposedHeaders property: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.

Parameters:

exposedHeaders - the exposedHeaders value to set.

Returns:

the CorsPolicy object itself.

withMaxAgeInSeconds

public CorsPolicy withMaxAgeInSeconds(Long maxAgeInSeconds)

Set the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request.

Parameters:

maxAgeInSeconds - the maxAgeInSeconds value to set.

Returns:

the CorsPolicy object itself.

Applies to