BlobContainerItemProperties Class

Package:

com.azure.storage.blob.models

Maven Artifact:

com.azure:azure-storage-blob:12.28.1

• java.lang.Object
• • com.azure.storage.blob.models.BlobContainerItemProperties

Implements

XmlSerializable<BlobContainerItemProperties>

public final class BlobContainerItemProperties
implements XmlSerializable<BlobContainerItemProperties>

Properties of a container.

Constructor Summary

Constructor	Description
BlobContainerItemProperties()	Creates an instance of BlobContainerItemProperties class.

Method Summary

Modifier and Type	Method and Description
static BlobContainerItemProperties	fromXml(XmlReader xmlReader) Reads an instance of BlobContainerItemProperties from the XmlReader.
static BlobContainerItemProperties	fromXml(XmlReader xmlReader, String rootElementName) Reads an instance of BlobContainerItemProperties from the XmlReader.
String	getDefaultEncryptionScope() Get the defaultEncryptionScope property: The DefaultEncryptionScope property.
OffsetDateTime	getDeletedTime() Get the deletedTime property: The DeletedTime property.
String	getETag() Get the eTag property: The Etag property.
OffsetDateTime	getLastModified() Get the lastModified property: The Last-Modified property.
LeaseDurationType	getLeaseDuration() Get the leaseDuration property: The LeaseDuration property.
LeaseStateType	getLeaseState() Get the leaseState property: The LeaseState property.
LeaseStatusType	getLeaseStatus() Get the leaseStatus property: The LeaseStatus property.
PublicAccessType	getPublicAccess() Get the publicAccess property: The PublicAccess property.
Integer	getRemainingRetentionDays() Get the remainingRetentionDays property: The RemainingRetentionDays property.
boolean	isEncryptionScopeOverridePrevented() Get the encryptionScopeOverridePrevented property: The DenyEncryptionScopeOverride property.
Boolean	isHasImmutabilityPolicy() Get the hasImmutabilityPolicy property: The HasImmutabilityPolicy property.
Boolean	isHasLegalHold() Get the hasLegalHold property: The HasLegalHold property.
Boolean	isImmutableStorageWithVersioningEnabled() Get the isImmutableStorageWithVersioningEnabled property: Indicates if version level worm is enabled on this container.
BlobContainerItemProperties	setDefaultEncryptionScope(String defaultEncryptionScope) Set the defaultEncryptionScope property: The DefaultEncryptionScope property.
BlobContainerItemProperties	setDeletedTime(OffsetDateTime deletedTime) Set the deletedTime property: The DeletedTime property.
BlobContainerItemProperties	setETag(String eTag) Set the eTag property: The Etag property.
BlobContainerItemProperties	setEncryptionScopeOverridePrevented(boolean encryptionScopeOverridePrevented) Set the encryptionScopeOverridePrevented property: The DenyEncryptionScopeOverride property.
BlobContainerItemProperties	setHasImmutabilityPolicy(Boolean hasImmutabilityPolicy) Set the hasImmutabilityPolicy property: The HasImmutabilityPolicy property.
BlobContainerItemProperties	setHasLegalHold(Boolean hasLegalHold) Set the hasLegalHold property: The HasLegalHold property.
BlobContainerItemProperties	setImmutableStorageWithVersioningEnabled(Boolean isImmutableStorageWithVersioningEnabled) Set the isImmutableStorageWithVersioningEnabled property: Indicates if version level worm is enabled on this container.
BlobContainerItemProperties	setLastModified(OffsetDateTime lastModified) Set the lastModified property: The Last-Modified property.
BlobContainerItemProperties	setLeaseDuration(LeaseDurationType leaseDuration) Set the leaseDuration property: The LeaseDuration property.
BlobContainerItemProperties	setLeaseState(LeaseStateType leaseState) Set the leaseState property: The LeaseState property.
BlobContainerItemProperties	setLeaseStatus(LeaseStatusType leaseStatus) Set the leaseStatus property: The LeaseStatus property.
BlobContainerItemProperties	setPublicAccess(PublicAccessType publicAccess) Set the publicAccess property: The PublicAccess property.
BlobContainerItemProperties	setRemainingRetentionDays(Integer remainingRetentionDays) Set the remainingRetentionDays property: The RemainingRetentionDays property.
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

