198 строки
14 KiB
YAML
198 строки
14 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy"
|
|
name: "CorsPolicy"
|
|
nameWithType: "CorsPolicy"
|
|
summary: "The CORS policy for the Cosmos DB database account."
|
|
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 **CorsPolicy**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.CorsPolicy?alt=com.azure.resourcemanager.cosmos.models.CorsPolicy&text=CorsPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy.CorsPolicy()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.CorsPolicy()"
|
|
name: "CorsPolicy()"
|
|
nameWithType: "CorsPolicy.CorsPolicy()"
|
|
summary: "Creates an instance of Cors<wbr>Policy class."
|
|
syntax: "public CorsPolicy()"
|
|
desc: "Creates an instance of CorsPolicy class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy.allowedHeaders()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.allowedHeaders()"
|
|
name: "allowedHeaders()"
|
|
nameWithType: "CorsPolicy.allowedHeaders()"
|
|
summary: "Get the allowed<wbr>Headers property: The request headers that the origin domain may specify on the CORS request."
|
|
syntax: "public String allowedHeaders()"
|
|
desc: "Get the allowedHeaders property: The request headers that the origin domain may specify on the CORS request."
|
|
returns:
|
|
description: "the allowedHeaders value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy.allowedMethods()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.allowedMethods()"
|
|
name: "allowedMethods()"
|
|
nameWithType: "CorsPolicy.allowedMethods()"
|
|
summary: "Get the allowed<wbr>Methods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request."
|
|
syntax: "public String allowedMethods()"
|
|
desc: "Get the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request."
|
|
returns:
|
|
description: "the allowedMethods value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy.allowedOrigins()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.allowedOrigins()"
|
|
name: "allowedOrigins()"
|
|
nameWithType: "CorsPolicy.allowedOrigins()"
|
|
summary: "Get the allowed<wbr>Origins property: The origin domains that are permitted to make a request against the service via CORS."
|
|
syntax: "public String allowedOrigins()"
|
|
desc: "Get the allowedOrigins property: The origin domains that are permitted to make a request against the service via CORS."
|
|
returns:
|
|
description: "the allowedOrigins value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy.exposedHeaders()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.exposedHeaders()"
|
|
name: "exposedHeaders()"
|
|
nameWithType: "CorsPolicy.exposedHeaders()"
|
|
summary: "Get the exposed<wbr>Headers property: The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer."
|
|
syntax: "public String exposedHeaders()"
|
|
desc: "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:
|
|
description: "the exposedHeaders value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "CorsPolicy.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Cors<wbr>Policy 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 CorsPolicy 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 CorsPolicy from the JsonReader."
|
|
returns:
|
|
description: "An instance of CorsPolicy if the JsonReader was pointing to an instance of it, or null if it was pointing\n to JSON null."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.CorsPolicy?alt=com.azure.resourcemanager.cosmos.models.CorsPolicy&text=CorsPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy.maxAgeInSeconds()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.maxAgeInSeconds()"
|
|
name: "maxAgeInSeconds()"
|
|
nameWithType: "CorsPolicy.maxAgeInSeconds()"
|
|
summary: "Get the max<wbr>Age<wbr>InSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request."
|
|
syntax: "public Long maxAgeInSeconds()"
|
|
desc: "Get the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request."
|
|
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.resourcemanager.cosmos.models.CorsPolicy.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "CorsPolicy.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\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy.validate()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.validate()"
|
|
name: "validate()"
|
|
nameWithType: "CorsPolicy.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy.withAllowedHeaders(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.withAllowedHeaders(String allowedHeaders)"
|
|
name: "withAllowedHeaders(String allowedHeaders)"
|
|
nameWithType: "CorsPolicy.withAllowedHeaders(String allowedHeaders)"
|
|
summary: "Set the allowed<wbr>Headers property: The request headers that the origin domain may specify on the CORS request."
|
|
parameters:
|
|
- description: "the allowedHeaders value to set."
|
|
name: "allowedHeaders"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CorsPolicy withAllowedHeaders(String allowedHeaders)"
|
|
desc: "Set the allowedHeaders property: The request headers that the origin domain may specify on the CORS request."
|
|
returns:
|
|
description: "the CorsPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.CorsPolicy?alt=com.azure.resourcemanager.cosmos.models.CorsPolicy&text=CorsPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy.withAllowedMethods(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.withAllowedMethods(String allowedMethods)"
|
|
name: "withAllowedMethods(String allowedMethods)"
|
|
nameWithType: "CorsPolicy.withAllowedMethods(String allowedMethods)"
|
|
summary: "Set the allowed<wbr>Methods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request."
|
|
parameters:
|
|
- description: "the allowedMethods value to set."
|
|
name: "allowedMethods"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CorsPolicy withAllowedMethods(String allowedMethods)"
|
|
desc: "Set the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request."
|
|
returns:
|
|
description: "the CorsPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.CorsPolicy?alt=com.azure.resourcemanager.cosmos.models.CorsPolicy&text=CorsPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy.withAllowedOrigins(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.withAllowedOrigins(String allowedOrigins)"
|
|
name: "withAllowedOrigins(String allowedOrigins)"
|
|
nameWithType: "CorsPolicy.withAllowedOrigins(String allowedOrigins)"
|
|
summary: "Set the allowed<wbr>Origins property: The origin domains that are permitted to make a request against the service via CORS."
|
|
parameters:
|
|
- description: "the allowedOrigins value to set."
|
|
name: "allowedOrigins"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CorsPolicy withAllowedOrigins(String allowedOrigins)"
|
|
desc: "Set the allowedOrigins property: The origin domains that are permitted to make a request against the service via CORS."
|
|
returns:
|
|
description: "the CorsPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.CorsPolicy?alt=com.azure.resourcemanager.cosmos.models.CorsPolicy&text=CorsPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy.withExposedHeaders(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.withExposedHeaders(String exposedHeaders)"
|
|
name: "withExposedHeaders(String exposedHeaders)"
|
|
nameWithType: "CorsPolicy.withExposedHeaders(String exposedHeaders)"
|
|
summary: "Set the exposed<wbr>Headers 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:
|
|
- description: "the exposedHeaders value to set."
|
|
name: "exposedHeaders"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CorsPolicy withExposedHeaders(String exposedHeaders)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the CorsPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.CorsPolicy?alt=com.azure.resourcemanager.cosmos.models.CorsPolicy&text=CorsPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.CorsPolicy.withMaxAgeInSeconds(java.lang.Long)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.CorsPolicy.withMaxAgeInSeconds(Long maxAgeInSeconds)"
|
|
name: "withMaxAgeInSeconds(Long maxAgeInSeconds)"
|
|
nameWithType: "CorsPolicy.withMaxAgeInSeconds(Long maxAgeInSeconds)"
|
|
summary: "Set the max<wbr>Age<wbr>InSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request."
|
|
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 CorsPolicy withMaxAgeInSeconds(Long maxAgeInSeconds)"
|
|
desc: "Set the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request."
|
|
returns:
|
|
description: "the CorsPolicy object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.CorsPolicy?alt=com.azure.resourcemanager.cosmos.models.CorsPolicy&text=CorsPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The CORS policy for the Cosmos DB database account."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.CorsPolicy?alt=com.azure.resourcemanager.cosmos.models.CorsPolicy&text=CorsPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.cosmos.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.42.0
|