BlobServiceProperties Class

  • Reference
Package:
com.azure.storage.blob.models
Maven Artifact:
com.azure:azure-storage-blob:12.28.1
  • java.lang.Object
    • com.azure.storage.blob.models.BlobServiceProperties

Implements

XmlSerializable<BlobServiceProperties>

public final class BlobServiceProperties
implements XmlSerializable<BlobServiceProperties>

Storage Service Properties.

Constructor Summary

Constructor Description
BlobServiceProperties()

Creates an instance of BlobServiceProperties class.

Method Summary

Modifier and Type Method and Description
static BlobServiceProperties fromXml(XmlReader xmlReader)

Reads an instance of BlobServiceProperties from the XmlReader.
static BlobServiceProperties fromXml(XmlReader xmlReader, String rootElementName)

Reads an instance of BlobServiceProperties from the XmlReader.
List<BlobCorsRule> getCors()

Get the cors property: The set of CORS rules.
String getDefaultServiceVersion()

Get the defaultServiceVersion property: The default version to use for requests to the Blob service if an incoming request's version is not specified.
BlobRetentionPolicy getDeleteRetentionPolicy()

Get the deleteRetentionPolicy property: the retention policy which determines how long the associated data should persist.
BlobMetrics getHourMetrics()

Get the hourMetrics property: a summary of request statistics grouped by API in hour or minute aggregates for blobs.
BlobAnalyticsLogging getLogging()

Get the logging property: Azure Analytics Logging settings.
BlobMetrics getMinuteMetrics()

Get the minuteMetrics property: a summary of request statistics grouped by API in hour or minute aggregates for blobs.
StaticWebsite getStaticWebsite()

Get the staticWebsite property: The properties that enable an account to host a static website.
BlobServiceProperties setCors(List<BlobCorsRule> cors)

Set the cors property: The set of CORS rules.
BlobServiceProperties setDefaultServiceVersion(String defaultServiceVersion)

Set the defaultServiceVersion property: The default version to use for requests to the Blob service if an incoming request's version is not specified.
BlobServiceProperties setDeleteRetentionPolicy(BlobRetentionPolicy deleteRetentionPolicy)

Set the deleteRetentionPolicy property: the retention policy which determines how long the associated data should persist.
BlobServiceProperties setHourMetrics(BlobMetrics hourMetrics)

Set the hourMetrics property: a summary of request statistics grouped by API in hour or minute aggregates for blobs.
BlobServiceProperties setLogging(BlobAnalyticsLogging logging)

Set the logging property: Azure Analytics Logging settings.
BlobServiceProperties setMinuteMetrics(BlobMetrics minuteMetrics)

Set the minuteMetrics property: a summary of request statistics grouped by API in hour or minute aggregates for blobs.
BlobServiceProperties setStaticWebsite(StaticWebsite staticWebsite)

Set the staticWebsite property: The properties that enable an account to host a static website.
XmlWriter toXml(XmlWriter xmlWriter)
XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobServiceProperties

public BlobServiceProperties()

Creates an instance of BlobServiceProperties class.

Method Details

fromXml

public static BlobServiceProperties fromXml(XmlReader xmlReader)

Reads an instance of BlobServiceProperties from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.

Returns:

An instance of BlobServiceProperties if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.

Throws:

XMLStreamException

 - If an error occurs while reading the BlobServiceProperties.

fromXml

public static BlobServiceProperties fromXml(XmlReader xmlReader, String rootElementName)

Reads an instance of BlobServiceProperties from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.
rootElementName - Optional root element name to override the default defined by the model. Used to support cases where the model can deserialize from different root element names.

Returns:

An instance of BlobServiceProperties if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.

Throws:

XMLStreamException

 - If an error occurs while reading the BlobServiceProperties.

getCors

public List getCors()

Get the cors property: The set of CORS rules.

Returns:

the cors value.

getDefaultServiceVersion

public String getDefaultServiceVersion()

Get the defaultServiceVersion property: The default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions.

Returns:

the defaultServiceVersion value.

getDeleteRetentionPolicy

public BlobRetentionPolicy getDeleteRetentionPolicy()

Get the deleteRetentionPolicy property: the retention policy which determines how long the associated data should persist.

Returns:

the deleteRetentionPolicy value.

getHourMetrics

public BlobMetrics getHourMetrics()

Get the hourMetrics property: a summary of request statistics grouped by API in hour or minute aggregates for blobs.

Returns:

the hourMetrics value.

getLogging

public BlobAnalyticsLogging getLogging()

Get the logging property: Azure Analytics Logging settings.

Returns:

the logging value.

getMinuteMetrics

public BlobMetrics getMinuteMetrics()

Get the minuteMetrics property: a summary of request statistics grouped by API in hour or minute aggregates for blobs.

Returns:

the minuteMetrics value.

getStaticWebsite

public StaticWebsite getStaticWebsite()

Get the staticWebsite property: The properties that enable an account to host a static website.

Returns:

the staticWebsite value.

setCors

public BlobServiceProperties setCors(List cors)

Set the cors property: The set of CORS rules.

Parameters:

cors - the cors value to set.

Returns:

the BlobServiceProperties object itself.

setDefaultServiceVersion

public BlobServiceProperties setDefaultServiceVersion(String defaultServiceVersion)

Set the defaultServiceVersion property: The default version to use for requests to the Blob service if an incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent versions.

Parameters:

defaultServiceVersion - the defaultServiceVersion value to set.

Returns:

the BlobServiceProperties object itself.

setDeleteRetentionPolicy

public BlobServiceProperties setDeleteRetentionPolicy(BlobRetentionPolicy deleteRetentionPolicy)

Set the deleteRetentionPolicy property: the retention policy which determines how long the associated data should persist.

Parameters:

deleteRetentionPolicy - the deleteRetentionPolicy value to set.

Returns:

the BlobServiceProperties object itself.

setHourMetrics

public BlobServiceProperties setHourMetrics(BlobMetrics hourMetrics)

Set the hourMetrics property: a summary of request statistics grouped by API in hour or minute aggregates for blobs.

Parameters:

hourMetrics - the hourMetrics value to set.

Returns:

the BlobServiceProperties object itself.

setLogging

public BlobServiceProperties setLogging(BlobAnalyticsLogging logging)

Set the logging property: Azure Analytics Logging settings.

Parameters:

logging - the logging value to set.

Returns:

the BlobServiceProperties object itself.

setMinuteMetrics

public BlobServiceProperties setMinuteMetrics(BlobMetrics minuteMetrics)

Set the minuteMetrics property: a summary of request statistics grouped by API in hour or minute aggregates for blobs.

Parameters:

minuteMetrics - the minuteMetrics value to set.

Returns:

the BlobServiceProperties object itself.

setStaticWebsite

public BlobServiceProperties setStaticWebsite(StaticWebsite staticWebsite)

Set the staticWebsite property: The properties that enable an account to host a static website.

Parameters:

staticWebsite - the staticWebsite value to set.

Returns:

the BlobServiceProperties object itself.

toXml

public XmlWriter toXml(XmlWriter xmlWriter)

Parameters:

xmlWriter

Throws:

toXml

public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Parameters:

xmlWriter
rootElementName

Throws:

Applies to