BlobContainerItemProperties

public BlobContainerItemProperties()

Creates an instance of BlobContainerItemProperties class.

Method Details

fromXml

public static BlobContainerItemProperties fromXml(XmlReader xmlReader)

Reads an instance of BlobContainerItemProperties from the XmlReader.

Parameters:

xmlReader - The XmlReader being read.

Returns:

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

Throws:

XMLStreamException

- If the deserialized XML object was missing any required properties.

fromXml

public static BlobContainerItemProperties fromXml(XmlReader xmlReader, String rootElementName)

Reads an instance of BlobContainerItemProperties 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 BlobContainerItemProperties if the XmlReader was pointing to an instance of it, or null if it was pointing to XML null.

Throws:

XMLStreamException

- If the deserialized XML object was missing any required properties.

getDefaultEncryptionScope

public String getDefaultEncryptionScope()

Get the defaultEncryptionScope property: The DefaultEncryptionScope property.

Returns:

the defaultEncryptionScope value.

getDeletedTime

public OffsetDateTime getDeletedTime()

Get the deletedTime property: The DeletedTime property.

Returns:

the deletedTime value.

getETag

public String getETag()

Get the eTag property: The Etag property.

Returns:

the eTag value.

getLastModified

public OffsetDateTime getLastModified()

Get the lastModified property: The Last-Modified property.

Returns:

the lastModified value.

getLeaseDuration

public LeaseDurationType getLeaseDuration()

Get the leaseDuration property: The LeaseDuration property.

Returns:

the leaseDuration value.

getLeaseState

public LeaseStateType getLeaseState()

Get the leaseState property: The LeaseState property.

Returns:

the leaseState value.

getLeaseStatus

public LeaseStatusType getLeaseStatus()

Get the leaseStatus property: The LeaseStatus property.

Returns:

the leaseStatus value.

getPublicAccess

public PublicAccessType getPublicAccess()

Get the publicAccess property: The PublicAccess property.

Returns:

the publicAccess value.

getRemainingRetentionDays

public Integer getRemainingRetentionDays()

Get the remainingRetentionDays property: The RemainingRetentionDays property.

Returns:

the remainingRetentionDays value.

isEncryptionScopeOverridePrevented

public boolean isEncryptionScopeOverridePrevented()

Get the encryptionScopeOverridePrevented property: The DenyEncryptionScopeOverride property.

Returns:

the encryptionScopeOverridePrevented value.

isHasImmutabilityPolicy

public Boolean isHasImmutabilityPolicy()

Get the hasImmutabilityPolicy property: The HasImmutabilityPolicy property.

Returns:

the hasImmutabilityPolicy value.

isHasLegalHold

public Boolean isHasLegalHold()

Get the hasLegalHold property: The HasLegalHold property.

Returns:

the hasLegalHold value.

isImmutableStorageWithVersioningEnabled

public Boolean isImmutableStorageWithVersioningEnabled()

Get the isImmutableStorageWithVersioningEnabled property: Indicates if version level worm is enabled on this container.

Returns:

the isImmutableStorageWithVersioningEnabled value.

setDefaultEncryptionScope

public BlobContainerItemProperties setDefaultEncryptionScope(String defaultEncryptionScope)

Set the defaultEncryptionScope property: The DefaultEncryptionScope property.

Parameters:

defaultEncryptionScope - the defaultEncryptionScope value to set.

Returns:

the BlobContainerItemProperties object itself.

setDeletedTime

public BlobContainerItemProperties setDeletedTime(OffsetDateTime deletedTime)

