Package com.azure.search.documents.indexes.models

Class CorsOptions

java.lang.Object
com.azure.search.documents.indexes.models.CorsOptions
All Implemented Interfaces:
com.azure.json.JsonSerializable<CorsOptions>
public final class CorsOptions extends Object implements com.azure.json.JsonSerializable<CorsOptions>
Defines options to control Cross-Origin Resource Sharing (CORS) for an index.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CorsOptions(List<String> allowedOrigins)
    Creates an instance of CorsOptions class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static CorsOptions
    fromJson(com.azure.json.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.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • CorsOptions

      public CorsOptions(List<String> allowedOrigins)
      Creates an instance of CorsOptions class.
      Parameters:
      allowedOrigins - the allowedOrigins value to set.

  • Method Details

    • getAllowedOrigins

      public List<String> 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 com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<CorsOptions>
      Throws:
      IOException

    • fromJson

      public static CorsOptions fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the CorsOptions.