CorsOptions Class

  • java.lang.Object
    • com.azure.search.documents.indexes.models.CorsOptions

Implements

public final class CorsOptions
implements JsonSerializable<CorsOptions>

Defines options to control Cross-Origin Resource Sharing (CORS) for an index.

Constructor Summary

Constructor Description
CorsOptions(List<String> allowedOrigins)

Creates an instance of CorsOptions class.

Method Summary

Modifier and Type Method and Description
static CorsOptions fromJson(JsonReader jsonReader)

Reads an instance of CorsOptions from the JsonReader.

List<String> getAllowedOrigins()

Get the allowedOrigins property: The list of origins from which JavaScript code will be granted access to your index.

Long getMaxAgeInSeconds()

Get the maxAgeInSeconds property: The duration for which browsers should cache CORS preflight responses.

CorsOptions setMaxAgeInSeconds(Long maxAgeInSeconds)

Set the maxAgeInSeconds property: The duration for which browsers should cache CORS preflight responses.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

CorsOptions

public CorsOptions(List allowedOrigins)

Creates an instance of CorsOptions class.

Parameters:

allowedOrigins - the allowedOrigins value to set.

Method Details

fromJson

public static CorsOptions fromJson(JsonReader jsonReader)

Reads an instance of CorsOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CorsOptions 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.

getAllowedOrigins

public List getAllowedOrigins()

Get the allowedOrigins property: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended).

Returns:

the allowedOrigins value.

getMaxAgeInSeconds

public Long getMaxAgeInSeconds()

Get the maxAgeInSeconds property: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes.

Returns:

the maxAgeInSeconds value.

setMaxAgeInSeconds

public CorsOptions setMaxAgeInSeconds(Long maxAgeInSeconds)

Set the maxAgeInSeconds property: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes.

Parameters:

maxAgeInSeconds - the maxAgeInSeconds value to set.

Returns:

the CorsOptions object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to