Set the deletedTime property: The DeletedTime property.

Parameters:

deletedTime - the deletedTime value to set.

Returns:

the BlobContainerItemProperties object itself.

setETag

public BlobContainerItemProperties setETag(String eTag)

Set the eTag property: The Etag property.

Parameters:

eTag - the eTag value to set.

Returns:

the BlobContainerItemProperties object itself.

setEncryptionScopeOverridePrevented

public BlobContainerItemProperties setEncryptionScopeOverridePrevented(boolean encryptionScopeOverridePrevented)

Set the encryptionScopeOverridePrevented property: The DenyEncryptionScopeOverride property.

Parameters:

encryptionScopeOverridePrevented - the encryptionScopeOverridePrevented value to set.

Returns:

the BlobContainerItemProperties object itself.

setHasImmutabilityPolicy

public BlobContainerItemProperties setHasImmutabilityPolicy(Boolean hasImmutabilityPolicy)

Set the hasImmutabilityPolicy property: The HasImmutabilityPolicy property.

Parameters:

hasImmutabilityPolicy - the hasImmutabilityPolicy value to set.

Returns:

the BlobContainerItemProperties object itself.

setHasLegalHold

public BlobContainerItemProperties setHasLegalHold(Boolean hasLegalHold)

Set the hasLegalHold property: The HasLegalHold property.

Parameters:

hasLegalHold - the hasLegalHold value to set.

Returns:

the BlobContainerItemProperties object itself.

setImmutableStorageWithVersioningEnabled

public BlobContainerItemProperties setImmutableStorageWithVersioningEnabled(Boolean isImmutableStorageWithVersioningEnabled)

Set the isImmutableStorageWithVersioningEnabled property: Indicates if version level worm is enabled on this container.

Parameters:

isImmutableStorageWithVersioningEnabled - the isImmutableStorageWithVersioningEnabled value to set.

Returns:

the BlobContainerItemProperties object itself.

setLastModified

public BlobContainerItemProperties setLastModified(OffsetDateTime lastModified)

Set the lastModified property: The Last-Modified property.

Parameters:

lastModified - the lastModified value to set.

Returns:

the BlobContainerItemProperties object itself.

setLeaseDuration

public BlobContainerItemProperties setLeaseDuration(LeaseDurationType leaseDuration)

Set the leaseDuration property: The LeaseDuration property.

Parameters:

leaseDuration - the leaseDuration value to set.

Returns:

the BlobContainerItemProperties object itself.

setLeaseState

public BlobContainerItemProperties setLeaseState(LeaseStateType leaseState)

Set the leaseState property: The LeaseState property.

Parameters:

leaseState - the leaseState value to set.

Returns:

the BlobContainerItemProperties object itself.

setLeaseStatus

public BlobContainerItemProperties setLeaseStatus(LeaseStatusType leaseStatus)

Set the leaseStatus property: The LeaseStatus property.

Parameters:

leaseStatus - the leaseStatus value to set.

Returns:

the BlobContainerItemProperties object itself.

setPublicAccess

public BlobContainerItemProperties setPublicAccess(PublicAccessType publicAccess)

Set the publicAccess property: The PublicAccess property.

Parameters:

publicAccess - the publicAccess value to set.

Returns:

the BlobContainerItemProperties object itself.

setRemainingRetentionDays

public BlobContainerItemProperties setRemainingRetentionDays(Integer remainingRetentionDays)

Set the remainingRetentionDays property: The RemainingRetentionDays property.

Parameters:

remainingRetentionDays - the remainingRetentionDays value to set.

Returns:

the BlobContainerItemProperties object itself.

toXml

public XmlWriter toXml(XmlWriter xmlWriter)

Parameters:

xmlWriter

Throws:

XMLStreamException

toXml

public XmlWriter toXml(XmlWriter xmlWriter, String rootElementName)

Parameters:

xmlWriter

rootElementName

Throws:

XMLStreamException