227 строки
18 KiB
YAML
227 строки
18 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.file.share.models.ShareCorsRule"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule"
|
|
name: "ShareCorsRule"
|
|
nameWithType: "ShareCorsRule"
|
|
summary: "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain."
|
|
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 **ShareCorsRule**</br> implements <xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.models.ShareCorsRule?alt=com.azure.storage.file.share.models.ShareCorsRule&text=ShareCorsRule\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.storage.file.share.models.ShareCorsRule.ShareCorsRule()"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.ShareCorsRule()"
|
|
name: "ShareCorsRule()"
|
|
nameWithType: "ShareCorsRule.ShareCorsRule()"
|
|
summary: "Creates an instance of Share<wbr>Cors<wbr>Rule class."
|
|
syntax: "public ShareCorsRule()"
|
|
desc: "Creates an instance of ShareCorsRule class."
|
|
methods:
|
|
- uid: "com.azure.storage.file.share.models.ShareCorsRule.fromXml(com.azure.xml.XmlReader)"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.fromXml(XmlReader xmlReader)"
|
|
name: "fromXml(XmlReader xmlReader)"
|
|
nameWithType: "ShareCorsRule.fromXml(XmlReader xmlReader)"
|
|
summary: "Reads an instance of Share<wbr>Cors<wbr>Rule from the Xml<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The XmlReader being read."
|
|
name: "xmlReader"
|
|
type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static ShareCorsRule fromXml(XmlReader xmlReader)"
|
|
exceptions:
|
|
- description: "If the deserialized XML object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
desc: "Reads an instance of ShareCorsRule from the XmlReader."
|
|
returns:
|
|
description: "An instance of ShareCorsRule if the XmlReader was pointing to an instance of it, or null if it was\n pointing to XML null."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareCorsRule?alt=com.azure.storage.file.share.models.ShareCorsRule&text=ShareCorsRule\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareCorsRule.fromXml(com.azure.xml.XmlReader,java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.fromXml(XmlReader xmlReader, String rootElementName)"
|
|
name: "fromXml(XmlReader xmlReader, String rootElementName)"
|
|
nameWithType: "ShareCorsRule.fromXml(XmlReader xmlReader, String rootElementName)"
|
|
summary: "Reads an instance of Share<wbr>Cors<wbr>Rule from the Xml<wbr>Reader."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The XmlReader being read."
|
|
name: "xmlReader"
|
|
type: "<xref href=\"com.azure.xml.XmlReader?alt=com.azure.xml.XmlReader&text=XmlReader\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Optional root element name to override the default defined by the model. Used to support\n cases where the model can deserialize from different root element names."
|
|
name: "rootElementName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public static ShareCorsRule fromXml(XmlReader xmlReader, String rootElementName)"
|
|
exceptions:
|
|
- description: "If the deserialized XML object was missing any required properties."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
desc: "Reads an instance of ShareCorsRule from the XmlReader."
|
|
returns:
|
|
description: "An instance of ShareCorsRule if the XmlReader was pointing to an instance of it, or null if it was\n pointing to XML null."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareCorsRule?alt=com.azure.storage.file.share.models.ShareCorsRule&text=ShareCorsRule\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareCorsRule.getAllowedHeaders()"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.getAllowedHeaders()"
|
|
name: "getAllowedHeaders()"
|
|
nameWithType: "ShareCorsRule.getAllowedHeaders()"
|
|
summary: "Get the allowed<wbr>Headers property: The request headers that the origin domain may specify on the CORS request."
|
|
syntax: "public String getAllowedHeaders()"
|
|
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.storage.file.share.models.ShareCorsRule.getAllowedMethods()"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.getAllowedMethods()"
|
|
name: "getAllowedMethods()"
|
|
nameWithType: "ShareCorsRule.getAllowedMethods()"
|
|
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 getAllowedMethods()"
|
|
desc: "Get the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)."
|
|
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.storage.file.share.models.ShareCorsRule.getAllowedOrigins()"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.getAllowedOrigins()"
|
|
name: "getAllowedOrigins()"
|
|
nameWithType: "ShareCorsRule.getAllowedOrigins()"
|
|
summary: "Get the allowed<wbr>Origins property: The origin domains that are permitted to make a request against the storage service via CORS."
|
|
syntax: "public String getAllowedOrigins()"
|
|
desc: "Get the allowedOrigins property: The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '\\*' to allow all origin domains to make requests 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.storage.file.share.models.ShareCorsRule.getExposedHeaders()"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.getExposedHeaders()"
|
|
name: "getExposedHeaders()"
|
|
nameWithType: "ShareCorsRule.getExposedHeaders()"
|
|
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 getExposedHeaders()"
|
|
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.storage.file.share.models.ShareCorsRule.getMaxAgeInSeconds()"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.getMaxAgeInSeconds()"
|
|
name: "getMaxAgeInSeconds()"
|
|
nameWithType: "ShareCorsRule.getMaxAgeInSeconds()"
|
|
summary: "Get the max<wbr>Age<wbr>InSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request."
|
|
syntax: "public int getMaxAgeInSeconds()"
|
|
desc: "Get the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request."
|
|
returns:
|
|
description: "the maxAgeInSeconds value."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareCorsRule.setAllowedHeaders(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.setAllowedHeaders(String allowedHeaders)"
|
|
name: "setAllowedHeaders(String allowedHeaders)"
|
|
nameWithType: "ShareCorsRule.setAllowedHeaders(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 ShareCorsRule setAllowedHeaders(String allowedHeaders)"
|
|
desc: "Set the allowedHeaders property: The request headers that the origin domain may specify on the CORS request."
|
|
returns:
|
|
description: "the ShareCorsRule object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareCorsRule?alt=com.azure.storage.file.share.models.ShareCorsRule&text=ShareCorsRule\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareCorsRule.setAllowedMethods(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.setAllowedMethods(String allowedMethods)"
|
|
name: "setAllowedMethods(String allowedMethods)"
|
|
nameWithType: "ShareCorsRule.setAllowedMethods(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 ShareCorsRule setAllowedMethods(String allowedMethods)"
|
|
desc: "Set the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)."
|
|
returns:
|
|
description: "the ShareCorsRule object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareCorsRule?alt=com.azure.storage.file.share.models.ShareCorsRule&text=ShareCorsRule\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareCorsRule.setAllowedOrigins(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.setAllowedOrigins(String allowedOrigins)"
|
|
name: "setAllowedOrigins(String allowedOrigins)"
|
|
nameWithType: "ShareCorsRule.setAllowedOrigins(String allowedOrigins)"
|
|
summary: "Set the allowed<wbr>Origins property: The origin domains that are permitted to make a request against the storage 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 ShareCorsRule setAllowedOrigins(String allowedOrigins)"
|
|
desc: "Set the allowedOrigins property: The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '\\*' to allow all origin domains to make requests via CORS."
|
|
returns:
|
|
description: "the ShareCorsRule object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareCorsRule?alt=com.azure.storage.file.share.models.ShareCorsRule&text=ShareCorsRule\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareCorsRule.setExposedHeaders(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.setExposedHeaders(String exposedHeaders)"
|
|
name: "setExposedHeaders(String exposedHeaders)"
|
|
nameWithType: "ShareCorsRule.setExposedHeaders(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 ShareCorsRule setExposedHeaders(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 ShareCorsRule object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareCorsRule?alt=com.azure.storage.file.share.models.ShareCorsRule&text=ShareCorsRule\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareCorsRule.setMaxAgeInSeconds(int)"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.setMaxAgeInSeconds(int maxAgeInSeconds)"
|
|
name: "setMaxAgeInSeconds(int maxAgeInSeconds)"
|
|
nameWithType: "ShareCorsRule.setMaxAgeInSeconds(int 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: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareCorsRule setMaxAgeInSeconds(int maxAgeInSeconds)"
|
|
desc: "Set the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS request."
|
|
returns:
|
|
description: "the ShareCorsRule object itself."
|
|
type: "<xref href=\"com.azure.storage.file.share.models.ShareCorsRule?alt=com.azure.storage.file.share.models.ShareCorsRule&text=ShareCorsRule\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareCorsRule.toXml(com.azure.xml.XmlWriter)"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.toXml(XmlWriter xmlWriter)"
|
|
name: "toXml(XmlWriter xmlWriter)"
|
|
nameWithType: "ShareCorsRule.toXml(XmlWriter xmlWriter)"
|
|
parameters:
|
|
- name: "xmlWriter"
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public XmlWriter toXml(XmlWriter xmlWriter)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.models.ShareCorsRule.toXml(com.azure.xml.XmlWriter,java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.models.ShareCorsRule.toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
name: "toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
nameWithType: "ShareCorsRule.toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
parameters:
|
|
- name: "xmlWriter"
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
- name: "rootElementName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
exceptions:
|
|
- type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/javax/xml/stream/XMLStreamException.html\">XMLStreamException</a>"
|
|
returns:
|
|
type: "<xref href=\"com.azure.xml.XmlWriter?alt=com.azure.xml.XmlWriter&text=XmlWriter\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain."
|
|
implements:
|
|
- "<xref href=\"com.azure.xml.XmlSerializable?alt=com.azure.xml.XmlSerializable&text=XmlSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.file.share.models.ShareCorsRule?alt=com.azure.storage.file.share.models.ShareCorsRule&text=ShareCorsRule\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.storage.file.share.models"
|
|
artifact: com.azure:azure-storage-file-share:12.23.1
|