155 строки
11 KiB
YAML
155 строки
11 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.blob.models.BlobRetentionPolicy"
|
|
fullName: "com.azure.storage.blob.models.BlobRetentionPolicy"
|
|
name: "BlobRetentionPolicy"
|
|
nameWithType: "BlobRetentionPolicy"
|
|
summary: "the retention policy which determines how long the associated data should persist."
|
|
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 **BlobRetentionPolicy**</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.blob.models.BlobRetentionPolicy?alt=com.azure.storage.blob.models.BlobRetentionPolicy&text=BlobRetentionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.storage.blob.models.BlobRetentionPolicy.BlobRetentionPolicy()"
|
|
fullName: "com.azure.storage.blob.models.BlobRetentionPolicy.BlobRetentionPolicy()"
|
|
name: "BlobRetentionPolicy()"
|
|
nameWithType: "BlobRetentionPolicy.BlobRetentionPolicy()"
|
|
summary: "Creates an instance of Blob<wbr>Retention<wbr>Policy class."
|
|
syntax: "public BlobRetentionPolicy()"
|
|
desc: "Creates an instance of BlobRetentionPolicy class."
|
|
methods:
|
|
- uid: "com.azure.storage.blob.models.BlobRetentionPolicy.fromXml(com.azure.xml.XmlReader)"
|
|
fullName: "com.azure.storage.blob.models.BlobRetentionPolicy.fromXml(XmlReader xmlReader)"
|
|
name: "fromXml(XmlReader xmlReader)"
|
|
nameWithType: "BlobRetentionPolicy.fromXml(XmlReader xmlReader)"
|
|
summary: "Reads an instance of Blob<wbr>Retention<wbr>Policy 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 BlobRetentionPolicy 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 BlobRetentionPolicy from the XmlReader."
|
|
returns:
|
|
description: "An instance of BlobRetentionPolicy 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.blob.models.BlobRetentionPolicy?alt=com.azure.storage.blob.models.BlobRetentionPolicy&text=BlobRetentionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.models.BlobRetentionPolicy.fromXml(com.azure.xml.XmlReader,java.lang.String)"
|
|
fullName: "com.azure.storage.blob.models.BlobRetentionPolicy.fromXml(XmlReader xmlReader, String rootElementName)"
|
|
name: "fromXml(XmlReader xmlReader, String rootElementName)"
|
|
nameWithType: "BlobRetentionPolicy.fromXml(XmlReader xmlReader, String rootElementName)"
|
|
summary: "Reads an instance of Blob<wbr>Retention<wbr>Policy 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 BlobRetentionPolicy 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 BlobRetentionPolicy from the XmlReader."
|
|
returns:
|
|
description: "An instance of BlobRetentionPolicy 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.blob.models.BlobRetentionPolicy?alt=com.azure.storage.blob.models.BlobRetentionPolicy&text=BlobRetentionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.models.BlobRetentionPolicy.getDays()"
|
|
fullName: "com.azure.storage.blob.models.BlobRetentionPolicy.getDays()"
|
|
name: "getDays()"
|
|
nameWithType: "BlobRetentionPolicy.getDays()"
|
|
summary: "Get the days property: Indicates the number of days that metrics or logging or soft-deleted data should be retained."
|
|
syntax: "public Integer getDays()"
|
|
desc: "Get the days property: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted."
|
|
returns:
|
|
description: "the days value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.storage.blob.models.BlobRetentionPolicy.isEnabled()"
|
|
fullName: "com.azure.storage.blob.models.BlobRetentionPolicy.isEnabled()"
|
|
name: "isEnabled()"
|
|
nameWithType: "BlobRetentionPolicy.isEnabled()"
|
|
summary: "Get the enabled property: Indicates whether a retention policy is enabled for the storage service."
|
|
syntax: "public boolean isEnabled()"
|
|
desc: "Get the enabled property: Indicates whether a retention policy is enabled for the storage service."
|
|
returns:
|
|
description: "the enabled value."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.models.BlobRetentionPolicy.setDays(java.lang.Integer)"
|
|
fullName: "com.azure.storage.blob.models.BlobRetentionPolicy.setDays(Integer days)"
|
|
name: "setDays(Integer days)"
|
|
nameWithType: "BlobRetentionPolicy.setDays(Integer days)"
|
|
summary: "Set the days property: Indicates the number of days that metrics or logging or soft-deleted data should be retained."
|
|
parameters:
|
|
- description: "the days value to set."
|
|
name: "days"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public BlobRetentionPolicy setDays(Integer days)"
|
|
desc: "Set the days property: Indicates the number of days that metrics or logging or soft-deleted data should be retained. All data older than this value will be deleted."
|
|
returns:
|
|
description: "the BlobRetentionPolicy object itself."
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobRetentionPolicy?alt=com.azure.storage.blob.models.BlobRetentionPolicy&text=BlobRetentionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.models.BlobRetentionPolicy.setEnabled(boolean)"
|
|
fullName: "com.azure.storage.blob.models.BlobRetentionPolicy.setEnabled(boolean enabled)"
|
|
name: "setEnabled(boolean enabled)"
|
|
nameWithType: "BlobRetentionPolicy.setEnabled(boolean enabled)"
|
|
summary: "Set the enabled property: Indicates whether a retention policy is enabled for the storage service."
|
|
parameters:
|
|
- description: "the enabled value to set."
|
|
name: "enabled"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlobRetentionPolicy setEnabled(boolean enabled)"
|
|
desc: "Set the enabled property: Indicates whether a retention policy is enabled for the storage service."
|
|
returns:
|
|
description: "the BlobRetentionPolicy object itself."
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobRetentionPolicy?alt=com.azure.storage.blob.models.BlobRetentionPolicy&text=BlobRetentionPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.models.BlobRetentionPolicy.toXml(com.azure.xml.XmlWriter)"
|
|
fullName: "com.azure.storage.blob.models.BlobRetentionPolicy.toXml(XmlWriter xmlWriter)"
|
|
name: "toXml(XmlWriter xmlWriter)"
|
|
nameWithType: "BlobRetentionPolicy.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.blob.models.BlobRetentionPolicy.toXml(com.azure.xml.XmlWriter,java.lang.String)"
|
|
fullName: "com.azure.storage.blob.models.BlobRetentionPolicy.toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
name: "toXml(XmlWriter xmlWriter, String rootElementName)"
|
|
nameWithType: "BlobRetentionPolicy.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: "the retention policy which determines how long the associated data should persist."
|
|
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.blob.models.BlobRetentionPolicy?alt=com.azure.storage.blob.models.BlobRetentionPolicy&text=BlobRetentionPolicy\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.storage.blob.models"
|
|
artifact: com.azure:azure-storage-blob:12.28.1
|