azure-docs-sdk-java/docs-ref-autogen/com.azure.search.documents.indexes.models.CorsOptions.yml

### YamlMime:JavaType
uid: "com.azure.search.documents.indexes.models.CorsOptions"
fullName: "com.azure.search.documents.indexes.models.CorsOptions"
name: "CorsOptions"
nameWithType: "CorsOptions"
summary: "Defines options to control Cross-Origin Resource Sharing (CORS) for an index."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **CorsOptions**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.CorsOptions?alt=com.azure.search.documents.indexes.models.CorsOptions&text=CorsOptions\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.search.documents.indexes.models.CorsOptions.CorsOptions(java.util.List<java.lang.String>)"
  fullName: "com.azure.search.documents.indexes.models.CorsOptions.CorsOptions(List<String> allowedOrigins)"
  name: "CorsOptions(List<String> allowedOrigins)"
  nameWithType: "CorsOptions.CorsOptions(List<String> allowedOrigins)"
  summary: "Creates an instance of Cors<wbr>Options class."
  parameters:
  - description: "the allowedOrigins value to set."
    name: "allowedOrigins"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
  syntax: "public CorsOptions(List<String> allowedOrigins)"
  desc: "Creates an instance of CorsOptions class."
methods:
- uid: "com.azure.search.documents.indexes.models.CorsOptions.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.search.documents.indexes.models.CorsOptions.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "CorsOptions.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Cors<wbr>Options from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static CorsOptions fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If the deserialized JSON object was missing any required properties."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of CorsOptions from the JsonReader."
  returns:
    description: "An instance of CorsOptions if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
    type: "<xref href=\"com.azure.search.documents.indexes.models.CorsOptions?alt=com.azure.search.documents.indexes.models.CorsOptions&text=CorsOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.CorsOptions.getAllowedOrigins()"
  fullName: "com.azure.search.documents.indexes.models.CorsOptions.getAllowedOrigins()"
  name: "getAllowedOrigins()"
  nameWithType: "CorsOptions.getAllowedOrigins()"
  summary: "Get the allowed<wbr>Origins property: The list of origins from which Java<wbr>Script code will be granted access to your index."
  syntax: "public List<String> getAllowedOrigins()"
  desc: "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:
    description: "the allowedOrigins value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.search.documents.indexes.models.CorsOptions.getMaxAgeInSeconds()"
  fullName: "com.azure.search.documents.indexes.models.CorsOptions.getMaxAgeInSeconds()"
  name: "getMaxAgeInSeconds()"
  nameWithType: "CorsOptions.getMaxAgeInSeconds()"
  summary: "Get the max<wbr>Age<wbr>InSeconds property: The duration for which browsers should cache CORS preflight responses."
  syntax: "public Long getMaxAgeInSeconds()"
  desc: "Get the maxAgeInSeconds property: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes."
  returns:
    description: "the maxAgeInSeconds value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.search.documents.indexes.models.CorsOptions.setMaxAgeInSeconds(java.lang.Long)"
  fullName: "com.azure.search.documents.indexes.models.CorsOptions.setMaxAgeInSeconds(Long maxAgeInSeconds)"
  name: "setMaxAgeInSeconds(Long maxAgeInSeconds)"
  nameWithType: "CorsOptions.setMaxAgeInSeconds(Long maxAgeInSeconds)"
  summary: "Set the max<wbr>Age<wbr>InSeconds property: The duration for which browsers should cache CORS preflight responses."
  parameters:
  - description: "the maxAgeInSeconds value to set."
    name: "maxAgeInSeconds"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
  syntax: "public CorsOptions setMaxAgeInSeconds(Long maxAgeInSeconds)"
  desc: "Set the maxAgeInSeconds property: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes."
  returns:
    description: "the CorsOptions object itself."
    type: "<xref href=\"com.azure.search.documents.indexes.models.CorsOptions?alt=com.azure.search.documents.indexes.models.CorsOptions&text=CorsOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.search.documents.indexes.models.CorsOptions.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.search.documents.indexes.models.CorsOptions.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "CorsOptions.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Defines options to control Cross-Origin Resource Sharing (CORS) for an index."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.search.documents.indexes.models.CorsOptions?alt=com.azure.search.documents.indexes.models.CorsOptions&text=CorsOptions\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.search.documents.indexes.models"
artifact: com.azure:azure-search-documents:11.7.1