getMetadata() {
}
/**
+ * Gets the eTag of the container.
+ *
* @return the eTag of the container
*/
public String getETag() {
@@ -123,6 +127,8 @@ public String getETag() {
}
/**
+ * Gets the time the container was last modified.
+ *
* @return the time the container was last modified
*/
public OffsetDateTime getLastModified() {
@@ -130,6 +136,8 @@ public OffsetDateTime getLastModified() {
}
/**
+ * Gets the type of lease on the container.
+ *
* @return the type of lease on the container
*/
public LeaseDurationType getLeaseDuration() {
@@ -137,6 +145,8 @@ public LeaseDurationType getLeaseDuration() {
}
/**
+ * Gets the lease state of the container.
+ *
* @return the lease state of the container
*/
public LeaseStateType getLeaseState() {
@@ -144,6 +154,8 @@ public LeaseStateType getLeaseState() {
}
/**
+ * Gets the lease status of the container.
+ *
* @return the lease status of the container
*/
public LeaseStatusType getLeaseStatus() {
@@ -151,6 +163,8 @@ public LeaseStatusType getLeaseStatus() {
}
/**
+ * Gets the access type for the container.
+ *
* @return the access type for the container
*/
public PublicAccessType getBlobPublicAccess() {
@@ -158,6 +172,8 @@ public PublicAccessType getBlobPublicAccess() {
}
/**
+ * Gets the immutability status for the container.
+ *
* @return the immutability status for the container
*/
public boolean hasImmutabilityPolicy() {
@@ -165,6 +181,8 @@ public boolean hasImmutabilityPolicy() {
}
/**
+ * Gets the legal hold status for the container.
+ *
* @return the legal hold status for the container
*/
public boolean hasLegalHold() {
@@ -172,6 +190,8 @@ public boolean hasLegalHold() {
}
/**
+ * Gets the container's default encryption scope.
+ *
* @return the container's default encryption scope
*/
public String getDefaultEncryptionScope() {
@@ -179,6 +199,8 @@ public String getDefaultEncryptionScope() {
}
/**
+ * Gets the container's deny encryption scope override property.
+ *
* @return the container's deny encryption scope override property.
*/
public Boolean isEncryptionScopeOverridePrevented() {
@@ -186,7 +208,9 @@ public Boolean isEncryptionScopeOverridePrevented() {
}
/**
- * @return Whether or not immutable storage with versioning is enabled on this container.
+ * Gets whether immutable storage with versioning is enabled on this container.
+ *
+ * @return Whether immutable storage with versioning is enabled on this container.
*/
public Boolean isImmutableStorageWithVersioningEnabled() {
return isImmutableStorageWithVersioningEnabled;
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobCopyInfo.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobCopyInfo.java
index d92090e21574f..045ba5eea545f 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobCopyInfo.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobCopyInfo.java
@@ -36,9 +36,8 @@ public class BlobCopyInfo {
* @param copyStatus The status of the copy operation.
* @param error An error message for the copy operation. {@code null} if there are no errors.
* @param eTag If the copy is completed, contains the ETag of the destination blob. If the copy is not complete,
- * contains the ETag of the empty blob created.
+ * contains the ETag of the empty blob created.
* @param lastModified The date/time that the copy operation to the destination blob completed.
- *
* @throws NullPointerException If {@code copyId}, {@code copySource}, {@code eTag}, or {@code copyStatus} is null.
*/
public BlobCopyInfo(String copySource, String copyId, CopyStatusType copyStatus, String eTag,
@@ -54,10 +53,9 @@ public BlobCopyInfo(String copySource, String copyId, CopyStatusType copyStatus,
* @param copyStatus The status of the copy operation.
* @param error An error message for the copy operation. {@code null} if there are no errors.
* @param eTag If the copy is completed, contains the ETag of the destination blob. If the copy is not complete,
- * contains the ETag of the empty blob created.
+ * contains the ETag of the empty blob created.
* @param lastModified The date/time that the copy operation to the destination blob completed.
* @param versionId The version identifier of the destination blob.
- *
* @throws NullPointerException If {@code copyId}, {@code copySource}, {@code eTag}, or {@code copyStatus} is null.
*/
public BlobCopyInfo(String copySource, String copyId, CopyStatusType copyStatus, String eTag,
@@ -73,11 +71,10 @@ public BlobCopyInfo(String copySource, String copyId, CopyStatusType copyStatus,
* @param copyStatus The status of the copy operation.
* @param error An error message for the copy operation. {@code null} if there are no errors.
* @param eTag If the copy is completed, contains the ETag of the destination blob. If the copy is not complete,
- * contains the ETag of the empty blob created.
+ * contains the ETag of the empty blob created.
* @param lastModified The date/time that the copy operation to the destination blob completed.
* @param versionId The version identifier of the destination blob.
* @param encryptionScope The encryptionScope that will be applied to the destination blob.
- *
* @throws NullPointerException If {@code copyId}, {@code copySource}, {@code eTag}, or {@code copyStatus} is null.
*/
public BlobCopyInfo(String copySource, String copyId, CopyStatusType copyStatus, String eTag,
@@ -123,7 +120,7 @@ public CopyStatusType getCopyStatus() {
* Gets an error description associated with the copy operation.
*
* @return An error description associated with the copy, or {@code null} if there is no error associated with this
- * copy operation.
+ * copy operation.
*/
public String getError() {
return error;
@@ -141,7 +138,7 @@ public OffsetDateTime getLastModified() {
/**
* If the copy is complete, contains the ETag of the destination blob. If the copy isn't complete, contains the
* ETag of the empty blob created at the start of the copy.
- *
+ *
* The ETag value will be in quotes.
*
* @return The ETag for the copy.
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobImmutabilityPolicy.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobImmutabilityPolicy.java
index c146ca0bafac2..edb18e7328fc1 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobImmutabilityPolicy.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobImmutabilityPolicy.java
@@ -9,11 +9,18 @@
* Optional parameters for setting the immutability policy of a blob, blob snapshot or blob version.
*/
public final class BlobImmutabilityPolicy {
-
private OffsetDateTime expiryTime;
private BlobImmutabilityPolicyMode policyMode;
/**
+ * Creates an instance of {@link BlobImmutabilityPolicy}.
+ */
+ public BlobImmutabilityPolicy() {
+ }
+
+ /**
+ * Gets the time when the immutability policy expires.
+ *
* @return The time when the immutability policy expires.
*/
public OffsetDateTime getExpiryTime() {
@@ -21,6 +28,8 @@ public OffsetDateTime getExpiryTime() {
}
/**
+ * Sets the time when the immutability policy expires.
+ *
* @param expiryTime The time when the immutability policy expires.
* @return The updated BlobImmutabilityPolicy
*/
@@ -30,6 +39,8 @@ public BlobImmutabilityPolicy setExpiryTime(OffsetDateTime expiryTime) {
}
/**
+ * Gets the immutability policy mode.
+ *
* @return The immutability policy mode.
*/
public BlobImmutabilityPolicyMode getPolicyMode() {
@@ -37,6 +48,8 @@ public BlobImmutabilityPolicyMode getPolicyMode() {
}
/**
+ * Sets the immutability policy mode.
+ *
* @param policyMode The immutability policy mode.
* @return The updated BlobImmutabilityPolicy
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobItem.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobItem.java
index 11c9ed3c1dc03..7b3558005a5ea 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobItem.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobItem.java
@@ -43,11 +43,8 @@ public BlobItem() {
}
private String convertedName;
-
private BlobItemProperties convertedProperties;
-
private Map convertedTags;
-
private List convertedObjectReplicationSourcePolicies;
/**
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobLeaseRequestConditions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobLeaseRequestConditions.java
index 1186142eb7573..5d85b00936c92 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobLeaseRequestConditions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobLeaseRequestConditions.java
@@ -16,6 +16,12 @@
public class BlobLeaseRequestConditions extends RequestConditions {
private String tagsConditions;
+ /**
+ * Creates a new instance of {@link BlobLeaseRequestConditions}.
+ */
+ public BlobLeaseRequestConditions() {
+ }
+
/**
* Optionally limit requests to resources that match the passed ETag.
*
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobLegalHoldResult.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobLegalHoldResult.java
index a174a24933c2a..1f0dfcaaad7c0 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobLegalHoldResult.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobLegalHoldResult.java
@@ -7,9 +7,10 @@
* The blob legal hold result.
*/
public interface BlobLegalHoldResult {
-
/**
- * @return whether or not a legal hold is enabled on the blob.
+ * Gets whether a legal hold is enabled on the blob.
+ *
+ * @return whether a legal hold is enabled on the blob.
*/
boolean hasLegalHold();
}
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobListDetails.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobListDetails.java
index c1b36ec712a06..0604674640503 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobListDetails.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobListDetails.java
@@ -236,6 +236,8 @@ public BlobListDetails setRetrieveLegalHold(boolean retrieveLegalHold) {
}
/**
+ * Gets the list of flags set to true.
+ *
* @return a list of the flag set to true
*/
public ArrayList toList() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobPrefix.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobPrefix.java
index ad8fe1134aeeb..6ee8ae5579da7 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobPrefix.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobPrefix.java
@@ -22,6 +22,12 @@ public final class BlobPrefix implements XmlSerializable {
*/
private String name;
+ /**
+ * Creates an instance of BlobPrefix.
+ */
+ public BlobPrefix() {
+ }
+
/**
* Get the name property: The Name property.
*
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobProperties.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobProperties.java
index c7526cc46cfb4..b62ecc33861ac 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobProperties.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobProperties.java
@@ -453,6 +453,8 @@ public BlobProperties(final OffsetDateTime creationTime, final OffsetDateTime la
}
/**
+ * Gets the time when the blob was created.
+ *
* @return the time when the blob was created
*/
public OffsetDateTime getCreationTime() {
@@ -460,6 +462,8 @@ public OffsetDateTime getCreationTime() {
}
/**
+ * Gets the time when the blob was last modified.
+ *
* @return the time when the blob was last modified
*/
public OffsetDateTime getLastModified() {
@@ -467,6 +471,8 @@ public OffsetDateTime getLastModified() {
}
/**
+ * Gets the eTag of the blob.
+ *
* @return the eTag of the blob
*/
public String getETag() {
@@ -474,6 +480,8 @@ public String getETag() {
}
/**
+ * Gets the size of the blob in bytes.
+ *
* @return the size of the blob in bytes
*/
public long getBlobSize() {
@@ -481,6 +489,8 @@ public long getBlobSize() {
}
/**
+ * Gets the content type of the blob.
+ *
* @return the content type of the blob
*/
public String getContentType() {
@@ -488,6 +498,8 @@ public String getContentType() {
}
/**
+ * Gets the MD5 of the blob's content.
+ *
* @return the MD5 of the blob's content
*/
public byte[] getContentMd5() {
@@ -495,6 +507,8 @@ public byte[] getContentMd5() {
}
/**
+ * Gets the content encoding of the blob.
+ *
* @return the content encoding of the blob
*/
public String getContentEncoding() {
@@ -502,6 +516,8 @@ public String getContentEncoding() {
}
/**
+ * Gets the content disposition of the blob.
+ *
* @return the content disposition of the blob
*/
public String getContentDisposition() {
@@ -509,6 +525,8 @@ public String getContentDisposition() {
}
/**
+ * Gets the content language of the blob.
+ *
* @return the content language of the blob
*/
public String getContentLanguage() {
@@ -516,6 +534,8 @@ public String getContentLanguage() {
}
/**
+ * Gets the cache control of the blob.
+ *
* @return the cache control of the blob
*/
public String getCacheControl() {
@@ -523,6 +543,8 @@ public String getCacheControl() {
}
/**
+ * Gets the current sequence number of the page blob. This is only returned for page blobs.
+ *
* @return the current sequence number of the page blob. This is only returned for page blobs.
*/
public Long getBlobSequenceNumber() {
@@ -530,6 +552,8 @@ public Long getBlobSequenceNumber() {
}
/**
+ * Gets the type of the blob.
+ *
* @return the type of the blob
*/
public BlobType getBlobType() {
@@ -537,6 +561,8 @@ public BlobType getBlobType() {
}
/**
+ * Gets the lease status of the blob.
+ *
* @return the lease status of the blob
*/
public LeaseStatusType getLeaseStatus() {
@@ -544,6 +570,8 @@ public LeaseStatusType getLeaseStatus() {
}
/**
+ * Gets the lease state of the blob.
+ *
* @return the lease state of the blob
*/
public LeaseStateType getLeaseState() {
@@ -551,6 +579,8 @@ public LeaseStateType getLeaseState() {
}
/**
+ * Gets the lease duration of the blob, if the blob is leased.
+ *
* @return the lease duration if the blob is leased
*/
public LeaseDurationType getLeaseDuration() {
@@ -558,6 +588,8 @@ public LeaseDurationType getLeaseDuration() {
}
/**
+ * Gets the identifier of the last copy operation.
+ *
* @return the identifier of the last copy operation. If this blob hasn't been the target of a copy operation or has
* been modified since this won't be set.
*/
@@ -566,6 +598,8 @@ public String getCopyId() {
}
/**
+ * Gets the status of the last copy operation.
+ *
* @return the status of the last copy operation. If this blob hasn't been the target of a copy operation or has
* been modified since this won't be set.
*/
@@ -574,6 +608,8 @@ public CopyStatusType getCopyStatus() {
}
/**
+ * Gets the source blob URL from the last copy operation.
+ *
* @return the source blob URL from the last copy operation. If this blob hasn't been the target of a copy operation
* or has been modified since this won't be set.
*/
@@ -582,6 +618,8 @@ public String getCopySource() {
}
/**
+ * Gets the progress of the last copy operation.
+ *
* @return the number of bytes copied and total bytes in the source from the last copy operation (bytes copied/total
* bytes). If this blob hasn't been the target of a copy operation or has been modified since this won't be set.
*/
@@ -590,6 +628,8 @@ public String getCopyProgress() {
}
/**
+ * Gets the completion time of the last copy operation.
+ *
* @return the completion time of the last copy operation. If this blob hasn't been the target of a copy operation
* or has been modified since this won't be set.
*/
@@ -598,6 +638,8 @@ public OffsetDateTime getCopyCompletionTime() {
}
/**
+ * Gets the description of the last copy failure.
+ *
* @return the description of the last copy failure, this is set when the {@link #getCopyStatus() getCopyStatus} is
* {@link CopyStatusType#FAILED failed} or {@link CopyStatusType#ABORTED aborted}. If this blob hasn't been the
* target of a copy operation or has been modified since this won't be set.
@@ -607,6 +649,8 @@ public String getCopyStatusDescription() {
}
/**
+ * Gets the status of the blob being encrypted on the server.
+ *
* @return the status of the blob being encrypted on the server
*/
public Boolean isServerEncrypted() {
@@ -614,6 +658,8 @@ public Boolean isServerEncrypted() {
}
/**
+ * Gets the status of the blob being an incremental copy blob.
+ *
* @return the status of the blob being an incremental copy blob
*/
public Boolean isIncrementalCopy() {
@@ -621,6 +667,8 @@ public Boolean isIncrementalCopy() {
}
/**
+ * Gets the snapshot time of the last successful incremental copy snapshot for this blob.
+ *
* @return the snapshot time of the last successful incremental copy snapshot for this blob. If this blob isn't an
* incremental copy blob or incremental copy snapshot or {@link #getCopyStatus() getCopyStatus} isn't {@link
* CopyStatusType#SUCCESS success} this won't be set.
@@ -630,6 +678,8 @@ public String getCopyDestinationSnapshot() {
}
/**
+ * Gets the access tier of the blob.
+ *
* @return the tier of the blob. This is only set for Page blobs on a premium storage account or for Block blobs on
* blob storage or general purpose V2 account.
*/
@@ -638,6 +688,8 @@ public AccessTier getAccessTier() {
}
/**
+ * Gets the status of the tier being inferred for the blob.
+ *
* @return the status of the tier being inferred for the blob. This is only set for Page blobs on a premium storage
* account or for Block blobs on blob storage or general purpose V2 account.
*/
@@ -646,6 +698,8 @@ public Boolean isAccessTierInferred() {
}
/**
+ * Gets the archive status of the blob.
+ *
* @return the archive status of the blob. This is only for blobs on a blob storage and general purpose v2 account.
*/
public ArchiveStatus getArchiveStatus() {
@@ -653,6 +707,8 @@ public ArchiveStatus getArchiveStatus() {
}
/**
+ * Gets the SHA256 of the customer provided encryption key used to encrypt the blob on the server.
+ *
* @return the key used to encrypt the blob
*/
public String getEncryptionKeySha256() {
@@ -660,6 +716,8 @@ public String getEncryptionKeySha256() {
}
/**
+ * Gets the name of the encryption scope under which the blob is encrypted.
+ *
* @return The name of the encryption scope under which the blob is encrypted.
*/
public String getEncryptionScope() {
@@ -667,6 +725,8 @@ public String getEncryptionScope() {
}
/**
+ * Gets the time when the access tier for the blob was last changed.
+ *
* @return the time when the access tier for the blob was last changed
*/
public OffsetDateTime getAccessTierChangeTime() {
@@ -674,6 +734,8 @@ public OffsetDateTime getAccessTierChangeTime() {
}
/**
+ * Gets the metadata associated with this blob.
+ *
* @return the metadata associated with this blob
*/
public Map getMetadata() {
@@ -681,6 +743,8 @@ public Map getMetadata() {
}
/**
+ * Gets the number of committed blocks in the blob. This is only returned for Append blobs.
+ *
* @return the number of committed blocks in the blob. This is only returned for Append blobs.
*/
public Integer getCommittedBlockCount() {
@@ -688,6 +752,8 @@ public Integer getCommittedBlockCount() {
}
/**
+ * Gets the number of tags associated with the blob.
+ *
* @return The number of tags associated with the blob.
*/
public Long getTagCount() {
@@ -695,6 +761,8 @@ public Long getTagCount() {
}
/**
+ * Gets the version identifier of the blob.
+ *
* @return the version identifier the blob.
*/
public String getVersionId() {
@@ -702,6 +770,8 @@ public String getVersionId() {
}
/**
+ * Gets the flag indicating whether version identifier points to current version of the blob.
+ *
* @return the flag indicating whether version identifier points to current version of the blob.
*/
public Boolean isCurrentVersion() {
@@ -709,6 +779,9 @@ public Boolean isCurrentVersion() {
}
/**
+ * Gets a {@link List} that contains information on the object replication policies associated with this blob and
+ * the status of the replication for each policy. Only available when the blob is the source of object replication.
+ *
* @return a {@link List} that contains information on the object replication policies associated with this blob and
* the status of the replication for each policy. Only available when the blob is the source of object replication.
*/
@@ -717,14 +790,17 @@ public List getObjectReplicationSourcePolicies() {
}
/**
- * @return a {@code String} that identifies the Object Replication Policy which made this blob the destination of a
- * copy.
+ * Gets a string that identifies the Object Replication Policy which made this blob the destination of a copy.
+ *
+ * @return a string that identifies the Object Replication Policy which made this blob the destination of a copy.
*/
public String getObjectReplicationDestinationPolicyId() {
return this.internalProperties.getObjectReplicationDestinationPolicyId();
}
/**
+ * Gets the {@link RehydratePriority} of the blob if it is in RehydratePending state.
+ *
* @return The {@link RehydratePriority} of the blob if it is in RehydratePending state.
*/
public RehydratePriority getRehydratePriority() {
@@ -732,6 +808,8 @@ public RehydratePriority getRehydratePriority() {
}
/**
+ * Gets the flag indicating whether this blob has been sealed (marked as read only). This is only returned for
+ * Append blobs.
* @return the flag indicating whether this blob has been sealed (marked as read only). This is only returned for
* Append blobs.
*/
@@ -740,13 +818,17 @@ public Boolean isSealed() {
}
/**
- * @return The date and time the blob was read or written to.
+ * Gets the date and time the blob was last read or written to.
+ *
+ * @return The date and time the blob was last read or written to.
*/
public OffsetDateTime getLastAccessedTime() {
return internalProperties.getLastAccessedTime();
}
/**
+ * Gets the time when the blob is going to expire.
+ *
* @return the time when the blob is going to expire.
*/
public OffsetDateTime getExpiresOn() {
@@ -754,6 +836,8 @@ public OffsetDateTime getExpiresOn() {
}
/**
+ * Gets the immutability policy of the blob.
+ *
* @return the immutability policy.
*/
public BlobImmutabilityPolicy getImmutabilityPolicy() {
@@ -761,6 +845,8 @@ public BlobImmutabilityPolicy getImmutabilityPolicy() {
}
/**
+ * Gets the legal hold status of the blob.
+ *
* @return whether the blob has a legal hold.
*/
public Boolean hasLegalHold() {
@@ -768,6 +854,8 @@ public Boolean hasLegalHold() {
}
/**
+ * Gets the request id.
+ *
* @return the x-ms-request id header value.
*/
public String getRequestId() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryArrowField.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryArrowField.java
index 300d3c111ca18..ab5fef25091c8 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryArrowField.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryArrowField.java
@@ -11,13 +11,14 @@
*/
@Fluent
public class BlobQueryArrowField {
-
private String name;
private Integer precision;
private Integer scale;
private final BlobQueryArrowFieldType type;
/**
+ * Creates a new instance of {@link BlobQueryArrowField}.
+ *
* @param type {@link BlobQueryArrowFieldType}
*/
public BlobQueryArrowField(BlobQueryArrowFieldType type) {
@@ -26,6 +27,8 @@ public BlobQueryArrowField(BlobQueryArrowFieldType type) {
}
/**
+ * Sets the name of the field.
+ *
* @param name The name of the field.
* @return The updated options.
*/
@@ -35,6 +38,8 @@ public BlobQueryArrowField setName(String name) {
}
/**
+ * Sets the precision of the field. Required if type is {@link BlobQueryArrowFieldType#DECIMAL}.
+ *
* @param precision The precision of the field. Required if type is {@link BlobQueryArrowFieldType#DECIMAL}
* @return The updated options.
*/
@@ -44,6 +49,8 @@ public BlobQueryArrowField setPrecision(Integer precision) {
}
/**
+ * Sets the scale of the field. Required if type is {@link BlobQueryArrowFieldType#DECIMAL}.
+ *
* @param scale The scale of the field. Required if type is {@link BlobQueryArrowFieldType#DECIMAL}
* @return The updated options.
*/
@@ -53,6 +60,8 @@ public BlobQueryArrowField setScale(Integer scale) {
}
/**
+ * Gets the name.
+ *
* @return The name.
*/
public String getName() {
@@ -60,6 +69,8 @@ public String getName() {
}
/**
+ * Gets the precision.
+ *
* @return The precision.
*/
public Integer getPrecision() {
@@ -67,6 +78,8 @@ public Integer getPrecision() {
}
/**
+ * Gets the scale.
+ *
* @return The scale.
*/
public Integer getScale() {
@@ -74,6 +87,8 @@ public Integer getScale() {
}
/**
+ * Gets the {@link BlobQueryArrowFieldType}.
+ *
* @return {@link BlobQueryArrowFieldType}
*/
public BlobQueryArrowFieldType getType() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryArrowSerialization.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryArrowSerialization.java
index 949cc3ac33854..66f921a3f9e1d 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryArrowSerialization.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryArrowSerialization.java
@@ -10,9 +10,14 @@
* Defines the output arrow serialization for a blob quick query request.
*/
public class BlobQueryArrowSerialization implements BlobQuerySerialization {
-
private List schema;
+ /**
+ * Creates a new instance of {@link BlobQueryArrowSerialization}.
+ */
+ public BlobQueryArrowSerialization() {
+ }
+
/**
* Gets the arrow fields.
*
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryDelimitedSerialization.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryDelimitedSerialization.java
index f301c1474431d..d1dc568d581d5 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryDelimitedSerialization.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryDelimitedSerialization.java
@@ -7,13 +7,18 @@
* Defines the input or output delimited (CSV) serialization for a blob quick query request.
*/
public class BlobQueryDelimitedSerialization implements BlobQuerySerialization {
-
private char columnSeparator;
private char fieldQuote;
private char escapeChar;
private boolean headersPresent;
private char recordSeparator;
+ /**
+ * Creates a new instance of {@link BlobQueryDelimitedSerialization}.
+ */
+ public BlobQueryDelimitedSerialization() {
+ }
+
/**
* Gets the column separator.
* @return the column separator.
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryError.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryError.java
index 4d11a2f78dbc6..0c9341950e5b3 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryError.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryError.java
@@ -15,7 +15,7 @@ public class BlobQueryError {
/**
* Creates a new BlobQueryError object.
- * @param fatal Whether or not the error is fatal.
+ * @param fatal Whether the error is fatal.
* @param name The name of the error.
* @param description A description of the error.
* @param position The blob offset at which the error occurred.
@@ -28,16 +28,19 @@ public BlobQueryError(boolean fatal, String name, String description, long posit
}
/**
- * Whether or not the error is fatal. If true, this error prevents further query processing. More result data may
- * be returned, but there is no guarantee that all of the original data will be processed. If false, this error
- * does not prevent further query processing.
- * @return Whether or not the error is fatal.
+ * Whether the error is fatal. If true, this error prevents further query processing. More result data may be
+ * returned, but there is no guarantee that all the original data will be processed. If false, this error does not
+ * prevent further query processing.
+ *
+ * @return Whether the error is fatal.
*/
public boolean isFatal() {
return fatal;
}
/**
+ * Gets the name of the error.
+ *
* @return The name of the error.
*/
public String getName() {
@@ -45,6 +48,7 @@ public String getName() {
}
/**
+ * Gets a description of the error.
*
* @return A description of the error.
*/
@@ -53,6 +57,8 @@ public String getDescription() {
}
/**
+ * Gets the blob offset at which the error occurred.
+ *
* @return The blob offset at which the error occurred.
*/
public long getPosition() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryJsonSerialization.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryJsonSerialization.java
index 60aa2ac3cd22a..7e354ce730b2b 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryJsonSerialization.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryJsonSerialization.java
@@ -7,9 +7,14 @@
* Defines the input or output JSON serialization for a blob quick query request.
*/
public class BlobQueryJsonSerialization implements BlobQuerySerialization {
-
private char recordSeparator;
+ /**
+ * Creates a new instance of {@link BlobQueryJsonSerialization}.
+ */
+ public BlobQueryJsonSerialization() {
+ }
+
/**
* Gets the record separator.
*
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryParquetSerialization.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryParquetSerialization.java
index 8ec545e7b521c..5064bbf09f79a 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryParquetSerialization.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryParquetSerialization.java
@@ -7,4 +7,9 @@
* Defines the input parquet serialization for a blob quick query request.
*/
public final class BlobQueryParquetSerialization implements BlobQuerySerialization {
+ /**
+ * Creates a new instance of {@link BlobQueryParquetSerialization}.
+ */
+ public BlobQueryParquetSerialization() {
+ }
}
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryProgress.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryProgress.java
index bb8f9b8ac0ab4..56bc23a73d2a3 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryProgress.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobQueryProgress.java
@@ -7,7 +7,6 @@
* Defines a blob query error that can be returned on parsing a blob query request.
*/
public class BlobQueryProgress {
-
private final long bytesScanned;
private final long totalBytes;
@@ -22,6 +21,8 @@ public BlobQueryProgress(long bytesScanned, long totalBytes) {
}
/**
+ * Gets the number of bytes scanned so far.
+ *
* @return The number of bytes scanned so far.
*/
public long getBytesScanned() {
@@ -29,6 +30,8 @@ public long getBytesScanned() {
}
/**
+ * Gets the total number of bytes in the blob.
+ *
* @return The total number of bytes in the blob.
*/
public long getTotalBytes() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobRange.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobRange.java
index 1dea6f29e2529..74a6cb52fe55c 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobRange.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobRange.java
@@ -70,7 +70,9 @@ public Long getCount() {
}
/**
- * @return A {@code String} compliant with the format of the Azure Storage x-ms-range and Range headers.
+ * Gets a string compliant the format of the Azure Storage x-ms-range and Range headers.
+ *
+ * @return A string compliant with the format of the Azure Storage x-ms-range and Range headers.
*/
@Override
public String toString() {
@@ -83,6 +85,9 @@ public String toString() {
}
/**
+ * Gets a string compliant with the format of the Azure Storage x-ms-range and Range headers if {@code count} isn't
+ * {@code null} or {@code offset} isn't 0, otherwise null.
+ *
* @return {@link BlobRange#toString()} if {@code count} isn't {@code null} or {@code offset} isn't 0, otherwise
* null.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobRequestConditions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobRequestConditions.java
index fa62aec7b3d6f..8921d19823bbe 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobRequestConditions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobRequestConditions.java
@@ -17,6 +17,12 @@
public class BlobRequestConditions extends BlobLeaseRequestConditions {
private String leaseId;
+ /**
+ * Creates a new instance of {@link BlobRequestConditions}.
+ */
+ public BlobRequestConditions() {
+ }
+
/**
* Optionally limit requests to resources that match the passed ETag.
*
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobSeekableByteChannelReadResult.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobSeekableByteChannelReadResult.java
index 16158e4370f39..4c3d29b159c6c 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobSeekableByteChannelReadResult.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobSeekableByteChannelReadResult.java
@@ -13,6 +13,8 @@ public final class BlobSeekableByteChannelReadResult {
private final BlobProperties properties;
/**
+ * Creates a new instance of {@link BlobSeekableByteChannelReadResult}.
+ *
* @param channel Channel to read the target blob.
* @param properties Blob properties of the target blob.
*/
@@ -22,6 +24,8 @@ public BlobSeekableByteChannelReadResult(SeekableByteChannel channel, BlobProper
}
/**
+ * Gets the channel to read the target blob.
+ *
* @return Channel to read the target blob.
*/
public SeekableByteChannel getChannel() {
@@ -29,6 +33,8 @@ public SeekableByteChannel getChannel() {
}
/**
+ * Gets the blob properties of the target blob.
+ *
* @return Blob properties of the target blob.
*/
public BlobProperties getProperties() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobStorageException.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobStorageException.java
index 16cafce29945c..18206a4618ec5 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobStorageException.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlobStorageException.java
@@ -35,6 +35,8 @@ public BlobStorageException(String message, HttpResponse response, Object value)
}
/**
+ * Gets the error code returned by the service.
+ *
* @return The error code returned by the service.
*/
public BlobErrorCode getErrorCode() {
@@ -42,6 +44,8 @@ public BlobErrorCode getErrorCode() {
}
/**
+ * Gets the message returned by the service.
+ *
* @return The message returned by the service.
*/
public String getServiceMessage() {
@@ -49,6 +53,8 @@ public String getServiceMessage() {
}
/**
+ * Gets the status code on the response.
+ *
* @return The status code on the response.
*/
public int getStatusCode() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlockBlobItem.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlockBlobItem.java
index 0cf32e956674b..bdad9c9632086 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlockBlobItem.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/BlockBlobItem.java
@@ -98,6 +98,8 @@ public BlockBlobItem(final String eTag, final OffsetDateTime lastModified, final
}
/**
+ * Gets the eTag of the block blob.
+ *
* @return the eTag of the block blob
*/
public String getETag() {
@@ -105,6 +107,8 @@ public String getETag() {
}
/**
+ * Gets the last time the block blob was modified.
+ *
* @return the last time the block blob was modified
*/
public OffsetDateTime getLastModified() {
@@ -112,6 +116,8 @@ public OffsetDateTime getLastModified() {
}
/**
+ * Gets the encryption status of the block blob on the server.
+ *
* @return the encryption status of the block blob on the server
*/
public Boolean isServerEncrypted() {
@@ -119,6 +125,8 @@ public Boolean isServerEncrypted() {
}
/**
+ * Gets the key used to encrypt the block blob.
+ *
* @return the key used to encrypt the block blob
*/
public String getEncryptionKeySha256() {
@@ -126,6 +134,8 @@ public String getEncryptionKeySha256() {
}
/**
+ * Gets the encryption scope used to encrypt the block blob.
+ *
* @return the encryption scope used to encrypt the block blob
*/
public String getEncryptionScope() {
@@ -133,6 +143,8 @@ public String getEncryptionScope() {
}
/**
+ * Gets the MD5 of the block blob's content.
+ *
* @return the MD5 of the block blob's comment
*/
public byte[] getContentMd5() {
@@ -140,6 +152,8 @@ public byte[] getContentMd5() {
}
/**
+ * Gets the version identifier of the block blob.
+ *
* @return the version identifier of the block blob
*/
public String getVersionId() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/DownloadRetryOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/DownloadRetryOptions.java
index e4e0d3c064442..7ca94e8f37712 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/DownloadRetryOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/DownloadRetryOptions.java
@@ -19,12 +19,18 @@ public final class DownloadRetryOptions {
private static final ClientLogger LOGGER = new ClientLogger(DownloadRetryOptions.class);
/*
- We use "retry" here because by the time the user passes this type, the initial request, or try, has already been
- issued and returned. This is in contrast to the retry policy options, which includes the initial try in its count,
- thus the difference in verbiage.
+ * We use "retry" here because by the time the user passes this type, the initial request, or try, has already been
+ * issued and returned. This is in contrast to the retry policy options, which includes the initial try in its
+ * count, thus the difference in verbiage.
*/
private int maxRetryRequests = 5;
+ /**
+ * Creates a new instance of {@link DownloadRetryOptions}.
+ */
+ public DownloadRetryOptions() {
+ }
+
/**
* Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a
* response body.
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ListBlobContainersOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ListBlobContainersOptions.java
index 67309be0d0c7c..801b0eb87358a 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ListBlobContainersOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ListBlobContainersOptions.java
@@ -17,9 +17,7 @@ public final class ListBlobContainersOptions {
private static final ClientLogger LOGGER = new ClientLogger(ListBlobContainersOptions.class);
private BlobContainerListDetails details;
-
private String prefix;
-
private Integer maxResultsPerPage;
/**
@@ -30,6 +28,8 @@ public ListBlobContainersOptions() {
}
/**
+ * Gets the details for listing specific containers.
+ *
* @return the details for listing specific containers
*/
public BlobContainerListDetails getDetails() {
@@ -37,6 +37,8 @@ public BlobContainerListDetails getDetails() {
}
/**
+ * Sets the details for listing specific containers.
+ *
* @param details The details for listing specific containers
* @return the updated ListBlobContainersOptions object
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ListBlobsOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ListBlobsOptions.java
index 234fa9cc49231..d33edff1afa57 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ListBlobsOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ListBlobsOptions.java
@@ -16,9 +16,7 @@ public final class ListBlobsOptions {
private static final ClientLogger LOGGER = new ClientLogger(ListBlobsOptions.class);
private BlobListDetails details;
-
private String prefix;
-
private Integer maxResultsPerPage;
/**
@@ -29,6 +27,8 @@ public ListBlobsOptions() {
}
/**
+ * Gets the details for listing specific blobs.
+ *
* @return the details for listing specific blobs
*/
public BlobListDetails getDetails() {
@@ -36,6 +36,8 @@ public BlobListDetails getDetails() {
}
/**
+ * Sets the details for listing specific blobs.
+ *
* @param details The details for listing specific blobs
* @return the updated ListBlobsOptions object
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ObjectReplicationPolicy.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ObjectReplicationPolicy.java
index e7fca3feb01ee..8e6ee7f57afc1 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ObjectReplicationPolicy.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ObjectReplicationPolicy.java
@@ -14,7 +14,6 @@
*/
@Immutable
public class ObjectReplicationPolicy {
-
private final String policyId;
private final List objectReplicationRules;
@@ -30,6 +29,8 @@ public ObjectReplicationPolicy(String policyId, List rule
}
/**
+ * Gets the policy id.
+ *
* @return The policy id.
*/
public String getPolicyId() {
@@ -37,8 +38,9 @@ public String getPolicyId() {
}
/**
- * @return A {@code List} of rules associated with this policy to the status of the replication associated with that
- * rule.
+ * Gets the rules associated with this policy to the status of the replication associated with that rule.
+ *
+ * @return The rules associated with this policy to the status of the replication associated with that rule.
*/
public List getRules() {
return this.objectReplicationRules;
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ObjectReplicationRule.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ObjectReplicationRule.java
index 1a6ea65a6fbd6..a803757f919da 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ObjectReplicationRule.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ObjectReplicationRule.java
@@ -7,7 +7,6 @@
* A type that contains information about an object replication rule on a source blob.
*/
public class ObjectReplicationRule {
-
private final String ruleId;
private final ObjectReplicationStatus status;
@@ -22,6 +21,8 @@ public ObjectReplicationRule(String ruleId, ObjectReplicationStatus status) {
}
/**
+ * Gets the rule id.
+ *
* @return The rule id.
*/
public String getRuleId() {
@@ -29,6 +30,8 @@ public String getRuleId() {
}
/**
+ * Gets the {@link ObjectReplicationStatus}
+ *
* @return The {@link ObjectReplicationStatus}
*/
public ObjectReplicationStatus getStatus() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ObjectReplicationStatus.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ObjectReplicationStatus.java
index 59181d74ddd97..295f98c9b3288 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ObjectReplicationStatus.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ObjectReplicationStatus.java
@@ -21,6 +21,15 @@ public final class ObjectReplicationStatus extends ExpandableStringEnum values() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/PageBlobCopyIncrementalRequestConditions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/PageBlobCopyIncrementalRequestConditions.java
index 9bc3b9704a56c..6f74ecd26131b 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/PageBlobCopyIncrementalRequestConditions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/PageBlobCopyIncrementalRequestConditions.java
@@ -16,6 +16,12 @@
public class PageBlobCopyIncrementalRequestConditions extends RequestConditions {
private String tagsConditions;
+ /**
+ * Creates a new instance of {@link PageBlobCopyIncrementalRequestConditions}.
+ */
+ public PageBlobCopyIncrementalRequestConditions() {
+ }
+
/**
* Optionally limit requests to resources that match the passed ETag.
*
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/PageBlobItem.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/PageBlobItem.java
index f420a6b71acc9..ef127458a57a3 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/PageBlobItem.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/PageBlobItem.java
@@ -81,6 +81,8 @@ public PageBlobItem(final String eTag, final OffsetDateTime lastModified, final
}
/**
+ * Gets the eTag of the page blob.
+ *
* @return the eTag of the page blob
*/
public String getETag() {
@@ -88,6 +90,8 @@ public String getETag() {
}
/**
+ * Gets the time this page blob was last modified.
+ *
* @return the time this page blob was last modified
*/
public OffsetDateTime getLastModified() {
@@ -95,6 +99,8 @@ public OffsetDateTime getLastModified() {
}
/**
+ * Gets the encryption status of the page blob on the server.
+ *
* @return the encryption status of the page blob on the server
*/
public Boolean isServerEncrypted() {
@@ -102,6 +108,8 @@ public Boolean isServerEncrypted() {
}
/**
+ * Gets the key used to encrypt the page blob.
+ *
* @return the key used to encrypt the page blob
*/
public String getEncryptionKeySha256() {
@@ -109,6 +117,8 @@ public String getEncryptionKeySha256() {
}
/**
+ * Gets the encryption scope used to encrypt the page blob.
+ *
* @return the encryption scope used to encrypt the page blob
*/
public String getEncryptionScope() {
@@ -116,6 +126,8 @@ public String getEncryptionScope() {
}
/**
+ * Gets the MD5 of the page blob's content.
+ *
* @return the MD5 of the page blob's content
*/
public byte[] getContentMd5() {
@@ -123,6 +135,8 @@ public byte[] getContentMd5() {
}
/**
+ * Gets the current sequence number of the page blob.
+ *
* @return the current sequence number of the page blob
*/
public Long getBlobSequenceNumber() {
@@ -130,6 +144,8 @@ public Long getBlobSequenceNumber() {
}
/**
+ * Gets the version identifier of the page blob.
+ *
* @return the version identifier of the page blob
*/
public String getVersionId() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/PageBlobRequestConditions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/PageBlobRequestConditions.java
index 680c918ca9bef..356005a9d2449 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/PageBlobRequestConditions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/PageBlobRequestConditions.java
@@ -20,6 +20,12 @@ public final class PageBlobRequestConditions extends BlobRequestConditions {
private Long ifSequenceNumberLessThan;
private Long ifSequenceNumberEqualTo;
+ /**
+ * Creates a new instance of {@link PageBlobRequestConditions}.
+ */
+ public PageBlobRequestConditions() {
+ }
+
/**
* Optionally limit requests to resources that match the passed ETag.
*
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ParallelTransferOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ParallelTransferOptions.java
index 310de89135c5e..77f7841c945d7 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ParallelTransferOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/models/ParallelTransferOptions.java
@@ -226,6 +226,14 @@ public Integer getMaxConcurrency() {
}
/**
+ * Sets the maximum number of parallel requests that will be issued at any given time as a part of
+ * a single parallel transfer. This value applies per api. For example, if two calls to uploadFromFile are made at
+ * the same time, and each specifies a maxConcurrency of 5, there may be up to 10 outstanding, concurrent requests,
+ * up to 5 for each of the upload operations. For buffered uploads only, the maximum number of buffers to be
+ * allocated as part of the transfer will be {@code maxConcurrency + 1}. In those cases, memory will be allocated
+ * lazily as needed. The amount of memory consumed by methods which buffer may be up to blockSize * maxConcurrency.
+ * In general, upload methods which do not accept a length parameter must perform some buffering.
+ *
* @param maxConcurrency The maximum number of parallel requests that will be issued at any given time as a part of
* a single parallel transfer. This value applies per api. For example, if two calls to uploadFromFile are made at
* the same time, and each specifies a maxConcurrency of 5, there may be up to 10 outstanding, concurrent requests,
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/AppendBlobSealOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/AppendBlobSealOptions.java
index a63e0722152ed..736313ac31bde 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/AppendBlobSealOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/AppendBlobSealOptions.java
@@ -12,10 +12,17 @@
*/
@Fluent
public class AppendBlobSealOptions {
-
private AppendBlobRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link AppendBlobSealOptions}.
+ */
+ public AppendBlobSealOptions() {
+ }
+
+ /**
+ * Gets the {@link AppendBlobRequestConditions}.
+ *
* @return {@link AppendBlobRequestConditions}
*/
public AppendBlobRequestConditions getRequestConditions() {
@@ -23,6 +30,8 @@ public AppendBlobRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link AppendBlobRequestConditions}.
+ *
* @param requestConditions {@link BlobRequestConditions}
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobAcquireLeaseOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobAcquireLeaseOptions.java
index 14ba7a1eb994a..8d7525e30cd25 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobAcquireLeaseOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobAcquireLeaseOptions.java
@@ -11,11 +11,12 @@
*/
@Fluent
public class BlobAcquireLeaseOptions {
-
private final int duration;
private BlobLeaseRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link BlobAcquireLeaseOptions}.
+ *
* @param durationInSeconds The duration of the lease between 15 to 60 seconds or -1 for an infinite duration.
*/
public BlobAcquireLeaseOptions(int durationInSeconds) {
@@ -23,6 +24,8 @@ public BlobAcquireLeaseOptions(int durationInSeconds) {
}
/**
+ * Gets the duration of the lease.
+ *
* @return The duration of the lease between 15 to 60 seconds or -1 for an infinite duration.
*/
public int getDuration() {
@@ -30,6 +33,8 @@ public int getDuration() {
}
/**
+ * Gets the {@link BlobLeaseRequestConditions}.
+ *
* @return {@link BlobLeaseRequestConditions}
*/
public BlobLeaseRequestConditions getRequestConditions() {
@@ -37,6 +42,8 @@ public BlobLeaseRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobLeaseRequestConditions}.
+ *
* @param requestConditions {@link BlobLeaseRequestConditions}
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobBeginCopyOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobBeginCopyOptions.java
index 17376090c2a85..e8143f59c53c0 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobBeginCopyOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobBeginCopyOptions.java
@@ -32,7 +32,10 @@ public class BlobBeginCopyOptions {
private Boolean legalHold;
/**
+ * Creates a new instance of {@link BlobBeginCopyOptions}.
+ *
* @param sourceUrl The source URL to copy from. URLs outside of Azure may only be copied to block blobs.
+ * @throws NullPointerException If {@code sourceUrl} is null.
*/
public BlobBeginCopyOptions(String sourceUrl) {
StorageImplUtils.assertNotNull("sourceUrl", sourceUrl);
@@ -40,6 +43,8 @@ public BlobBeginCopyOptions(String sourceUrl) {
}
/**
+ * Gets the source URL.
+ *
* @return The source URL.
*/
public String getSourceUrl() {
@@ -47,6 +52,8 @@ public String getSourceUrl() {
}
/**
+ * Gets the metadata to associate with the destination blob.
+ *
* @return The metadata to associate with the destination blob.
*/
public Map getMetadata() {
@@ -54,6 +61,8 @@ public Map getMetadata() {
}
/**
+ * Sets the metadata to associate with the destination blob.
+ *
* @param metadata The metadata to associate with the destination blob.
* @return The updated options
*/
@@ -63,6 +72,8 @@ public BlobBeginCopyOptions setMetadata(Map metadata) {
}
/**
+ * Gets the tags to associate with the blob.
+ *
* @return The tags to associate with the blob.
*/
public Map getTags() {
@@ -70,6 +81,8 @@ public Map getTags() {
}
/**
+ * Sets the tags to associate with the blob.
+ *
* @param tags The tags to associate with the blob.
* @return The updated options.
*/
@@ -79,6 +92,8 @@ public BlobBeginCopyOptions setTags(Map tags) {
}
/**
+ * Gets the {@link AccessTier} for the destination blob.
+ *
* @return {@link AccessTier} for the destination blob.
*/
public AccessTier getTier() {
@@ -86,6 +101,8 @@ public AccessTier getTier() {
}
/**
+ * Sets the {@link AccessTier} for the destination blob.
+ *
* @param tier {@link AccessTier} for the destination blob.
* @return The updated options.
*/
@@ -95,6 +112,8 @@ public BlobBeginCopyOptions setTier(AccessTier tier) {
}
/**
+ * Gets the {@link RehydratePriority} for rehydrating the blob.
+ *
* @return {@link RehydratePriority} for rehydrating the blob.
*/
public RehydratePriority getRehydratePriority() {
@@ -102,6 +121,8 @@ public RehydratePriority getRehydratePriority() {
}
/**
+ * Sets the {@link RehydratePriority} for rehydrating the blob.
+ *
* @param rehydratePriority {@link RehydratePriority} for rehydrating the blob.
* @return The updated options.
*/
@@ -111,6 +132,8 @@ public BlobBeginCopyOptions setRehydratePriority(RehydratePriority rehydratePrio
}
/**
+ * Gets the {@link BlobBeginCopySourceRequestConditions} for the source.
+ *
* @return {@link BlobBeginCopySourceRequestConditions} for the source.
*/
public BlobBeginCopySourceRequestConditions getSourceRequestConditions() {
@@ -118,6 +141,8 @@ public BlobBeginCopySourceRequestConditions getSourceRequestConditions() {
}
/**
+ * Sets the {@link BlobBeginCopySourceRequestConditions} for the source.
+ *
* @param sourceRequestConditions {@link BlobBeginCopySourceRequestConditions} for the source.
* @return The updated options.
*/
@@ -128,6 +153,8 @@ public BlobBeginCopySourceRequestConditions getSourceRequestConditions() {
}
/**
+ * Gets the {@link BlobRequestConditions} for the destination.
+ *
* @return {@link BlobRequestConditions} for the destination.
*/
public BlobRequestConditions getDestinationRequestConditions() {
@@ -135,6 +162,8 @@ public BlobRequestConditions getDestinationRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions} for the destination.
+ *
* @param destinationRequestConditions {@link BlobRequestConditions} for the destination
* @return The updated options.
*/
@@ -144,6 +173,8 @@ public BlobBeginCopyOptions setDestinationRequestConditions(BlobRequestCondition
}
/**
+ * Gets the duration between each poll for the copy status.
+ *
* @return Duration between each poll for the copy status. If none is specified, a default of one second
* is used.
*/
@@ -152,6 +183,8 @@ public Duration getPollInterval() {
}
/**
+ * Sets the duration between each poll for the copy status.
+ *
* @param pollInterval Duration between each poll for the copy status. If none is specified, a default of one second
* is used.
* @return The updated options.
@@ -162,17 +195,22 @@ public BlobBeginCopyOptions setPollInterval(Duration pollInterval) {
}
/**
- * Only applicable for Append Blobs.
- * @return Whether or not the destination blob should be sealed (marked as read only).
+ * Gets whether the destination blob should be sealed (marked as read only).
+ *
+ * Only applicable for Append Blobs.
+ *
+ * @return Whether the destination blob should be sealed (marked as read only).
*/
public Boolean isSealDestination() {
return sealDestination;
}
/**
+ * Sets whether the destination blob should be sealed (marked as read only).
+ *
* Only applicable for Append Blobs.
*
- * @param sealDestination Whether or not the destination blob should be sealed (marked as read only).
+ * @param sealDestination Whether the destination blob should be sealed (marked as read only).
* @return The updated options.
*/
public BlobBeginCopyOptions setSealDestination(Boolean sealDestination) {
@@ -181,6 +219,8 @@ public BlobBeginCopyOptions setSealDestination(Boolean sealDestination) {
}
/**
+ * Gets the {@link BlobImmutabilityPolicy} for the destination blob.
+ *
* @return {@link BlobImmutabilityPolicy}
*/
public BlobImmutabilityPolicy getImmutabilityPolicy() {
@@ -188,8 +228,11 @@ public BlobImmutabilityPolicy getImmutabilityPolicy() {
}
/**
+ * Sets the {@link BlobImmutabilityPolicy} for the destination blob.
+ *
* Note that this parameter is only applicable to a blob within a container that has immutable storage with
* versioning enabled.
+ *
* @param immutabilityPolicy {@link BlobImmutabilityPolicy}
* @return The updated options.
*/
@@ -199,6 +242,8 @@ public BlobBeginCopyOptions setImmutabilityPolicy(BlobImmutabilityPolicy immutab
}
/**
+ * Gets if a legal hold should be placed on the blob.
+ *
* @return If a legal hold should be placed on the blob.
*/
public Boolean isLegalHold() {
@@ -206,6 +251,8 @@ public Boolean isLegalHold() {
}
/**
+ * Sets if a legal hold should be placed on the blob.
+ *
* Note that this parameter is only applicable to a blob within a container that has immutable storage with
* versioning enabled.
* @param legalHold Indicates if a legal hold should be placed on the blob.
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobBreakLeaseOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobBreakLeaseOptions.java
index c0ac1c9afa3ce..59aec35eda273 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobBreakLeaseOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobBreakLeaseOptions.java
@@ -13,11 +13,18 @@
*/
@Fluent
public class BlobBreakLeaseOptions {
-
private Duration breakPeriod;
private BlobLeaseRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link BlobBreakLeaseOptions}.
+ */
+ public BlobBreakLeaseOptions() {
+ }
+
+ /**
+ * Gets the break period of the lease.
+ *
* @return An optional duration, between 0 and 60 seconds, that the lease should continue before
* it is broken. If the break period is longer than the time remaining on the lease the remaining time on the lease
* is used. A new lease will not be available before the break period has expired, but the lease may be held for
@@ -28,6 +35,8 @@ public Duration getBreakPeriod() {
}
/**
+ * Sets the break period of the lease.
+ *
* @param breakPeriod An optional duration, between 0 and 60 seconds, that the lease should continue before
* it is broken. If the break period is longer than the time remaining on the lease the remaining time on the lease
* is used. A new lease will not be available before the break period has expired, but the lease may be held for
@@ -40,6 +49,8 @@ public BlobBreakLeaseOptions setBreakPeriod(Duration breakPeriod) {
}
/**
+ * Gets the {@link BlobLeaseRequestConditions}.
+ *
* @return {@link BlobLeaseRequestConditions}
*/
public BlobLeaseRequestConditions getRequestConditions() {
@@ -47,6 +58,8 @@ public BlobLeaseRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobLeaseRequestConditions}.
+ *
* @param requestConditions {@link BlobLeaseRequestConditions}
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobChangeLeaseOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobChangeLeaseOptions.java
index 22ea53155656e..70eae80285d3c 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobChangeLeaseOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobChangeLeaseOptions.java
@@ -12,12 +12,14 @@
*/
@Fluent
public class BlobChangeLeaseOptions {
-
private final String proposedId;
private BlobLeaseRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link BlobChangeLeaseOptions}.
+ *
* @param proposedId A new lease ID in a valid GUID format.
+ * @throws NullPointerException If {@code proposedId} is null.
*/
public BlobChangeLeaseOptions(String proposedId) {
StorageImplUtils.assertNotNull("proposedId", proposedId);
@@ -25,6 +27,8 @@ public BlobChangeLeaseOptions(String proposedId) {
}
/**
+ * Gets the proposed lease ID.
+ *
* @return A new lease ID in a valid GUID format.
*/
public String getProposedId() {
@@ -32,6 +36,8 @@ public String getProposedId() {
}
/**
+ * Gets the {@link BlobLeaseRequestConditions}.
+ *
* @return {@link BlobLeaseRequestConditions}
*/
public BlobLeaseRequestConditions getRequestConditions() {
@@ -39,6 +45,8 @@ public BlobLeaseRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobLeaseRequestConditions}.
+ *
* @param requestConditions {@link BlobLeaseRequestConditions}
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobContainerCreateOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobContainerCreateOptions.java
index f71ff8b52fb26..e2bfbdc9b6624 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobContainerCreateOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobContainerCreateOptions.java
@@ -17,6 +17,14 @@ public class BlobContainerCreateOptions {
PublicAccessType publicAccessType;
/**
+ * Creates a new instance of {@link BlobContainerCreateOptions}.
+ */
+ public BlobContainerCreateOptions() {
+ }
+
+ /**
+ * Gets the metadata to associate with the blob.
+ *
* @return The metadata to associate with the blob.
*/
public Map getMetadata() {
@@ -24,6 +32,8 @@ public Map getMetadata() {
}
/**
+ * Sets the metadata to associate with the blob.
+ *
* @param metadata The metadata to associate with the blob.
* @return The updated options
*/
@@ -33,6 +43,8 @@ public BlobContainerCreateOptions setMetadata(Map metadata) {
}
/**
+ * Gets the public access type associated with the blob.
+ *
* @return The public access type associated with the blob.
*/
public PublicAccessType getPublicAccessType() {
@@ -40,6 +52,8 @@ public PublicAccessType getPublicAccessType() {
}
/**
+ * Sets the public access type to associate with the blob.
+ *
* @param accessType The public access type to associate with the blob.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobContainerRenameOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobContainerRenameOptions.java
index be1889c501c74..6358f3c0eb3b6 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobContainerRenameOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobContainerRenameOptions.java
@@ -13,12 +13,14 @@
*/
@Fluent
class BlobContainerRenameOptions {
-
private final String destinationContainerName;
private BlobRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link BlobContainerRenameOptions}.
+ *
* @param destinationContainerName The new name of the container.
+ * @throws NullPointerException If {@code destinationContainerName} is null.
*/
BlobContainerRenameOptions(String destinationContainerName) {
Objects.requireNonNull(destinationContainerName);
@@ -26,6 +28,8 @@ class BlobContainerRenameOptions {
}
/**
+ * Gets the new name of the container.
+ *
* @return The new name of the container.
*/
public String getDestinationContainerName() {
@@ -33,6 +37,8 @@ public String getDestinationContainerName() {
}
/**
+ * Gets the {@link BlobRequestConditions}.
+ *
* @return {@link BlobRequestConditions}
*/
public BlobRequestConditions getRequestConditions() {
@@ -40,6 +46,8 @@ public BlobRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions}.
+ *
* @param requestConditions {@link BlobRequestConditions}
* @return The updated options.
* @throws UnsupportedOperationException if a condition other than lease id is set.
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobCopyFromUrlOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobCopyFromUrlOptions.java
index 49bf499f9d573..8aa3a25d48c1c 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobCopyFromUrlOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobCopyFromUrlOptions.java
@@ -31,7 +31,10 @@ public class BlobCopyFromUrlOptions {
private BlobCopySourceTagsMode copySourceTags;
/**
+ * Creates a new instance of {@link BlobCopyFromUrlOptions}.
+ *
* @param copySource The source URL to copy from. URLs outside of Azure may only be copied to block blobs.
+ * @throws NullPointerException If {@code copySource} is null.
*/
public BlobCopyFromUrlOptions(String copySource) {
StorageImplUtils.assertNotNull("copySource", copySource);
@@ -39,6 +42,8 @@ public BlobCopyFromUrlOptions(String copySource) {
}
/**
+ * Gets the source URL to copy from.
+ *
* @return The source URL to copy from. URLs outside of Azure may only be copied to block blobs.
*/
public String getCopySource() {
@@ -46,6 +51,8 @@ public String getCopySource() {
}
/**
+ * Gets the metadata to associate with the destination blob.
+ *
* @return The metadata to associate with the destination blob.
*/
public Map getMetadata() {
@@ -53,6 +60,8 @@ public Map getMetadata() {
}
/**
+ * Sets the metadata to associate with the destination blob.
+ *
* @param metadata The metadata to associate with the destination blob.
* @return The updated options
*/
@@ -62,6 +71,8 @@ public BlobCopyFromUrlOptions setMetadata(Map metadata) {
}
/**
+ * Gets the tags to associate with the blob.
+ *
* @return The tags to associate with the blob.
*/
public Map getTags() {
@@ -69,6 +80,8 @@ public Map getTags() {
}
/**
+ * Sets the tags to associate with the blob.
+ *
* @param tags The tags to associate with the blob.
* @return The updated options.
*/
@@ -78,6 +91,8 @@ public BlobCopyFromUrlOptions setTags(Map tags) {
}
/**
+ * Gets the {@link AccessTier} for the destination blob.
+ *
* @return {@link AccessTier} for the destination blob.
*/
public AccessTier getTier() {
@@ -85,6 +100,8 @@ public AccessTier getTier() {
}
/**
+ * Sets the {@link AccessTier} for the destination blob.
+ *
* @param tier {@link AccessTier} for the destination blob.
* @return The updated options.
*/
@@ -94,6 +111,8 @@ public BlobCopyFromUrlOptions setTier(AccessTier tier) {
}
/**
+ * Gets the {@link RequestConditions} for the source.
+ *
* @return {@link RequestConditions} for the source.
*/
public RequestConditions getSourceRequestConditions() {
@@ -101,6 +120,8 @@ public RequestConditions getSourceRequestConditions() {
}
/**
+ * Sets the {@link RequestConditions} for the source.
+ *
* @param sourceRequestConditions {@link RequestConditions} for the source.
* @return The updated options.
*/
@@ -110,6 +131,8 @@ public BlobCopyFromUrlOptions setSourceRequestConditions(RequestConditions sourc
}
/**
+ * Gets the {@link BlobRequestConditions} for the destination.
+ *
* @return {@link BlobRequestConditions} for the destination.
*/
public BlobRequestConditions getDestinationRequestConditions() {
@@ -117,6 +140,8 @@ public BlobRequestConditions getDestinationRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions} for the destination.
+ *
* @param destinationRequestConditions {@link BlobRequestConditions} for the destination.
* @return The updated options.
*/
@@ -126,6 +151,9 @@ public BlobCopyFromUrlOptions setDestinationRequestConditions(BlobRequestConditi
}
/**
+ * Gets "Authorization" header for accessing source URL. Currently only "Bearer" authentication is accepted by
+ * Storage.
+ *
* @return auth header for access to source.
*/
public HttpAuthorization getSourceAuthorization() {
@@ -145,6 +173,8 @@ public BlobCopyFromUrlOptions setSourceAuthorization(HttpAuthorization sourceAut
}
/**
+ * Gets the {@link BlobImmutabilityPolicy}.
+ *
* @return {@link BlobImmutabilityPolicy}
*/
public BlobImmutabilityPolicy getImmutabilityPolicy() {
@@ -152,6 +182,8 @@ public BlobImmutabilityPolicy getImmutabilityPolicy() {
}
/**
+ * Sets the {@link BlobImmutabilityPolicy}.
+ *
* Note that this parameter is only applicable to a blob within a container that has immutable storage with
* versioning enabled.
*
@@ -164,6 +196,8 @@ public BlobCopyFromUrlOptions setImmutabilityPolicy(BlobImmutabilityPolicy immut
}
/**
+ * Gets if a legal hold should be placed on the blob.
+ *
* @return If a legal hold should be placed on the blob.
*/
public Boolean hasLegalHold() {
@@ -171,6 +205,8 @@ public Boolean hasLegalHold() {
}
/**
+ * Sets if a legal hold should be placed on the blob.
+ *
* Note that this parameter is only applicable to a blob within a container that has immutable storage with
* versioning enabled.
*
@@ -183,6 +219,8 @@ public BlobCopyFromUrlOptions setLegalHold(Boolean legalHold) {
}
/**
+ * Gets the copy source tags mode.
+ *
* @return The copy source tags mode.
*/
public BlobCopySourceTagsMode getCopySourceTagsMode() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobDownloadToFileOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobDownloadToFileOptions.java
index 5db9ed0cd1a87..434844645f581 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobDownloadToFileOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobDownloadToFileOptions.java
@@ -18,7 +18,6 @@
*/
@Fluent
public class BlobDownloadToFileOptions {
-
private final String filePath;
private BlobRange range;
private ParallelTransferOptions parallelTransferOptions;
@@ -31,6 +30,7 @@ public class BlobDownloadToFileOptions {
* Constructs a {@link BlobDownloadToFileOptions}.
*
* @param filePath Path of the file to download to.
+ * @throws NullPointerException If {@code filePath} is null.
*/
public BlobDownloadToFileOptions(String filePath) {
StorageImplUtils.assertNotNull("filePath", filePath);
@@ -38,6 +38,8 @@ public BlobDownloadToFileOptions(String filePath) {
}
/**
+ * Gets the path of the file to download to.
+ *
* @return The path of the file to download to.
*/
public String getFilePath() {
@@ -45,6 +47,8 @@ public String getFilePath() {
}
/**
+ * Gets the {@link BlobRange}.
+ *
* @return {@link BlobRange}
*/
public BlobRange getRange() {
@@ -52,6 +56,8 @@ public BlobRange getRange() {
}
/**
+ * Gets the {@link ParallelTransferOptions}.
+ *
* @return {@link ParallelTransferOptions}
*/
public ParallelTransferOptions getParallelTransferOptions() {
@@ -59,6 +65,8 @@ public ParallelTransferOptions getParallelTransferOptions() {
}
/**
+ * Gets the {@link DownloadRetryOptions}.
+ *
* @return {@link DownloadRetryOptions}
*/
public DownloadRetryOptions getDownloadRetryOptions() {
@@ -66,6 +74,8 @@ public DownloadRetryOptions getDownloadRetryOptions() {
}
/**
+ * Gets the {@link BlobRequestConditions}.
+ *
* @return {@link BlobRequestConditions}
*/
public BlobRequestConditions getRequestConditions() {
@@ -73,6 +83,8 @@ public BlobRequestConditions getRequestConditions() {
}
/**
+ * Gets whether the contentMD5 for the specified blob range should be returned.
+ *
* @return Whether the contentMD5 for the specified blob range should be returned.
*/
public boolean isRetrieveContentRangeMd5() {
@@ -80,6 +92,8 @@ public boolean isRetrieveContentRangeMd5() {
}
/**
+ * Gets the {@link OpenOption OpenOptions} to use to configure how to open or create the file.
+ *
* @return {@link OpenOption OpenOptions} to use to configure how to open or create the file.
*/
public Set getOpenOptions() {
@@ -87,6 +101,8 @@ public Set getOpenOptions() {
}
/**
+ * Sets the {@link BlobRange}.
+ *
* @param range {@link BlobRange}
* @return The updated options.
*/
@@ -96,6 +112,8 @@ public BlobDownloadToFileOptions setRange(BlobRange range) {
}
/**
+ * Sets the {@link ParallelTransferOptions}.
+ *
* @param parallelTransferOptions {@link ParallelTransferOptions}
* @return The updated options.
*/
@@ -105,6 +123,8 @@ public BlobDownloadToFileOptions setParallelTransferOptions(ParallelTransferOpti
}
/**
+ * Sets the {@link DownloadRetryOptions}.
+ *
* @param downloadRetryOptions {@link DownloadRetryOptions}
* @return The updated options.
*/
@@ -114,6 +134,8 @@ public BlobDownloadToFileOptions setDownloadRetryOptions(DownloadRetryOptions do
}
/**
+ * Sets the {@link BlobRequestConditions}.
+ *
* @param requestConditions {@link BlobRequestConditions}
* @return The updated options.
*/
@@ -123,6 +145,8 @@ public BlobDownloadToFileOptions setRequestConditions(BlobRequestConditions requ
}
/**
+ * Sets whether the contentMD5 for the specified blob range should be returned.
+ *
* @param retrieveContentRangeMd5 Whether the contentMD5 for the specified blob range should be returned.
* @return The updated options.
*/
@@ -132,6 +156,8 @@ public BlobDownloadToFileOptions setRetrieveContentRangeMd5(boolean retrieveCont
}
/**
+ * Sets the {@link OpenOption OpenOptions} to use to configure how to open or create the file.
+ *
* @param openOptions {@link OpenOption OpenOptions} to use to configure how to open or create the file.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobGetTagsOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobGetTagsOptions.java
index 331242d86ff1e..a8e8071b2e6bc 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobGetTagsOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobGetTagsOptions.java
@@ -11,10 +11,17 @@
*/
@Fluent
public class BlobGetTagsOptions {
-
private BlobRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link BlobGetTagsOptions}.
+ */
+ public BlobGetTagsOptions() {
+ }
+
+ /**
+ * Gets the {@link BlobRequestConditions}.
+ *
* @return {@link BlobRequestConditions}
*/
public BlobRequestConditions getRequestConditions() {
@@ -22,6 +29,8 @@ public BlobRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions}.
+ *
* @param requestConditions {@link BlobRequestConditions}
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobInputStreamOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobInputStreamOptions.java
index 00a1705270887..d98d744f3dd3d 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobInputStreamOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobInputStreamOptions.java
@@ -13,13 +13,20 @@
*/
@Fluent
public class BlobInputStreamOptions {
-
private BlobRange range;
private BlobRequestConditions requestConditions;
private Integer blockSize;
private ConsistentReadControl consistentReadControl;
/**
+ * Creates a new instance of {@link BlobInputStreamOptions}.
+ */
+ public BlobInputStreamOptions() {
+ }
+
+ /**
+ * Gets the {@link BlobRange}.
+ *
* @return {@link BlobRange}
*/
public BlobRange getRange() {
@@ -27,6 +34,8 @@ public BlobRange getRange() {
}
/**
+ * Sets the {@link BlobRange}.
+ *
* @param range {@link BlobRange}
* @return The updated options.
*/
@@ -36,6 +45,8 @@ public BlobInputStreamOptions setRange(BlobRange range) {
}
/**
+ * Gets the {@link BlobRequestConditions}.
+ *
* @return {@link BlobRequestConditions}
*/
public BlobRequestConditions getRequestConditions() {
@@ -43,6 +54,8 @@ public BlobRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions}.
+ *
* @param requestConditions {@link BlobRequestConditions}
* @return The updated options.
*/
@@ -52,6 +65,10 @@ public BlobInputStreamOptions setRequestConditions(BlobRequestConditions request
}
/**
+ * Gets the size of each data chunk returned from the service. If block size is large, input stream will make
+ * fewer network calls, but each individual call will send more data and will therefore take longer.
+ * The default value is 4 MB.
+ *
* @return The size of each data chunk returned from the service. If block size is large, input stream will make
* fewer network calls, but each individual call will send more data and will therefore take longer.
* The default value is 4 MB.
@@ -61,6 +78,10 @@ public Integer getBlockSize() {
}
/**
+ * Sets the size of each data chunk returned from the service. If block size is large, input stream will make
+ * fewer network calls, but each individual call will send more data and will therefore take longer.
+ * The default value is 4 MB.
+ *
* @param blockSize The size of each data chunk returned from the service. If block size is large, input stream
* will make fewer network calls, but each individual call will send more data and will therefore take longer.
* The default value is 4 MB.
@@ -72,6 +93,8 @@ public BlobInputStreamOptions setBlockSize(Integer blockSize) {
}
/**
+ * Gets the {@link ConsistentReadControl} Default is E-Tag.
+ *
* @return {@link ConsistentReadControl} Default is E-Tag.
*/
public ConsistentReadControl getConsistentReadControl() {
@@ -79,6 +102,8 @@ public ConsistentReadControl getConsistentReadControl() {
}
/**
+ * Sets the {@link ConsistentReadControl} Default is E-Tag.
+ *
* @param consistentReadControl {@link ConsistentReadControl} Default is E-Tag.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobParallelUploadOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobParallelUploadOptions.java
index 3d4527aa9d5a3..681ff994ae620 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobParallelUploadOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobParallelUploadOptions.java
@@ -45,6 +45,7 @@ public class BlobParallelUploadOptions {
* @param dataFlux The data to write to the blob. Unlike other upload methods, this method does not require that
* the {@code Flux} be replayable. In other words, it does not have to support multiple subscribers and is not
* expected to produce the same values across subscriptions.
+ * @throws NullPointerException If {@code dataFlux} is null.
*/
public BlobParallelUploadOptions(Flux dataFlux) {
StorageImplUtils.assertNotNull("dataFlux", dataFlux);
@@ -55,13 +56,14 @@ public BlobParallelUploadOptions(Flux dataFlux) {
/**
* Constructs a new {@link BlobParallelUploadOptions}.
- *
+ *
* Use {@link #BlobParallelUploadOptions(InputStream)} instead to supply an InputStream without knowing the exact
* length beforehand.
*
* @param dataStream The data to write to the blob.
* @param length The exact length of the data. It is important that this value match precisely the length of the
* data provided in the {@link InputStream}.
+ * @throws NullPointerException If {@code dataStream} is null.
* @deprecated length is no longer necessary; use {@link #BlobParallelUploadOptions(InputStream)} instead.
*/
@Deprecated
@@ -74,6 +76,7 @@ public BlobParallelUploadOptions(InputStream dataStream, long length) {
* Note: the {@link InputStream} must be closed by the caller.
*
* @param dataStream The data to write to the blob.
+ * @throws NullPointerException If {@code dataStream} is null.
*/
public BlobParallelUploadOptions(InputStream dataStream) {
this(dataStream, null);
@@ -85,6 +88,9 @@ public BlobParallelUploadOptions(InputStream dataStream) {
*
* @param dataStream The data to write to the blob.
* @param length Optional known length of the data, affects reactive behavior for backwards compatibility.
+ * @throws NullPointerException If {@code dataStream} is null.
+ * @throws IllegalArgumentException If {@code length} is specified and is less than 0 or greater than
+ * {@link Long#MAX_VALUE}.
*/
private BlobParallelUploadOptions(InputStream dataStream, Long length) {
StorageImplUtils.assertNotNull("dataStream", dataStream);
@@ -269,7 +275,9 @@ public BlobParallelUploadOptions setRequestConditions(BlobRequestConditions requ
}
/**
- * @return Whether or not the library should calculate the md5 and send it for the service to verify.
+ * Gets the computeMd5 property.
+ *
+ * @return Whether the library should calculate the md5 and send it for the service to verify.
*/
public boolean isComputeMd5() {
return computeMd5;
@@ -278,7 +286,7 @@ public boolean isComputeMd5() {
/**
* Sets the computeMd5 property.
*
- * @param computeMd5 Whether or not the library should calculate the md5 and send it for the service to
+ * @param computeMd5 Whether the library should calculate the md5 and send it for the service to
* verify.
* @return The updated options.
*/
@@ -291,7 +299,6 @@ public BlobParallelUploadOptions setComputeMd5(boolean computeMd5) {
* Gets the timeout.
*
* @return An optional timeout value beyond which a {@link RuntimeException} will be raised.
- *
* @deprecated Use {@link BlobClient#uploadWithResponse(BlobParallelUploadOptions, Duration, Context)} to
* specify timeout.
*/
@@ -305,7 +312,6 @@ public Duration getTimeout() {
*
* @param timeout An optional timeout value beyond which a {@link RuntimeException} will be raised.
* @return The updated options
- *
* @deprecated Use {@link BlobClient#uploadWithResponse(BlobParallelUploadOptions, Duration, Context)} to
* specify timeout.
*/
@@ -316,6 +322,8 @@ public BlobParallelUploadOptions setTimeout(Duration timeout) {
}
/**
+ * Gets the {@link BlobImmutabilityPolicy}.
+ *
* @return {@link BlobImmutabilityPolicy}
*/
public BlobImmutabilityPolicy getImmutabilityPolicy() {
@@ -323,8 +331,11 @@ public BlobImmutabilityPolicy getImmutabilityPolicy() {
}
/**
+ * Sets the {@link BlobImmutabilityPolicy}.
+ *
* Note that this parameter is only applicable to a blob within a container that has immutable storage with
* versioning enabled.
+ *
* @param immutabilityPolicy {@link BlobImmutabilityPolicy}
* @return The updated options.
*/
@@ -334,6 +345,8 @@ public BlobParallelUploadOptions setImmutabilityPolicy(BlobImmutabilityPolicy im
}
/**
+ * Gets if a legal hold should be placed on the blob.
+ *
* @return If a legal hold should be placed on the blob.
*/
public Boolean isLegalHold() {
@@ -341,8 +354,11 @@ public Boolean isLegalHold() {
}
/**
+ * Sets if a legal hold should be placed on the blob.
+ *
* Note that this parameter is only applicable to a blob within a container that has immutable storage with
* versioning enabled.
+ *
* @param legalHold Indicates if a legal hold should be placed on the blob.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobQueryOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobQueryOptions.java
index 8d51b41c0b1e6..a74b775cc23c6 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobQueryOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobQueryOptions.java
@@ -18,7 +18,6 @@
*/
@Fluent
public class BlobQueryOptions {
-
private final String expression;
private final OutputStream outputStream;
private BlobQuerySerialization inputSerialization;
@@ -29,7 +28,9 @@ public class BlobQueryOptions {
/**
* Constructs a {@link BlobQueryOptions}.
+ *
* @param expression The query expression.
+ * @throws NullPointerException If {@code expression} is null.
*/
public BlobQueryOptions(String expression) {
StorageImplUtils.assertNotNull("expression", expression);
@@ -39,8 +40,10 @@ public BlobQueryOptions(String expression) {
/**
* Constructs a {@link BlobQueryOptions}.
+ *
* @param expression The query expression.
* @param outputStream The OutputStream where the downloaded data will be written.
+ * @throws NullPointerException If {@code expression} or {@code outputStream} is null.
*/
public BlobQueryOptions(String expression, OutputStream outputStream) {
StorageImplUtils.assertNotNull("expression", expression);
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobReleaseLeaseOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobReleaseLeaseOptions.java
index 6ce493c6dd948..6dea5e276d596 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobReleaseLeaseOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobReleaseLeaseOptions.java
@@ -11,10 +11,17 @@
*/
@Fluent
public class BlobReleaseLeaseOptions {
-
private BlobLeaseRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link BlobReleaseLeaseOptions}.
+ */
+ public BlobReleaseLeaseOptions() {
+ }
+
+ /**
+ * Gets the {@link BlobLeaseRequestConditions}.
+ *
* @return {@link BlobLeaseRequestConditions}
*/
public BlobLeaseRequestConditions getRequestConditions() {
@@ -22,6 +29,8 @@ public BlobLeaseRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobLeaseRequestConditions}.
+ *
* @param requestConditions {@link BlobLeaseRequestConditions}
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobRenewLeaseOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobRenewLeaseOptions.java
index 954fb6b0ebf22..848da78af893b 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobRenewLeaseOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobRenewLeaseOptions.java
@@ -11,10 +11,17 @@
*/
@Fluent
public class BlobRenewLeaseOptions {
-
private BlobLeaseRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link BlobRenewLeaseOptions}.
+ */
+ public BlobRenewLeaseOptions() {
+ }
+
+ /**
+ * Gets the {@link BlobLeaseRequestConditions}.
+ *
* @return {@link BlobLeaseRequestConditions}
*/
public BlobLeaseRequestConditions getRequestConditions() {
@@ -22,6 +29,8 @@ public BlobLeaseRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobLeaseRequestConditions}.
+ *
* @param requestConditions {@link BlobLeaseRequestConditions}
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSeekableByteChannelReadOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSeekableByteChannelReadOptions.java
index cfafbcde3f724..ac92a1a022b3d 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSeekableByteChannelReadOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSeekableByteChannelReadOptions.java
@@ -14,12 +14,17 @@
*/
@Fluent
public final class BlobSeekableByteChannelReadOptions {
-
private Long initialPosition;
private BlobRequestConditions requestConditions;
private Integer readSizeInBytes;
private ConsistentReadControl consistentReadControl;
+ /**
+ * Creates a new instance of {@link BlobSeekableByteChannelReadOptions}.
+ */
+ public BlobSeekableByteChannelReadOptions() {
+ }
+
/**
* Gets the starting position of the resulting {@link SeekableByteChannel}. The channel will come with a prefetched
* range starting at this position.
@@ -41,6 +46,8 @@ public BlobSeekableByteChannelReadOptions setInitialPosition(Long initialPositio
}
/**
+ * Gets the {@link BlobRequestConditions}.
+ *
* @return {@link BlobRequestConditions}
*/
public BlobRequestConditions getRequestConditions() {
@@ -48,6 +55,8 @@ public BlobRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions}.
+ *
* @param requestConditions {@link BlobRequestConditions}
* @return The updated options.
*/
@@ -57,18 +66,22 @@ public BlobSeekableByteChannelReadOptions setRequestConditions(BlobRequestCondit
}
/**
- * @return The size of each data read from the service. If read size is large, the channel will make
- * fewer network calls, but each individual call will be larger.
- * The default value is 4 MB.
+ * Gets the size of each data read from the service. If read size is large, the channel will make fewer network
+ * calls, but each individual call will be larger. The default value is 4 MB.
+ *
+ * @return The size of each data read from the service. If read size is large, the channel will make fewer network
+ * calls, but each individual call will be larger. The default value is 4 MB.
*/
public Integer getReadSizeInBytes() {
return readSizeInBytes;
}
/**
+ * Sets the size of each data read from the service. If read size is large, the channel will make fewer network
+ * calls, but each individual call will be larger. The default value is 4 MB.
+ *
* @param readSizeInBytes The size of each data read from the service. If read size is large, the channel will make
- * fewer network calls, but each individual call will be larger.
- * The default value is 4 MB.
+ * fewer network calls, but each individual call will be larger. The default value is 4 MB.
* @return The updated options.
*/
public BlobSeekableByteChannelReadOptions setReadSizeInBytes(Integer readSizeInBytes) {
@@ -77,6 +90,8 @@ public BlobSeekableByteChannelReadOptions setReadSizeInBytes(Integer readSizeInB
}
/**
+ * Gets the {@link ConsistentReadControl} Default is E-Tag.
+ *
* @return {@link ConsistentReadControl} Default is E-Tag.
*/
public ConsistentReadControl getConsistentReadControl() {
@@ -84,6 +99,8 @@ public ConsistentReadControl getConsistentReadControl() {
}
/**
+ * Sets the {@link ConsistentReadControl} Default is E-Tag.
+ *
* @param consistentReadControl {@link ConsistentReadControl} Default is E-Tag.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSetAccessTierOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSetAccessTierOptions.java
index ed9278069b157..a8b7d4706df2b 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSetAccessTierOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSetAccessTierOptions.java
@@ -13,14 +13,16 @@
*/
@Fluent
public class BlobSetAccessTierOptions {
-
private final AccessTier tier;
private RehydratePriority priority;
private String leaseId;
private String tagsConditions;
/**
+ * Creates a new instance of {@link BlobSetAccessTierOptions}.
+ *
* @param tier The new tier for the blob.
+ * @throws NullPointerException If {@code tier} is null.
*/
public BlobSetAccessTierOptions(AccessTier tier) {
StorageImplUtils.assertNotNull("tier", tier);
@@ -28,6 +30,8 @@ public BlobSetAccessTierOptions(AccessTier tier) {
}
/**
+ * Gets the new tier for the blob.
+ *
* @return The new tier for the blob.
*/
public AccessTier getTier() {
@@ -35,6 +39,8 @@ public AccessTier getTier() {
}
/**
+ * Gets the priority to set for re-hydrating blobs.
+ *
* @return Priority to set for re-hydrating blobs.
*/
public RehydratePriority getPriority() {
@@ -42,6 +48,8 @@ public RehydratePriority getPriority() {
}
/**
+ * Sets the priority to set for re-hydrating blobs.
+ *
* @param priority Priority to set for re-hydrating blobs.
* @return The updated BlobSetAccessTierOptions.
*/
@@ -51,6 +59,8 @@ public BlobSetAccessTierOptions setPriority(RehydratePriority priority) {
}
/**
+ * Gets the lease ID the active lease on the blob must match.
+ *
* @return The lease ID the active lease on the blob must match.
*/
public String getLeaseId() {
@@ -58,6 +68,8 @@ public String getLeaseId() {
}
/**
+ * Sets the lease ID the active lease on the blob must match.
+ *
* @param leaseId The lease ID the active lease on the blob must match.
* @return The updated BlobSetAccessTierOptions.
*/
@@ -67,6 +79,8 @@ public BlobSetAccessTierOptions setLeaseId(String leaseId) {
}
/**
+ * Gets the SQL statement that apply to the tags of the blob.
+ *
* @return The SQL statement that apply to the tags of the blob.
*/
public String getTagsConditions() {
@@ -74,6 +88,8 @@ public String getTagsConditions() {
}
/**
+ * Sets the SQL statement that apply to the tags of the blob.
+ *
* @param tagsConditions The SQL statement that apply to the tags of the blob.
* @return The updated BlobSetAccessTierOptions.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSetTagsOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSetTagsOptions.java
index b49b5d105bdd2..44f929267d7ab 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSetTagsOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobSetTagsOptions.java
@@ -15,12 +15,14 @@
*/
@Fluent
public class BlobSetTagsOptions {
-
private final Map tags;
private BlobRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link BlobSetTagsOptions}.
+ *
* @param tags Tags to associate with the blob.
+ * @throws NullPointerException If {@code tags} is null.
*/
public BlobSetTagsOptions(Map tags) {
StorageImplUtils.assertNotNull("tags", tags);
@@ -28,6 +30,8 @@ public BlobSetTagsOptions(Map tags) {
}
/**
+ * Gets the tags to associate with the blob.
+ *
* @return The tags to associate with the blob.
*/
public Map getTags() {
@@ -35,6 +39,8 @@ public Map getTags() {
}
/**
+ * Gets the {@link BlobRequestConditions}.
+ *
* @return {@link BlobRequestConditions}
*/
public BlobRequestConditions getRequestConditions() {
@@ -42,6 +48,8 @@ public BlobRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions}.
+ *
* @param requestConditions {@link BlobRequestConditions}
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobUploadFromFileOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobUploadFromFileOptions.java
index b3d654fdb506e..65ca9b0ab0525 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobUploadFromFileOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobUploadFromFileOptions.java
@@ -29,6 +29,7 @@ public class BlobUploadFromFileOptions {
* Constructs a {@link BlobUploadFromFileOptions}.
*
* @param filePath Path of the file to upload.
+ * @throws NullPointerException If {@code filePath} is null.
*/
public BlobUploadFromFileOptions(String filePath) {
StorageImplUtils.assertNotNull("filePath", filePath);
@@ -36,6 +37,8 @@ public BlobUploadFromFileOptions(String filePath) {
}
/**
+ * Gets the path of the file to upload.
+ *
* @return The path of the file to upload
*/
public String getFilePath() {
@@ -43,6 +46,8 @@ public String getFilePath() {
}
/**
+ * Gets the {@link ParallelTransferOptions}.
+ *
* @return {@link ParallelTransferOptions}
*/
public ParallelTransferOptions getParallelTransferOptions() {
@@ -50,6 +55,8 @@ public ParallelTransferOptions getParallelTransferOptions() {
}
/**
+ * Sets the {@link ParallelTransferOptions}.
+ *
* @param parallelTransferOptions {@link ParallelTransferOptions}
* @return The updated options.
*/
@@ -59,6 +66,8 @@ public BlobUploadFromFileOptions setParallelTransferOptions(ParallelTransferOpti
}
/**
+ * Gets the {@link BlobHttpHeaders}.
+ *
* @return {@link BlobHttpHeaders}
*/
public BlobHttpHeaders getHeaders() {
@@ -66,6 +75,8 @@ public BlobHttpHeaders getHeaders() {
}
/**
+ * Sets the {@link BlobHttpHeaders}.
+ *
* @param headers {@link BlobHttpHeaders}
* @return The updated {@code AppendBlobCreateOptions}
*/
@@ -75,6 +86,8 @@ public BlobUploadFromFileOptions setHeaders(BlobHttpHeaders headers) {
}
/**
+ * Gets the metadata to associate with the blob.
+ *
* @return The metadata to associate with the blob.
*/
public Map getMetadata() {
@@ -82,6 +95,8 @@ public Map getMetadata() {
}
/**
+ * Sets the metadata to associate with the blob.
+ *
* @param metadata The metadata to associate with the blob.
* @return The updated options
*/
@@ -91,6 +106,8 @@ public BlobUploadFromFileOptions setMetadata(Map metadata) {
}
/**
+ * Gets the tags to associate with the blob.
+ *
* @return The tags to associate with the blob.
*/
public Map getTags() {
@@ -98,6 +115,8 @@ public Map getTags() {
}
/**
+ * Sets the tags to associate with the blob.
+ *
* @param tags The tags to associate with the blob.
* @return The updated options.
*/
@@ -107,6 +126,8 @@ public BlobUploadFromFileOptions setTags(Map tags) {
}
/**
+ * Gets the {@link AccessTier}.
+ *
* @return {@link AccessTier}
*/
public AccessTier getTier() {
@@ -114,6 +135,8 @@ public AccessTier getTier() {
}
/**
+ * Sets the {@link AccessTier}.
+ *
* @param tier {@link AccessTier}
* @return The updated options.
*/
@@ -123,6 +146,8 @@ public BlobUploadFromFileOptions setTier(AccessTier tier) {
}
/**
+ * Gets the {@link BlobRequestConditions}.
+ *
* @return {@link BlobRequestConditions}
*/
public BlobRequestConditions getRequestConditions() {
@@ -130,6 +155,8 @@ public BlobRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions}.
+ *
* @param requestConditions {@link BlobRequestConditions}
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobUploadFromUrlOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobUploadFromUrlOptions.java
index 68aa4d584a6dc..17afe7fa64076 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobUploadFromUrlOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlobUploadFromUrlOptions.java
@@ -29,6 +29,8 @@ public class BlobUploadFromUrlOptions {
private BlobCopySourceTagsMode copySourceTags;
/**
+ * Creates a new instance of {@link BlobUploadFromUrlOptions}.
+ *
* @param sourceUrl The source URL to upload from.
*/
public BlobUploadFromUrlOptions(String sourceUrl) {
@@ -37,6 +39,8 @@ public BlobUploadFromUrlOptions(String sourceUrl) {
}
/**
+ * Gets the source URL to upload from.
+ *
* @return The source URL to upload from.
*/
public String getSourceUrl() {
@@ -44,6 +48,8 @@ public String getSourceUrl() {
}
/**
+ * Gets the {@link BlobHttpHeaders}.
+ *
* @return {@link BlobHttpHeaders}
*/
public BlobHttpHeaders getHeaders() {
@@ -51,6 +57,8 @@ public BlobHttpHeaders getHeaders() {
}
/**
+ * Sets the {@link BlobHttpHeaders}.
+ *
* @param headers {@link BlobHttpHeaders}
* @return The updated options
*/
@@ -60,6 +68,8 @@ public BlobUploadFromUrlOptions setHeaders(BlobHttpHeaders headers) {
}
/**
+ * Gets the tags to associate with the blob.
+ *
* @return The tags to associate with the blob.
*/
public Map getTags() {
@@ -67,6 +77,8 @@ public Map getTags() {
}
/**
+ * Sets the tags to associate with the blob.
+ *
* @param tags The tags to associate with the blob.
* @return The updated options.
*/
@@ -76,6 +88,8 @@ public BlobUploadFromUrlOptions setTags(Map tags) {
}
/**
+ * Gets the {@link AccessTier}.
+ *
* @return {@link AccessTier}
*/
public AccessTier getTier() {
@@ -83,6 +97,8 @@ public AccessTier getTier() {
}
/**
+ * Sets the {@link AccessTier}.
+ *
* @param tier {@link AccessTier}
* @return The updated options.
*/
@@ -92,6 +108,8 @@ public BlobUploadFromUrlOptions setTier(AccessTier tier) {
}
/**
+ * Gets the MD5 hash of the content.
+ *
* @return An MD5 hash of the content. This hash is used to verify the integrity of the content during transport.
* When this header is specified, the storage service compares the hash of the content that has arrived with this
* header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the operation
@@ -102,6 +120,8 @@ public byte[] getContentMd5() {
}
/**
+ * Sets the MD5 hash of the content.
+ *
* @param contentMd5 An MD5 hash of the block content. This hash is used to verify the integrity of the block during
* transport. When this header is specified, the storage service compares the hash of the content that has arrived
* with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the
@@ -114,6 +134,8 @@ public BlobUploadFromUrlOptions setContentMd5(byte[] contentMd5) {
}
/**
+ * Gets the {@link BlobRequestConditions}.
+ *
* @return {@link BlobRequestConditions}
*/
public BlobRequestConditions getDestinationRequestConditions() {
@@ -121,6 +143,8 @@ public BlobRequestConditions getDestinationRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions}.
+ *
* @param destinationRequestConditions {@link BlobRequestConditions}
* @return The updated options.
*/
@@ -131,6 +155,8 @@ public BlobRequestConditions getDestinationRequestConditions() {
}
/**
+ * Gets the {@link BlobRequestConditions}.
+ *
* @return {@link BlobRequestConditions}
*/
public BlobRequestConditions getSourceRequestConditions() {
@@ -138,6 +164,8 @@ public BlobRequestConditions getSourceRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions}.
+ *
* @param sourceRequestConditions {@link BlobRequestConditions}
* @return The updated options.
*/
@@ -167,6 +195,9 @@ public BlobUploadFromUrlOptions setCopySourceBlobProperties(Boolean copySourceBl
}
/**
+ * Gets "Authorization" header for accessing source URL. Currently only "Bearer" authentication is accepted by
+ * Storage.
+ *
* @return auth header for access to source.
*/
public HttpAuthorization getSourceAuthorization() {
@@ -186,6 +217,8 @@ public BlobUploadFromUrlOptions setSourceAuthorization(HttpAuthorization sourceA
}
/**
+ * Gets the copy source tags mode
+ *
* @return The copy source tags mode.
*/
public BlobCopySourceTagsMode getCopySourceTagsMode() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobCommitBlockListOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobCommitBlockListOptions.java
index 3227f8f6ebae6..0f96aaa63d078 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobCommitBlockListOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobCommitBlockListOptions.java
@@ -28,6 +28,8 @@ public class BlockBlobCommitBlockListOptions {
private Boolean legalHold;
/**
+ * Creates a new instance of {@link BlockBlobCommitBlockListOptions}.
+ *
* @param base64BlockIds A list of base64 encode {@code String}s that specifies the block IDs to be committed.
*/
public BlockBlobCommitBlockListOptions(List base64BlockIds) {
@@ -35,6 +37,8 @@ public BlockBlobCommitBlockListOptions(List base64BlockIds) {
}
/**
+ * Gets the list of base64 encode {@code String}s that specifies the block IDs to be committed.
+ *
* @return A list of base64 encode {@code String}s that specifies the block IDs to be committed.
*/
public List getBase64BlockIds() {
@@ -42,6 +46,8 @@ public List getBase64BlockIds() {
}
/**
+ * Gets the {@link BlobHttpHeaders}.
+ *
* @return {@link BlobHttpHeaders}
*/
public BlobHttpHeaders getHeaders() {
@@ -49,6 +55,8 @@ public BlobHttpHeaders getHeaders() {
}
/**
+ * Sets the {@link BlobHttpHeaders}.
+ *
* @param headers {@link BlobHttpHeaders}
* @return The updated {@code AppendBlobCreateOptions}
*/
@@ -58,6 +66,8 @@ public BlockBlobCommitBlockListOptions setHeaders(BlobHttpHeaders headers) {
}
/**
+ * Gets the metadata to associate with the blob.
+ *
* @return The metadata to associate with the blob.
*/
public Map getMetadata() {
@@ -65,6 +75,8 @@ public Map getMetadata() {
}
/**
+ * Sets the metadata to associate with the blob.
+ *
* @param metadata The metadata to associate with the blob.
* @return The updated options
*/
@@ -74,6 +86,8 @@ public BlockBlobCommitBlockListOptions setMetadata(Map metadata)
}
/**
+ * Gets the tags to associate with the blob.
+ *
* @return The tags to associate with the blob.
*/
public Map getTags() {
@@ -81,6 +95,8 @@ public Map getTags() {
}
/**
+ * Sets the tags to associate with the blob.
+ *
* @param tags The tags to associate with the blob.
* @return The updated options.
*/
@@ -90,6 +106,8 @@ public BlockBlobCommitBlockListOptions setTags(Map tags) {
}
/**
+ * Gets the {@link AccessTier}.
+ *
* @return {@link AccessTier}
*/
public AccessTier getTier() {
@@ -97,6 +115,8 @@ public AccessTier getTier() {
}
/**
+ * Sets the {@link AccessTier}.
+ *
* @param tier {@link AccessTier}
* @return The updated options.
*/
@@ -106,6 +126,8 @@ public BlockBlobCommitBlockListOptions setTier(AccessTier tier) {
}
/**
+ * Gets the {@link BlobRequestConditions}.
+ *
* @return {@link BlobRequestConditions}
*/
public BlobRequestConditions getRequestConditions() {
@@ -113,6 +135,8 @@ public BlobRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions}.
+ *
* @param requestConditions {@link BlobRequestConditions}
* @return The updated options.
*/
@@ -122,6 +146,8 @@ public BlockBlobCommitBlockListOptions setRequestConditions(BlobRequestCondition
}
/**
+ * Gets the {@link BlobImmutabilityPolicy}.
+ *
* @return {@link BlobImmutabilityPolicy}
*/
public BlobImmutabilityPolicy getImmutabilityPolicy() {
@@ -129,8 +155,11 @@ public BlobImmutabilityPolicy getImmutabilityPolicy() {
}
/**
+ * Sets the {@link BlobImmutabilityPolicy}.
+ *
* Note that this parameter is only applicable to a blob within a container that has immutable storage with
* versioning enabled.
+ *
* @param immutabilityPolicy {@link BlobImmutabilityPolicy}
* @return The updated options.
*/
@@ -140,6 +169,8 @@ public BlockBlobCommitBlockListOptions setImmutabilityPolicy(BlobImmutabilityPol
}
/**
+ * Gets if a legal hold should be placed on the blob.
+ *
* @return If a legal hold should be placed on the blob.
*/
public Boolean isLegalHold() {
@@ -147,8 +178,11 @@ public Boolean isLegalHold() {
}
/**
+ * Sets if a legal hold should be placed on the blob.
+ *
* Note that this parameter is only applicable to a blob within a container that has immutable storage with
* versioning enabled.
+ *
* @param legalHold Indicates if a legal hold should be placed on the blob.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobListBlocksOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobListBlocksOptions.java
index fadc41b926a92..0c561a03eb213 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobListBlocksOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobListBlocksOptions.java
@@ -17,6 +17,8 @@ public class BlockBlobListBlocksOptions {
private String ifTagsMatch;
/**
+ * Creates a new instance of {@link BlockBlobListBlocksOptions}.
+ *
* @param type Specifies which type of blocks to return.
*/
public BlockBlobListBlocksOptions(BlockListType type) {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobOutputStreamOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobOutputStreamOptions.java
index 224c46a4dc1d6..e6385dfe5207e 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobOutputStreamOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobOutputStreamOptions.java
@@ -22,6 +22,14 @@ public class BlockBlobOutputStreamOptions {
private BlobRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link BlockBlobOutputStreamOptions}.
+ */
+ public BlockBlobOutputStreamOptions() {
+ }
+
+ /**
+ * Gets the {@link ParallelTransferOptions}.
+ *
* @return {@link ParallelTransferOptions}
*/
public ParallelTransferOptions getParallelTransferOptions() {
@@ -29,6 +37,8 @@ public ParallelTransferOptions getParallelTransferOptions() {
}
/**
+ * Sets the {@link ParallelTransferOptions}.
+ *
* @param parallelTransferOptions {@link ParallelTransferOptions}
* @return The updated options.
*/
@@ -38,6 +48,8 @@ public BlockBlobOutputStreamOptions setParallelTransferOptions(ParallelTransferO
}
/**
+ * Gets the {@link BlobHttpHeaders}.
+ *
* @return {@link BlobHttpHeaders}
*/
public BlobHttpHeaders getHeaders() {
@@ -45,6 +57,8 @@ public BlobHttpHeaders getHeaders() {
}
/**
+ * Sets the {@link BlobHttpHeaders}.
+ *
* @param headers {@link BlobHttpHeaders}
* @return The updated {@code AppendBlobCreateOptions}
*/
@@ -54,6 +68,8 @@ public BlockBlobOutputStreamOptions setHeaders(BlobHttpHeaders headers) {
}
/**
+ * Gets the metadata to associate with the blob.
+ *
* @return The metadata to associate with the blob.
*/
public Map getMetadata() {
@@ -61,6 +77,8 @@ public Map getMetadata() {
}
/**
+ * Sets the metadata to associate with the blob.
+ *
* @param metadata The metadata to associate with the blob.
* @return The updated options
*/
@@ -70,6 +88,8 @@ public BlockBlobOutputStreamOptions setMetadata(Map metadata) {
}
/**
+ * Gets the tags to associate with the blob.
+ *
* @return The tags to associate with the blob.
*/
public Map getTags() {
@@ -77,6 +97,8 @@ public Map getTags() {
}
/**
+ * Sets the tags to associate with the blob.
+ *
* @param tags The tags to associate with the blob.
* @return The updated options.
*/
@@ -86,6 +108,8 @@ public BlockBlobOutputStreamOptions setTags(Map tags) {
}
/**
+ * Gets the {@link AccessTier}.
+ *
* @return {@link AccessTier}
*/
public AccessTier getTier() {
@@ -93,6 +117,8 @@ public AccessTier getTier() {
}
/**
+ * Sets the {@link AccessTier}.
+ *
* @param tier {@link AccessTier}
* @return The updated options.
*/
@@ -102,6 +128,8 @@ public BlockBlobOutputStreamOptions setTier(AccessTier tier) {
}
/**
+ * Gets the {@link BlobRequestConditions}.
+ *
* @return {@link BlobRequestConditions}
*/
public BlobRequestConditions getRequestConditions() {
@@ -109,6 +137,8 @@ public BlobRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions}.
+ *
* @param requestConditions {@link BlobRequestConditions}
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobSeekableByteChannelWriteOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobSeekableByteChannelWriteOptions.java
index fc543211548a7..1234ea04c7386 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobSeekableByteChannelWriteOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobSeekableByteChannelWriteOptions.java
@@ -3,7 +3,6 @@
package com.azure.storage.blob.options;
import com.azure.core.util.ExpandableStringEnum;
-import com.azure.core.util.logging.ClientLogger;
import com.azure.storage.blob.models.AccessTier;
import com.azure.storage.blob.models.BlobHttpHeaders;
import com.azure.storage.blob.models.BlobRequestConditions;
@@ -16,8 +15,6 @@
* Options for obtaining a {@link java.nio.channels.SeekableByteChannel} backed by an Azure Storage Share File.
*/
public final class BlockBlobSeekableByteChannelWriteOptions {
- private static final ClientLogger LOGGER = new ClientLogger(BlockBlobSeekableByteChannelWriteOptions.class);
-
/**
* Mode to open the channel for writing.
*/
@@ -27,6 +24,15 @@ public static final class WriteMode extends ExpandableStringEnum {
*/
public static final WriteMode OVERWRITE = fromString("Overwrite");
+ /**
+ * Creates a new instance of {@link WriteMode} with no string value.
+ *
+ * @deprecated Please use {@link #fromString(String)}.
+ */
+ @Deprecated
+ public WriteMode() {
+ }
+
/**
* Creates or finds a AccessTier from its string representation.
*
@@ -58,12 +64,15 @@ public static Collection values() {
/**
* Options constructor.
* @param mode What usage mode to open the channel in.
+ * @throws NullPointerException If {@code mode} is null.
*/
public BlockBlobSeekableByteChannelWriteOptions(WriteMode mode) {
writeMode = Objects.requireNonNull(mode, "'mode' cannot be null.");
}
/**
+ * Gets the usage mode to be used by the resulting channel.
+ *
* @return Usage mode to be used by the resulting channel.
*/
public WriteMode getWriteMode() {
@@ -71,6 +80,8 @@ public WriteMode getWriteMode() {
}
/**
+ * Gets the size of individual writes to the service.
+ *
* @return The size of individual writes to the service.
*/
public Long getBlockSizeInBytes() {
@@ -78,6 +89,8 @@ public Long getBlockSizeInBytes() {
}
/**
+ * Sets the size of individual writes to the service.
+ *
* @param blockSizeInBytes The size of individual writes to the service.
* @return The updated instance.
*/
@@ -87,6 +100,8 @@ public BlockBlobSeekableByteChannelWriteOptions setBlockSizeInBytes(Long blockSi
}
/**
+ * Gets the HTTP headers to write.
+ *
* @return Blob HTTP headers to write.
*/
public BlobHttpHeaders getHeaders() {
@@ -94,6 +109,8 @@ public BlobHttpHeaders getHeaders() {
}
/**
+ * Sets the HTTP headers to write.
+ *
* @param headers Blob HTTP headers to write.
* @return The updated instance.
*/
@@ -103,6 +120,8 @@ public BlockBlobSeekableByteChannelWriteOptions setHeaders(BlobHttpHeaders heade
}
/**
+ * Gets the metadata to write.
+ *
* @return Blob metadata to write.
*/
public Map getMetadata() {
@@ -110,6 +129,8 @@ public Map getMetadata() {
}
/**
+ * Sets the metadata to write.
+ *
* @param metadata Blob metadata to write.
* @return The updated instance.
*/
@@ -119,6 +140,8 @@ public BlockBlobSeekableByteChannelWriteOptions setMetadata(Map
}
/**
+ * Gets the tags to write.
+ *
* @return Blob tags to write.
*/
public Map getTags() {
@@ -126,6 +149,8 @@ public Map getTags() {
}
/**
+ * Sets the tags to write.
+ *
* @param tags Blob tags to write.
* @return The updated instance.
*/
@@ -135,6 +160,8 @@ public BlockBlobSeekableByteChannelWriteOptions setTags(Map tags
}
/**
+ * Gets the access tier for the target blob.
+ *
* @return Access tier for the target blob.
*/
public AccessTier getTier() {
@@ -142,6 +169,8 @@ public AccessTier getTier() {
}
/**
+ * Sets the access tier for the target blob.
+ *
* @param tier Access tier for the target blob.
* @return The updated instance.
*/
@@ -151,6 +180,8 @@ public BlockBlobSeekableByteChannelWriteOptions setTier(AccessTier tier) {
}
/**
+ * Gets the request conditions for writing to the blob.
+ *
* @return Request conditions for writing to the blob.
*/
public BlobRequestConditions getRequestConditions() {
@@ -158,6 +189,8 @@ public BlobRequestConditions getRequestConditions() {
}
/**
+ * Sets the request conditions for writing to the blob.
+ *
* @param conditions Request conditions for writing to the blob.
* @return The updated instance.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobSimpleUploadOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobSimpleUploadOptions.java
index a0b2f488dffa8..bef1780c2f597 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobSimpleUploadOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobSimpleUploadOptions.java
@@ -34,8 +34,11 @@ public class BlockBlobSimpleUploadOptions {
private Boolean legalHold;
/**
+ * Creates a new instance of {@link BlockBlobSimpleUploadOptions}.
+ *
* @param data The data to write to the block. Note that this {@code BinaryData} must have defined length
* and must be replayable if retries are enabled (the default), see {@link BinaryData#isReplayable()}.
+ * @throws NullPointerException If {@code data} is null or {@code data} does not have defined length.
*/
public BlockBlobSimpleUploadOptions(BinaryData data) {
StorageImplUtils.assertNotNull("data must not be null", data);
@@ -47,10 +50,14 @@ public BlockBlobSimpleUploadOptions(BinaryData data) {
}
/**
+ * Creates a new instance of {@link BlockBlobSimpleUploadOptions}.
+ *
* @param data The data to write to the blob. Note that this {@code Flux} must be replayable if retries are enabled
* (the default). In other words, the Flux must produce the same data each time it is subscribed to.
* @param length The exact length of the data. It is important that this value match precisely the length of the
* data emitted by the data source.
+ * @throws NullPointerException If {@code data} is null.
+ * @throws IllegalArgumentException If {@code length} is less than 0 or greater than {@link Long#MAX_VALUE}.
*/
public BlockBlobSimpleUploadOptions(Flux data, long length) {
StorageImplUtils.assertNotNull("dataFlux", data);
@@ -62,9 +69,13 @@ public BlockBlobSimpleUploadOptions(Flux data, long length) {
}
/**
+ * Creates a new instance of {@link BlockBlobSimpleUploadOptions}.
+ *
* @param data The data to write to the blob.
* @param length The exact length of the data. It is important that this value match precisely the length of the
* data emitted by the data source.
+ * @throws NullPointerException If {@code data} is null.
+ * @throws IllegalArgumentException If {@code length} is less than 0 or greater than {@link Long#MAX_VALUE}.
*/
public BlockBlobSimpleUploadOptions(InputStream data, long length) {
StorageImplUtils.assertNotNull("dataStream", data);
@@ -76,6 +87,8 @@ public BlockBlobSimpleUploadOptions(InputStream data, long length) {
}
/**
+ * Gets the data to write to the blob.
+ *
* @return The data to write to the blob. Note that this {@code Flux} must be replayable if retries are enabled
* (the default). In other words, the Flux must produce the same data each time it is subscribed to.
*/
@@ -84,6 +97,8 @@ public Flux getDataFlux() {
}
/**
+ * Gets the data to write to the blob.
+ *
* @return The data to write to the blob.
*/
public InputStream getDataStream() {
@@ -91,6 +106,8 @@ public InputStream getDataStream() {
}
/**
+ * Gets the data to write to the blob.
+ *
* @return The data to write to the blob.
*/
public BinaryData getData() {
@@ -98,6 +115,8 @@ public BinaryData getData() {
}
/**
+ * Gets the exact length of the data.
+ *
* @return The exact length of the data. It is important that this value match precisely the length of the
* data emitted by the data source.
*/
@@ -106,6 +125,8 @@ public long getLength() {
}
/**
+ * Gets the {@link BlobHttpHeaders}.
+ *
* @return {@link BlobHttpHeaders}
*/
public BlobHttpHeaders getHeaders() {
@@ -113,6 +134,8 @@ public BlobHttpHeaders getHeaders() {
}
/**
+ * Sets the {@link BlobHttpHeaders}.
+ *
* @param headers {@link BlobHttpHeaders}
* @return The updated options
*/
@@ -122,6 +145,8 @@ public BlockBlobSimpleUploadOptions setHeaders(BlobHttpHeaders headers) {
}
/**
+ * Gets the metadata to associate with the blob.
+ *
* @return The metadata to associate with the blob.
*/
public Map getMetadata() {
@@ -129,6 +154,8 @@ public Map getMetadata() {
}
/**
+ * Sets the metadata to associate with the blob.
+ *
* @param metadata The metadata to associate with the blob.
* @return The updated options
*/
@@ -138,6 +165,8 @@ public BlockBlobSimpleUploadOptions setMetadata(Map metadata) {
}
/**
+ * Gets the tags to associate with the blob.
+ *
* @return The tags to associate with the blob.
*/
public Map getTags() {
@@ -145,6 +174,8 @@ public Map getTags() {
}
/**
+ * Sets the tags to associate with the blob.
+ *
* @param tags The tags to associate with the blob.
* @return The updated options.
*/
@@ -154,6 +185,8 @@ public BlockBlobSimpleUploadOptions setTags(Map tags) {
}
/**
+ * Gets the {@link AccessTier}.
+ *
* @return {@link AccessTier}
*/
public AccessTier getTier() {
@@ -161,6 +194,8 @@ public AccessTier getTier() {
}
/**
+ * Sets the {@link AccessTier}.
+ *
* @param tier {@link AccessTier}
* @return The updated options.
*/
@@ -170,6 +205,8 @@ public BlockBlobSimpleUploadOptions setTier(AccessTier tier) {
}
/**
+ * Gets the MD5 hash of the content.
+ *
* @return An MD5 hash of the content. This hash is used to verify the integrity of the content during
* transport. When this header is specified, the storage service compares the hash of the content that has arrived
* with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the
@@ -180,6 +217,8 @@ public byte[] getContentMd5() {
}
/**
+ * Sets the MD5 hash of the content.
+ *
* @param contentMd5 An MD5 hash of the block content. This hash is used to verify the integrity of the block during
* transport. When this header is specified, the storage service compares the hash of the content that has arrived
* with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the
@@ -192,6 +231,8 @@ public BlockBlobSimpleUploadOptions setContentMd5(byte[] contentMd5) {
}
/**
+ * Gets the {@link BlobRequestConditions}.
+ *
* @return {@link BlobRequestConditions}
*/
public BlobRequestConditions getRequestConditions() {
@@ -199,6 +240,8 @@ public BlobRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions}.
+ *
* @param requestConditions {@link BlobRequestConditions}
* @return The updated options.
*/
@@ -208,6 +251,8 @@ public BlockBlobSimpleUploadOptions setRequestConditions(BlobRequestConditions r
}
/**
+ * Gets the {@link BlobImmutabilityPolicy}.
+ *
* @return {@link BlobImmutabilityPolicy}
*/
public BlobImmutabilityPolicy getImmutabilityPolicy() {
@@ -215,6 +260,8 @@ public BlobImmutabilityPolicy getImmutabilityPolicy() {
}
/**
+ * Sets the {@link BlobImmutabilityPolicy}.
+ *
* Note that this parameter is only applicable to a blob within a container that has immutable storage with
* versioning enabled.
* @param immutabilityPolicy {@link BlobImmutabilityPolicy}
@@ -226,6 +273,8 @@ public BlockBlobSimpleUploadOptions setImmutabilityPolicy(BlobImmutabilityPolicy
}
/**
+ * Gets if a legal hold should be placed on the blob.
+ *
* @return If a legal hold should be placed on the blob.
*/
public Boolean isLegalHold() {
@@ -233,6 +282,8 @@ public Boolean isLegalHold() {
}
/**
+ * Sets if a legal hold should be placed on the blob.
+ *
* Note that this parameter is only applicable to a blob within a container that has immutable storage with
* versioning enabled.
* @param legalHold Indicates if a legal hold should be placed on the blob.
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobStageBlockFromUrlOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobStageBlockFromUrlOptions.java
index 49e73198ae78b..923cc7bd991e0 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobStageBlockFromUrlOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobStageBlockFromUrlOptions.java
@@ -23,6 +23,8 @@ public final class BlockBlobStageBlockFromUrlOptions {
private HttpAuthorization sourceAuthorization;
/**
+ * Creates a new instance of {@link BlockBlobStageBlockFromUrlOptions}.
+ *
* @param base64BlockId The block ID to assign the new block.
* @param sourceUrl The source URL to copy from. URLs outside of Azure may only be copied to block blobs.
*/
@@ -32,6 +34,8 @@ public BlockBlobStageBlockFromUrlOptions(String base64BlockId, String sourceUrl)
}
/**
+ * Gets the block ID to assign the new block.
+ *
* @return The block ID to assign the new block.
*/
public String getBase64BlockId() {
@@ -39,6 +43,8 @@ public String getBase64BlockId() {
}
/**
+ * Gets the source URL to upload from.
+ *
* @return The source URL to upload from.
*/
public String getSourceUrl() {
@@ -46,6 +52,8 @@ public String getSourceUrl() {
}
/**
+ * Gets the range of bytes to read from the source.
+ *
* @return Range of bytes to read from the source.
*/
public BlobRange getSourceRange() {
@@ -53,6 +61,8 @@ public BlobRange getSourceRange() {
}
/**
+ * Sets the range of bytes to read from the source.
+ *
* @param sourceRange Range of bytes to read from the source.
* @return The updated options.
*/
@@ -62,6 +72,8 @@ public BlockBlobStageBlockFromUrlOptions setSourceRange(BlobRange sourceRange) {
}
/**
+ * Gets the MD5 of the source content.
+ *
* @return MD5 of the source content.
*/
public byte[] getSourceContentMd5() {
@@ -69,6 +81,8 @@ public byte[] getSourceContentMd5() {
}
/**
+ * Sets the MD5 of the source content.
+ *
* @param sourceContentMd5 MD5 of the source content.
* @return The updated options.
*/
@@ -78,6 +92,8 @@ public BlockBlobStageBlockFromUrlOptions setSourceContentMd5(byte[] sourceConten
}
/**
+ * Gets the lease ID for accessing source content.
+ *
* @return Lease ID for accessing source content.
*/
public String getLeaseId() {
@@ -85,6 +101,8 @@ public String getLeaseId() {
}
/**
+ * Sets the lease ID for accessing source content.
+ *
* @param leaseId Lease ID for accessing source content.
* @return The updated options.
*/
@@ -94,6 +112,8 @@ public BlockBlobStageBlockFromUrlOptions setLeaseId(String leaseId) {
}
/**
+ * Gets the {@link BlobRequestConditions} for accessing source content.
+ *
* @return {@link BlobRequestConditions} for accessing source content.
*/
public BlobRequestConditions getSourceRequestConditions() {
@@ -101,6 +121,8 @@ public BlobRequestConditions getSourceRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions} for accessing source content.
+ *
* @param sourceRequestConditions {@link BlobRequestConditions} for accessing source content.
* @return The updated options.
*/
@@ -110,6 +132,9 @@ public BlockBlobStageBlockFromUrlOptions setSourceRequestConditions(BlobRequestC
}
/**
+ * Gets "Authorization" header for accessing source URL. Currently only "Bearer" authentication is accepted by
+ * Storage.
+ *
* @return auth header to access source.
*/
public HttpAuthorization getSourceAuthorization() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobStageBlockOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobStageBlockOptions.java
index e9d5c78bfe187..37445b450a28e 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobStageBlockOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/BlockBlobStageBlockOptions.java
@@ -19,9 +19,12 @@ public final class BlockBlobStageBlockOptions {
private byte[] contentMd5;
/**
+ * Creates a new instance of {@link BlockBlobStageBlockOptions}.
+ *
* @param base64BlockId The block ID to assign the new block.
* @param data The data to write to the block. Note that this {@code BinaryData} must have defined length
* and must be replayable if retries are enabled (the default), see {@link BinaryData#isReplayable()}.
+ * @throws NullPointerException If {@code base64BlockId} or {@code data} is null.
*/
public BlockBlobStageBlockOptions(String base64BlockId, BinaryData data) {
StorageImplUtils.assertNotNull("base64BlockId must not be null", base64BlockId);
@@ -32,6 +35,8 @@ public BlockBlobStageBlockOptions(String base64BlockId, BinaryData data) {
}
/**
+ * Gets the block ID to assign the new block.
+ *
* @return The block ID to assign the new block.
*/
public String getBase64BlockId() {
@@ -39,6 +44,8 @@ public String getBase64BlockId() {
}
/**
+ * Gets the data to write to the blob.
+ *
* @return The data to write to the blob.
*/
public BinaryData getData() {
@@ -46,6 +53,8 @@ public BinaryData getData() {
}
/**
+ * Gets the lease ID for accessing source content.
+ *
* @return Lease ID for accessing source content.
*/
public String getLeaseId() {
@@ -53,6 +62,8 @@ public String getLeaseId() {
}
/**
+ * Sets the lease ID for accessing source content.
+ *
* @param leaseId Lease ID for accessing source content.
* @return The updated options.
*/
@@ -62,6 +73,8 @@ public BlockBlobStageBlockOptions setLeaseId(String leaseId) {
}
/**
+ * Gets the MD5 of the block content.
+ *
* @return An MD5 hash of the content. This hash is used to verify the integrity of the content during
* transport. When this header is specified, the storage service compares the hash of the content that has arrived
* with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the
@@ -72,6 +85,8 @@ public byte[] getContentMd5() {
}
/**
+ * Sets the MD5 of the block content.
+ *
* @param contentMd5 An MD5 hash of the block content. This hash is used to verify the integrity of the block during
* transport. When this header is specified, the storage service compares the hash of the content that has arrived
* with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/FindBlobsOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/FindBlobsOptions.java
index 73d8ac6774547..35b00eaf8d40f 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/FindBlobsOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/FindBlobsOptions.java
@@ -22,7 +22,10 @@ public class FindBlobsOptions {
private Integer maxResultsPerPage;
/**
+ * Creates a new instance of {@link FindBlobsOptions}.
+ *
* @param query Filters the results to return only blobs whose tags match the specified expression.
+ * @throws NullPointerException If {@code query} is null.
*/
public FindBlobsOptions(String query) {
StorageImplUtils.assertNotNull("query", query);
@@ -30,6 +33,8 @@ public FindBlobsOptions(String query) {
}
/**
+ * Gets the filters the results to return only blobs whose tags match the specified expression.
+ *
* @return Filters the results to return only blobs whose tags match the specified expression.
*/
public String getQuery() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/ListPageRangesDiffOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/ListPageRangesDiffOptions.java
index 42b01c2852c49..1e22f0263293c 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/ListPageRangesDiffOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/ListPageRangesDiffOptions.java
@@ -19,8 +19,11 @@ public class ListPageRangesDiffOptions {
private Integer pageSize;
/**
+ * Creates a new instance of {@link ListPageRangesDiffOptions}.
+ *
* @param range The range to diff.
* @param previousSnapshot The previous snapshot that will serve as the base of the diff.
+ * @throws NullPointerException If {@code range} or {@code previousSnapshot} is null.
*/
public ListPageRangesDiffOptions(BlobRange range, String previousSnapshot) {
Objects.requireNonNull(range);
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/ListPageRangesOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/ListPageRangesOptions.java
index 3c7282a686a3c..2d4953b3f59e3 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/ListPageRangesOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/ListPageRangesOptions.java
@@ -18,7 +18,10 @@ public class ListPageRangesOptions {
private Integer pageSize;
/**
+ * Creates a new instance of {@link ListPageRangesOptions}.
+ *
* @param range The range to diff.
+ * @throws NullPointerException If {@code range} is null.
*/
public ListPageRangesOptions(BlobRange range) {
Objects.requireNonNull(range);
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/PageBlobCopyIncrementalOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/PageBlobCopyIncrementalOptions.java
index a221064153196..d6962ad4f6b07 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/PageBlobCopyIncrementalOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/PageBlobCopyIncrementalOptions.java
@@ -18,8 +18,11 @@ public class PageBlobCopyIncrementalOptions {
private PageBlobCopyIncrementalRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link PageBlobCopyIncrementalOptions}.
+ *
* @param source The source page blob.
* @param snapshot The snapshot on the copy source.
+ * @throws NullPointerException If {@code source} or {@code snapshot} is null.
*/
public PageBlobCopyIncrementalOptions(String source, String snapshot) {
StorageImplUtils.assertNotNull("source", source);
@@ -29,6 +32,8 @@ public PageBlobCopyIncrementalOptions(String source, String snapshot) {
}
/**
+ * Gets the source page blob.
+ *
* @return The source page blob.
*/
public String getSource() {
@@ -36,6 +41,8 @@ public String getSource() {
}
/**
+ * Gets the snapshot on the copy source.
+ *
* @return The snapshot on the copy source.
*/
public String getSnapshot() {
@@ -43,6 +50,8 @@ public String getSnapshot() {
}
/**
+ * Gets the {@link PageBlobCopyIncrementalRequestConditions} for the destination.
+ *
* @return {@link PageBlobCopyIncrementalRequestConditions} for the destination.
*/
public PageBlobCopyIncrementalRequestConditions getRequestConditions() {
@@ -50,6 +59,8 @@ public PageBlobCopyIncrementalRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link PageBlobCopyIncrementalRequestConditions} for the blob.
+ *
* @param requestConditions {@link PageBlobCopyIncrementalRequestConditions} for the blob.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/PageBlobCreateOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/PageBlobCreateOptions.java
index 915b1da1071c9..0ea380380c873 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/PageBlobCreateOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/PageBlobCreateOptions.java
@@ -23,6 +23,8 @@ public class PageBlobCreateOptions {
private Boolean legalHold;
/**
+ * Creates a new instance of {@link PageBlobCreateOptions}.
+ *
* @param size Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a
* 512-byte boundary.
*/
@@ -31,6 +33,8 @@ public PageBlobCreateOptions(long size) {
}
/**
+ * Gets the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a 512-byte boundary.
+ *
* @return Specifies the maximum size for the page blob, up to 8 TB. The page blob size must be aligned to a
* 512-byte boundary.
*/
@@ -39,6 +43,9 @@ public long getSize() {
}
/**
+ * Gets a user-controlled value that you can use to track requests. The value of the sequence number must be
+ * between 0 and 2^63 - 1.The default value is 0.
+ *
* @return A user-controlled value that you can use to track requests. The value of the sequence
* number must be between 0 and 2^63 - 1.The default value is 0.
*/
@@ -47,6 +54,9 @@ public Long getSequenceNumber() {
}
/**
+ * Sets a user-controlled value that you can use to track requests. The value of the sequence number must be
+ * between 0 and 2^63 - 1.The default value is 0.
+ *
* @param sequenceNumber A user-controlled value that you can use to track requests. The value of the sequence
* number must be between 0 and 2^63 - 1.The default value is 0.
* @return The updated options.
@@ -57,6 +67,8 @@ public PageBlobCreateOptions setSequenceNumber(Long sequenceNumber) {
}
/**
+ * Gets the {@link BlobHttpHeaders}.
+ *
* @return {@link BlobHttpHeaders}
*/
public BlobHttpHeaders getHeaders() {
@@ -64,6 +76,8 @@ public BlobHttpHeaders getHeaders() {
}
/**
+ * Sets the {@link BlobHttpHeaders}.
+ *
* @param headers {@link BlobHttpHeaders}
* @return The updated {@code AppendBlobCreateOptions}
*/
@@ -73,6 +87,8 @@ public PageBlobCreateOptions setHeaders(BlobHttpHeaders headers) {
}
/**
+ * Gets the metadata to associate with the blob.
+ *
* @return The metadata to associate with the blob.
*/
public Map getMetadata() {
@@ -80,6 +96,8 @@ public Map getMetadata() {
}
/**
+ * Sets the metadata to associate with the blob.
+ *
* @param metadata The metadata to associate with the blob.
* @return The updated options.
*/
@@ -89,6 +107,8 @@ public PageBlobCreateOptions setMetadata(Map metadata) {
}
/**
+ * Gets the tags to associate with the blob.
+ *
* @return The tags to associate with the blob.
*/
public Map getTags() {
@@ -96,6 +116,8 @@ public Map getTags() {
}
/**
+ * Sets the tags to associate with the blob.
+ *
* @param tags The tags to associate with the blob.
* @return The updated options.
*/
@@ -105,6 +127,8 @@ public PageBlobCreateOptions setTags(Map tags) {
}
/**
+ * Gets the {@link BlobRequestConditions}.
+ *
* @return {@link BlobRequestConditions}
*/
public BlobRequestConditions getRequestConditions() {
@@ -112,6 +136,8 @@ public BlobRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link BlobRequestConditions}.
+ *
* @param requestConditions {@link BlobRequestConditions}
* @return The updated options.
*/
@@ -121,6 +147,8 @@ public PageBlobCreateOptions setRequestConditions(BlobRequestConditions requestC
}
/**
+ * Gets the {@link BlobImmutabilityPolicy}.
+ *
* @return {@link BlobImmutabilityPolicy}
*/
public BlobImmutabilityPolicy getImmutabilityPolicy() {
@@ -128,8 +156,11 @@ public BlobImmutabilityPolicy getImmutabilityPolicy() {
}
/**
+ * Sets the {@link BlobImmutabilityPolicy}.
+ *
* Note that this parameter is only applicable to a blob within a container that has immutable storage with
* versioning enabled.
+ *
* @param immutabilityPolicy {@link BlobImmutabilityPolicy}
* @return The updated options.
*/
@@ -139,6 +170,8 @@ public PageBlobCreateOptions setImmutabilityPolicy(BlobImmutabilityPolicy immuta
}
/**
+ * Gets if a legal hold should be placed on the blob.
+ *
* @return If a legal hold should be placed on the blob.
*/
public Boolean isLegalHold() {
@@ -146,8 +179,11 @@ public Boolean isLegalHold() {
}
/**
+ * Sets if a legal hold should be placed on the blob.
+ *
* Note that this parameter is only applicable to a blob within a container that has immutable storage with
* versioning enabled.
+ *
* @param legalHold Indicates if a legal hold should be placed on the blob.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/PageBlobUploadPagesFromUrlOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/PageBlobUploadPagesFromUrlOptions.java
index 5f6f46377369f..45b0ea5630e3c 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/PageBlobUploadPagesFromUrlOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/PageBlobUploadPagesFromUrlOptions.java
@@ -24,6 +24,8 @@ public final class PageBlobUploadPagesFromUrlOptions {
private HttpAuthorization sourceAuthorization;
/**
+ * Creates a new instance of {@link PageBlobUploadPagesFromUrlOptions}.
+ *
* @param range The destination page range. Pages must be aligned to 512 byte blocks.
* @param sourceUrl The source URL to copy from. URLs outside of Azure may only be copied to block blobs.
*/
@@ -33,6 +35,7 @@ public PageBlobUploadPagesFromUrlOptions(PageRange range, String sourceUrl) {
}
/**
+ * Gets the destination page range.
* @return The destination page range.
*/
public PageRange getRange() {
@@ -40,6 +43,8 @@ public PageRange getRange() {
}
/**
+ * Gets the source URL to copy from.
+ *
* @return the source URL to copy from.
*/
public String getSourceUrl() {
@@ -47,6 +52,8 @@ public String getSourceUrl() {
}
/**
+ * Gets the offset at source to copy from.
+ *
* @return Offset at source to copy from.
*/
public Long getSourceOffset() {
@@ -54,6 +61,8 @@ public Long getSourceOffset() {
}
/**
+ * Sets the offset at source to copy from.
+ *
* @param sourceOffset Offset at source to copy from.
* @return The updated options.
*/
@@ -63,6 +72,8 @@ public PageBlobUploadPagesFromUrlOptions setSourceOffset(Long sourceOffset) {
}
/**
+ * Gets the content MD5 of source content to copy.
+ *
* @return Content MD5 of source content to copy.
*/
public byte[] getSourceContentMd5() {
@@ -70,6 +81,8 @@ public byte[] getSourceContentMd5() {
}
/**
+ * Sets the content MD5 of source content to copy.
+ *
* @param sourceContentMd5 Content MD5 of source content to copy.
* @return The updated options.
*/
@@ -79,6 +92,8 @@ public PageBlobUploadPagesFromUrlOptions setSourceContentMd5(byte[] sourceConten
}
/**
+ * Gets {@link PageBlobRequestConditions} for writing to destination.
+ *
* @return {@link PageBlobRequestConditions} for writing to destination.
*/
public PageBlobRequestConditions getDestinationRequestConditions() {
@@ -86,6 +101,8 @@ public PageBlobRequestConditions getDestinationRequestConditions() {
}
/**
+ * Sets {@link PageBlobRequestConditions} for writing to destination.
+ *
* @param destinationRequestConditions {@link PageBlobRequestConditions} for writing to destination.
* @return The updated options.
*/
@@ -96,6 +113,8 @@ public PageBlobRequestConditions getDestinationRequestConditions() {
}
/**
+ * Gets {@link BlobRequestConditions} for accessing source content.
+ *
* @return {@link BlobRequestConditions} for accessing source content.
*/
public BlobRequestConditions getSourceRequestConditions() {
@@ -103,6 +122,8 @@ public BlobRequestConditions getSourceRequestConditions() {
}
/**
+ * Sets {@link BlobRequestConditions} for accessing source content.
+ *
* @param sourceRequestConditions {@link BlobRequestConditions} for accessing source content.
* @return The updated options.
*/
@@ -112,6 +133,9 @@ public PageBlobUploadPagesFromUrlOptions setSourceRequestConditions(BlobRequestC
}
/**
+ * Gets "Authorization" header for accessing source URL. Currently only "Bearer" authentication is accepted by
+ * Storage.
+ *
* @return auth header for accessing source content.
*/
public HttpAuthorization getSourceAuthorization() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/UndeleteBlobContainerOptions.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/UndeleteBlobContainerOptions.java
index ecbf74ffd52b5..2660163c1b76a 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/UndeleteBlobContainerOptions.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/options/UndeleteBlobContainerOptions.java
@@ -20,6 +20,7 @@ public class UndeleteBlobContainerOptions {
*
* @param deletedContainerName The name of the previously deleted container.
* @param deletedContainerVersion The version of the previously deleted container.
+ * @throws NullPointerException If {@code deletedContainerName} or {@code deletedContainerVersion} is null.
*/
public UndeleteBlobContainerOptions(String deletedContainerName, String deletedContainerVersion) {
StorageImplUtils.assertNotNull("deletedContainerName", deletedContainerName);
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/sas/BlobContainerSasPermission.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/sas/BlobContainerSasPermission.java
index 911d29e737385..e34e3e122fd18 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/sas/BlobContainerSasPermission.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/sas/BlobContainerSasPermission.java
@@ -15,27 +15,16 @@
*/
public final class BlobContainerSasPermission {
private boolean readPermission;
-
private boolean addPermission;
-
private boolean createPermission;
-
private boolean writePermission;
-
private boolean deletePermission;
-
private boolean deleteVersionPermission;
-
private boolean listPermission;
-
private boolean tagsPermission;
-
private boolean movePermission;
-
private boolean executePermission;
-
private boolean filterPermission;
-
private boolean immutabilityPolicyPermission;
/**
@@ -116,6 +105,8 @@ public static BlobContainerSasPermission parse(String permissionString) {
}
/**
+ * Gets the read permission status.
+ *
* @return the read permission status
*/
public boolean hasReadPermission() {
@@ -134,6 +125,8 @@ public BlobContainerSasPermission setReadPermission(boolean hasReadPermission) {
}
/**
+ * Gets the add permission status.
+ *
* @return the add permission status
*/
public boolean hasAddPermission() {
@@ -152,6 +145,8 @@ public BlobContainerSasPermission setAddPermission(boolean hasAddPermission) {
}
/**
+ * Gets the create permission status.
+ *
* @return the create permission status
*/
public boolean hasCreatePermission() {
@@ -170,6 +165,8 @@ public BlobContainerSasPermission setCreatePermission(boolean hasCreatePermissio
}
/**
+ * Gets the write permission status.
+ *
* @return the write permission status
*/
public boolean hasWritePermission() {
@@ -188,6 +185,8 @@ public BlobContainerSasPermission setWritePermission(boolean hasWritePermission)
}
/**
+ * Gets the delete permission status.
+ *
* @return the delete permission status
*/
public boolean hasDeletePermission() {
@@ -206,6 +205,8 @@ public BlobContainerSasPermission setDeletePermission(boolean hasDeletePermissio
}
/**
+ * Gets the delete version permission status.
+ *
* @return the delete version permission status
*/
public boolean hasDeleteVersionPermission() {
@@ -224,6 +225,8 @@ public BlobContainerSasPermission setDeleteVersionPermission(boolean hasDeleteVe
}
/**
+ * Gets the list permission status.
+ *
* @return the list permission status
*/
public boolean hasListPermission() {
@@ -242,6 +245,8 @@ public BlobContainerSasPermission setListPermission(boolean hasListPermission) {
}
/**
+ * Gets the tags permission status.
+ *
* @return the tags permission status.
*/
public boolean hasTagsPermission() {
@@ -260,6 +265,8 @@ public BlobContainerSasPermission setTagsPermission(boolean tagsPermission) {
}
/**
+ * Gets the move permission status.
+ *
* @return the move permission status.
*/
public boolean hasMovePermission() {
@@ -278,6 +285,8 @@ public BlobContainerSasPermission setMovePermission(boolean hasMovePermission) {
}
/**
+ * Gets the execute permission status.
+ *
* @return the execute permission status.
*/
public boolean hasExecutePermission() {
@@ -296,6 +305,8 @@ public BlobContainerSasPermission setExecutePermission(boolean hasExecutePermiss
}
/**
+ * Gets the filter permission status.
+ *
* @return the filter permission status.
*/
public boolean hasFilterPermission() {
@@ -314,6 +325,8 @@ public BlobContainerSasPermission setFilterPermission(boolean hasFilterPermissio
}
/**
+ * Gets the set immutability policy permission status.
+ *
* @return the set immutability policy permission status.
*/
public boolean hasImmutabilityPolicyPermission() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/sas/BlobSasPermission.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/sas/BlobSasPermission.java
index 71caaa1683d4f..26767e7389bfa 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/sas/BlobSasPermission.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/sas/BlobSasPermission.java
@@ -14,29 +14,17 @@
* this class guarantees correctness.
*/
public final class BlobSasPermission {
-
private boolean readPermission;
-
private boolean addPermission;
-
private boolean createPermission;
-
private boolean writePermission;
-
private boolean deletePermission;
-
private boolean deleteVersionPermission;
-
private boolean permanentDeletePermission;
-
private boolean tagsPermission;
-
private boolean listPermission;
-
private boolean movePermission;
-
private boolean executePermission;
-
private boolean immutabilityPolicyPermission;
/**
@@ -117,6 +105,8 @@ public static BlobSasPermission parse(String permissionString) {
}
/**
+ * Gets the read permission status.
+ *
* @return the read permission status.
*/
public boolean hasReadPermission() {
@@ -135,6 +125,8 @@ public BlobSasPermission setReadPermission(boolean hasReadPermission) {
}
/**
+ * Gets the add permission status.
+ *
* @return the add permission status.
*/
public boolean hasAddPermission() {
@@ -153,6 +145,8 @@ public BlobSasPermission setAddPermission(boolean hasAddPermission) {
}
/**
+ * Gets the create permission status.
+ *
* @return the create permission status.
*/
public boolean hasCreatePermission() {
@@ -171,6 +165,8 @@ public BlobSasPermission setCreatePermission(boolean hasCreatePermission) {
}
/**
+ * Gets the write permission status.
+ *
* @return the write permission status.
*/
public boolean hasWritePermission() {
@@ -189,6 +185,8 @@ public BlobSasPermission setWritePermission(boolean hasWritePermission) {
}
/**
+ * Gets the delete permission status.
+ *
* @return the delete permission status.
*/
public boolean hasDeletePermission() {
@@ -207,6 +205,8 @@ public BlobSasPermission setDeletePermission(boolean hasDeletePermission) {
}
/**
+ * Gets the delete version permission status.
+ *
* @return the delete version permission status.
*/
public boolean hasDeleteVersionPermission() {
@@ -225,6 +225,8 @@ public BlobSasPermission setDeleteVersionPermission(boolean hasDeleteVersionPerm
}
/**
+ * Gets the permanent delete permission status.
+ *
* @return the permanent delete permission status.
*/
public boolean hasPermanentDeletePermission() {
@@ -243,6 +245,8 @@ public BlobSasPermission setPermanentDeletePermission(boolean permanentDeletePer
}
/**
+ * Gets the tags permission status.
+ *
* @return the tags permission status.
*/
public boolean hasTagsPermission() {
@@ -261,6 +265,8 @@ public BlobSasPermission setTagsPermission(boolean tagsPermission) {
}
/**
+ * Gets the list permission status.
+ *
* @return the list permission status.
*/
public boolean hasListPermission() {
@@ -279,6 +285,8 @@ public BlobSasPermission setListPermission(boolean hasListPermission) {
}
/**
+ * Gets the move permission status.
+ *
* @return the move permission status.
*/
public boolean hasMovePermission() {
@@ -297,6 +305,8 @@ public BlobSasPermission setMovePermission(boolean hasMovePermission) {
}
/**
+ * Gets the execute permission status.
+ *
* @return the execute permission status.
*/
public boolean hasExecutePermission() {
@@ -315,6 +325,8 @@ public BlobSasPermission setExecutePermission(boolean hasExecutePermission) {
}
/**
+ * Gets the set immutability policy permission status.
+ *
* @return the set immutability policy permission status.
*/
public boolean hasImmutabilityPolicyPermission() {
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/sas/BlobServiceSasSignatureValues.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/sas/BlobServiceSasSignatureValues.java
index 6793e0ff5ead0..113672d9522c9 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/sas/BlobServiceSasSignatureValues.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/sas/BlobServiceSasSignatureValues.java
@@ -8,10 +8,10 @@
import com.azure.core.util.logging.ClientLogger;
import com.azure.storage.blob.BlobServiceVersion;
import com.azure.storage.blob.models.UserDelegationKey;
+import com.azure.storage.common.StorageSharedKeyCredential;
import com.azure.storage.common.Utility;
import com.azure.storage.common.implementation.Constants;
import com.azure.storage.common.implementation.StorageImplUtils;
-import com.azure.storage.common.StorageSharedKeyCredential;
import com.azure.storage.common.sas.SasIpRange;
import com.azure.storage.common.sas.SasProtocol;
@@ -65,43 +65,27 @@ public final class BlobServiceSasSignatureValues {
.get(Constants.PROPERTY_AZURE_STORAGE_SAS_SERVICE_VERSION, BlobServiceVersion.V2019_12_12.getVersion());
private SasProtocol protocol;
-
private OffsetDateTime startTime;
-
private OffsetDateTime expiryTime;
-
private String permissions;
-
private SasIpRange sasIpRange;
-
private String containerName;
-
private String blobName;
-
private String resource;
-
private String snapshotId;
-
private String identifier;
-
private String cacheControl;
-
private String contentDisposition;
-
private String contentEncoding;
-
private String contentLanguage;
-
private String contentType;
-
private String preauthorizedAgentObjectId; /* saoid */
-
private String correlationId;
-
private String encryptionScope;
/**
* Creates an object with empty values for all fields.
+ *
* @deprecated Please use {@link #BlobServiceSasSignatureValues(String)},
* {@link #BlobServiceSasSignatureValues(OffsetDateTime, BlobSasPermission)}, or
* {@link #BlobServiceSasSignatureValues(OffsetDateTime, BlobContainerSasPermission)}
@@ -151,7 +135,7 @@ public BlobServiceSasSignatureValues(String identifier) {
* Creates an object with the specified values.
*
* @param version The version of the service this SAS will target. If not specified, it will default to the version
- * targeted by the library.
+ * targeted by the library.
* @param sasProtocol The {@link SasProtocol} which determines the protocols allowed by the SAS.
* @param startTime When the SAS will take effect.
* @param expiryTime The time after which the SAS will no longer work.
@@ -186,6 +170,9 @@ public BlobServiceSasSignatureValues(String version, SasProtocol sasProtocol, Of
}
/**
+ * Gets the version of the service this SAS will target. If not specified, it will default to the version targeted
+ * by the library.
+ *
* @return the version of the service this SAS will target. If not specified, it will default to the version
* targeted by the library.
*/
@@ -209,6 +196,8 @@ public BlobServiceSasSignatureValues setVersion(String version) {
}
/**
+ * Gets the {@link SasProtocol} which determines the protocols allowed by the SAS.
+ *
* @return the {@link SasProtocol} which determines the protocols allowed by the SAS.
*/
public SasProtocol getProtocol() {
@@ -227,6 +216,8 @@ public BlobServiceSasSignatureValues setProtocol(SasProtocol protocol) {
}
/**
+ * Gets when the SAS will take effect.
+ *
* @return when the SAS will take effect.
*/
public OffsetDateTime getStartTime() {
@@ -245,6 +236,8 @@ public BlobServiceSasSignatureValues setStartTime(OffsetDateTime startTime) {
}
/**
+ * Gets the time after which the SAS will no longer work.
+ *
* @return the time after which the SAS will no longer work.
*/
public OffsetDateTime getExpiryTime() {
@@ -263,6 +256,9 @@ public BlobServiceSasSignatureValues setExpiryTime(OffsetDateTime expiryTime) {
}
/**
+ * Gets the permissions string allowed by the SAS. Please refer to either {@link BlobContainerSasPermission} or
+ * {@link BlobSasPermission} depending on the resource being accessed for help determining the permissions allowed.
+ *
* @return the permissions string allowed by the SAS. Please refer to either {@link BlobContainerSasPermission} or
* {@link BlobSasPermission} depending on the resource being accessed for help determining the permissions allowed.
*/
@@ -297,6 +293,8 @@ public BlobServiceSasSignatureValues setPermissions(BlobContainerSasPermission p
}
/**
+ * Gets the {@link SasIpRange} which determines the IP ranges that are allowed to use the SAS.
+ *
* @return the {@link SasIpRange} which determines the IP ranges that are allowed to use the SAS.
*/
public SasIpRange getSasIpRange() {
@@ -306,9 +304,9 @@ public SasIpRange getSasIpRange() {
/**
* Sets the {@link SasIpRange} which determines the IP ranges that are allowed to use the SAS.
*
- * @see Specifying IP Address or IP range
* @param sasIpRange Allowed IP range to set
* @return the updated BlobServiceSASSignatureValues object
+ * @see Specifying IP Address or IP range
*/
public BlobServiceSasSignatureValues setSasIpRange(SasIpRange sasIpRange) {
this.sasIpRange = sasIpRange;
@@ -369,6 +367,8 @@ public BlobServiceSasSignatureValues setBlobName(String blobName) {
}
/**
+ * Gets the specific snapshot the SAS user may access.
+ *
* @return the specific snapshot the SAS user may access.
* @deprecated Snapshot id is now auto-populated by the SAS generation methods provided on the desired (snapshot)
* blob client.
@@ -399,6 +399,10 @@ public BlobServiceSasSignatureValues setSnapshotId(String snapshotId) {
}
/**
+ * Gets the name of the access policy on the container this SAS references if any. Please see
+ * here
+ * for more information.
+ *
* @return the name of the access policy on the container this SAS references if any. Please see
* here
* for more information.
@@ -421,6 +425,8 @@ public BlobServiceSasSignatureValues setIdentifier(String identifier) {
}
/**
+ * Gets the encryption scope to use for the SAS.
+ *
* @return the cache-control header for the SAS.
*/
public String getCacheControl() {
@@ -439,6 +445,8 @@ public BlobServiceSasSignatureValues setCacheControl(String cacheControl) {
}
/**
+ * Gets the content-disposition header for the SAS.
+ *
* @return the content-disposition header for the SAS.
*/
public String getContentDisposition() {
@@ -457,6 +465,8 @@ public BlobServiceSasSignatureValues setContentDisposition(String contentDisposi
}
/**
+ * Gets the content-encoding header for the SAS.
+ *
* @return the content-encoding header for the SAS.
*/
public String getContentEncoding() {
@@ -475,6 +485,8 @@ public BlobServiceSasSignatureValues setContentEncoding(String contentEncoding)
}
/**
+ * Gets the content-language header for the SAS.
+ *
* @return the content-language header for the SAS.
*/
public String getContentLanguage() {
@@ -493,6 +505,8 @@ public BlobServiceSasSignatureValues setContentLanguage(String contentLanguage)
}
/**
+ * Gets the content-type header for the SAS.
+ *
* @return the content-type header for the SAS.
*/
public String getContentType() {
@@ -511,6 +525,9 @@ public BlobServiceSasSignatureValues setContentType(String contentType) {
}
/**
+ * Gets the AAD object ID of a user assumed to be authorized by the owner of the user delegation key to perform the
+ * action granted by the SAS token.
+ *
* @return The AAD object ID of a user assumed to be authorized by the owner of the user delegation key to perform
* the action granted by the SAS token. The service will validate the SAS token and ensure that the owner of the
* user delegation key has the required permissions before granting access but no additional permission check for
@@ -536,6 +553,8 @@ public BlobServiceSasSignatureValues setPreauthorizedAgentObjectId(String preaut
}
/**
+ * Gets the encryption scope to use for the SAS.
+ *
* @return the correlation id value for the SAS.
*/
public String getCorrelationId() {
@@ -635,7 +654,7 @@ public BlobServiceSasSignatureValues setCorrelationId(String correlationId) {
* @throws IllegalArgumentException if {@link #getPermissions()} contains an invalid character for the SAS resource.
* @throws NullPointerException if {@code delegationKey} or {@code account} is null.
* @see
- * Create a user delegation SAS
+ * Create a user delegation SAS
* @deprecated Please use the generateUserDelegationSas(BlobServiceSasSignatureValues, UserDelegationKey) method on
* the desired container/blob client after initializing {@link BlobServiceSasSignatureValues}.
*/
@@ -660,14 +679,14 @@ public BlobServiceSasQueryParameters generateSasQueryParameters(UserDelegationKe
/**
* Ensures that the builder's properties are in a consistent state.
-
+ *
* 1. If there is no version, use latest.
* 2. Resource name is chosen by:
- * a. If "BlobName" is _not_ set, it is a container resource.
- * b. Otherwise, if "SnapshotId" is set, it is a blob snapshot resource.
- * c. Otherwise, it is a blob resource.
+ * a. If "BlobName" is _not_ set, it is a container resource.
+ * b. Otherwise, if "SnapshotId" is set, it is a blob snapshot resource.
+ * c. Otherwise, it is a blob resource.
* 3. Reparse permissions depending on what the resource is. If it is an unrecognised resource, do nothing.
- *
+ *
* Taken from:
* https://github.com/Azure/azure-storage-blob-go/blob/master/azblob/sas_service.go#L33
* https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.Blobs/src/Sas/BlobSasBuilder.cs
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/specialized/BlobLeaseClientBuilder.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/specialized/BlobLeaseClientBuilder.java
index 4a2c112a543ff..6b24aac311bec 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/specialized/BlobLeaseClientBuilder.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/specialized/BlobLeaseClientBuilder.java
@@ -80,6 +80,12 @@ public final class BlobLeaseClientBuilder {
private String accountName;
private BlobServiceVersion serviceVersion;
+ /**
+ * Creates a {@link BlobLeaseClientBuilder}.
+ */
+ public BlobLeaseClientBuilder() {
+ }
+
/**
* Creates a {@link BlobLeaseClient} based on the configurations set in the builder.
*
diff --git a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/specialized/SpecializedBlobClientBuilder.java b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/specialized/SpecializedBlobClientBuilder.java
index e7ab2764b438f..50fea2ae1bd30 100644
--- a/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/specialized/SpecializedBlobClientBuilder.java
+++ b/sdk/storage/azure-storage-blob/src/main/java/com/azure/storage/blob/specialized/SpecializedBlobClientBuilder.java
@@ -104,6 +104,12 @@ public final class SpecializedBlobClientBuilder implements TokenCredentialTrait<
private BlobServiceVersion version;
private BlobAudience audience;
+ /**
+ * Creates a new instance of {@link SpecializedBlobClientBuilder}.
+ */
+ public SpecializedBlobClientBuilder() {
+ }
+
/**
* Creates a {@link AppendBlobClient} based on options set in the Builder. AppendBlobClients are used to perform
* append blob specific operations such as {@link AppendBlobClient#appendBlock(InputStream, long) append block},
diff --git a/sdk/storage/azure-storage-file-datalake/pom.xml b/sdk/storage/azure-storage-file-datalake/pom.xml
index 066bbdad07cb1..166f00678df04 100644
--- a/sdk/storage/azure-storage-file-datalake/pom.xml
+++ b/sdk/storage/azure-storage-file-datalake/pom.xml
@@ -60,7 +60,6 @@
false
spotbugs-exclude.xml
- -
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/DataLakeServiceClientBuilder.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/DataLakeServiceClientBuilder.java
index a5ee44ef10851..b4222426087fd 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/DataLakeServiceClientBuilder.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/DataLakeServiceClientBuilder.java
@@ -113,6 +113,9 @@ private HttpPipeline constructPipeline() {
}
/**
+ * Creates a {@link DataLakeServiceClient} based on options set in the builder. Every time {@code buildClient()} is
+ * called, a new instance of {@link DataLakeServiceClient} is created.
+ *
* @return a {@link DataLakeServiceClient} created from the configurations in this builder.
* @throws IllegalStateException If multiple credentials have been specified.
* @throws IllegalStateException If both {@link #retryOptions(RetryOptions)}
@@ -126,6 +129,9 @@ public DataLakeServiceClient buildClient() {
}
/**
+ * Creates a {@link DataLakeServiceAsyncClient} based on options set in the builder. Every time
+ * {@code buildAsyncClient()} is called, a new instance of {@link DataLakeServiceAsyncClient} is created.
+ *
* @return a {@link DataLakeServiceAsyncClient} created from the configurations in this builder.
* @throws IllegalStateException If multiple credentials have been specified.
* @throws IllegalStateException If both {@link #retryOptions(RetryOptions)}
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChangeCounters.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChangeCounters.java
index 939cce1babff9..402c700f669b9 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChangeCounters.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChangeCounters.java
@@ -11,6 +11,12 @@ public class AccessControlChangeCounters {
private long changedFilesCount;
private long failedChangesCount;
+ /**
+ * Creates a new instance of {@link AccessControlChangeCounters}.
+ */
+ public AccessControlChangeCounters() {
+ }
+
/**
* The number of directories where Access Control List has been updated successfully.
*
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChangeFailure.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChangeFailure.java
index e6f23cd7871d3..f1c3c06ea10ec 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChangeFailure.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChangeFailure.java
@@ -11,6 +11,12 @@ public class AccessControlChangeFailure {
private boolean isDirectory;
private String errorMessage;
+ /**
+ * Creates a new instance of {@link AccessControlChangeFailure}.
+ */
+ public AccessControlChangeFailure() {
+ }
+
/**
* Returns the name of an entry.
*
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChangeResult.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChangeResult.java
index 5247aa440162e..49ad74103f7c1 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChangeResult.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChangeResult.java
@@ -13,6 +13,12 @@ public class AccessControlChangeResult {
private String continuationToken;
private List batchFailures;
+ /**
+ * Creates a new instance of {@link AccessControlChangeResult}.
+ */
+ public AccessControlChangeResult() {
+ }
+
/**
* Returns the {@link AccessControlChangeCounters}.
*
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChanges.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChanges.java
index c6b33b092be0d..13118e0f603de 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChanges.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlChanges.java
@@ -7,7 +7,7 @@
/**
* AccessControlChanges contains batch and cumulative counts of operations that change Access Control Lists recursively.
- * Additionally it exposes path entries that failed to update while these operations progress.
+ * Additionally, it exposes path entries that failed to update while these operations progress.
*/
public class AccessControlChanges {
private List batchFailures;
@@ -15,6 +15,12 @@ public class AccessControlChanges {
private AccessControlChangeCounters aggregateCounters;
private String continuationToken;
+ /**
+ * Creates a new instance of {@link AccessControlChanges}.
+ */
+ public AccessControlChanges() {
+ }
+
/**
* Returns a list of path entries that failed to update Access Control List within a single batch.
*
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlType.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlType.java
index b2a337e49c0da..0c235035a0fb1 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlType.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessControlType.java
@@ -32,6 +32,15 @@ public class AccessControlType extends ExpandableStringEnum {
*/
public static final AccessControlType OTHER = fromString("other");
+ /**
+ * Creates a new instance of {@link AccessControlType} with no string value.
+ *
+ * @deprecated Please use {@link #fromString(String)} to create an instance of AccessControlType.
+ */
+ @Deprecated
+ public AccessControlType() {
+ }
+
/**
* Creates or finds a ArchiveStatus from its string representation.
*
@@ -43,6 +52,8 @@ public static AccessControlType fromString(String name) {
}
/**
+ * Gets known ArchiveStatus values.
+ *
* @return known ArchiveStatus values.
*/
public static Collection values() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessTier.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessTier.java
index b661b3e59e6b4..b3ab61632b226 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessTier.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/AccessTier.java
@@ -82,6 +82,15 @@ public final class AccessTier extends ExpandableStringEnum {
*/
public static final AccessTier ARCHIVE = fromString("Archive");
+ /**
+ * Creates a new instance of {@link AccessTier} with no string value.
+ *
+ * @deprecated Please use {@link #fromString(String)} to create an instance of AccessTier.
+ */
+ @Deprecated
+ public AccessTier() {
+ }
+
/**
* Creates or finds a AccessTier from its string representation.
*
@@ -93,6 +102,8 @@ public static AccessTier fromString(String name) {
}
/**
+ * Gets known AccessTier values.
+ *
* @return known AccessTier values.
*/
public static Collection values() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/ArchiveStatus.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/ArchiveStatus.java
index d25f4663588c7..969fdebb32545 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/ArchiveStatus.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/ArchiveStatus.java
@@ -22,6 +22,15 @@ public final class ArchiveStatus extends ExpandableStringEnum {
*/
public static final ArchiveStatus REHYDRATE_PENDING_TO_COOL = fromString("rehydrate-pending-to-cool");
+ /**
+ * Creates a new instance of {@link ArchiveStatus} with no string value.
+ *
+ * @deprecated Please use {@link #fromString(String)} to create an instance of ArchiveStatus.
+ */
+ @Deprecated
+ public ArchiveStatus() {
+ }
+
/**
* Creates or finds a ArchiveStatus from its string representation.
*
@@ -33,6 +42,8 @@ public static ArchiveStatus fromString(String name) {
}
/**
+ * Gets known ArchiveStatus values.
+ *
* @return known ArchiveStatus values.
*/
public static Collection values() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/CustomerProvidedKey.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/CustomerProvidedKey.java
index d75bbc4676317..12548ce269452 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/CustomerProvidedKey.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/CustomerProvidedKey.java
@@ -40,7 +40,6 @@ public class CustomerProvidedKey {
* @throws RuntimeException If "SHA-256" cannot be found.
*/
public CustomerProvidedKey(String key) {
-
this.key = key;
MessageDigest sha256;
@@ -57,7 +56,6 @@ public CustomerProvidedKey(String key) {
* Creates a new wrapper for a client provided key.
*
* @param key The encryption key bytes.
- *
* @throws RuntimeException If "SHA-256" cannot be found.
*/
public CustomerProvidedKey(byte[] key) {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAccessPolicy.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAccessPolicy.java
index de5f69c99d8e1..b798e28b4084b 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAccessPolicy.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAccessPolicy.java
@@ -24,6 +24,12 @@ public final class DataLakeAccessPolicy {
*/
private String permissions;
+ /**
+ * Creates a new instance of {@link DataLakeAccessPolicy}.
+ */
+ public DataLakeAccessPolicy() {
+ }
+
/**
* Get the startsOn property: the date-time the policy is active.
*
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAclChangeFailedException.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAclChangeFailedException.java
index a9ccc25ec25eb..9ccf4c281ede7 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAclChangeFailedException.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAclChangeFailedException.java
@@ -42,6 +42,8 @@ public DataLakeAclChangeFailedException(String message, DataLakeStorageException
}
/**
+ * Gets the continuation token to resume a datalake recursive acl function.
+ *
* @return the continuation token to resume a datalake recursive acl function.
*/
public String getContinuationToken() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAnalyticsLogging.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAnalyticsLogging.java
index 6f44397f2d014..ba8367a12291a 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAnalyticsLogging.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAnalyticsLogging.java
@@ -35,6 +35,12 @@ public final class DataLakeAnalyticsLogging {
*/
private DataLakeRetentionPolicy retentionPolicy;
+ /**
+ * Creates a new instance of {@link DataLakeAnalyticsLogging}.
+ */
+ public DataLakeAnalyticsLogging() {
+ }
+
/**
* Get the version property: The version of Storage Analytics to configure.
*
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAudience.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAudience.java
index b0884712e1eae..07c36aeeda676 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAudience.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeAudience.java
@@ -58,6 +58,8 @@ public static DataLakeAudience fromString(String audience) {
}
/**
+ * Gets known DataLakeAudience values.
+ *
* @return known DataLakeAudience values.
*/
public static Collection values() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeCorsRule.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeCorsRule.java
index 64241a54cbc58..1f22f1c2ecb1c 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeCorsRule.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeCorsRule.java
@@ -6,56 +6,53 @@
import com.azure.core.annotation.Fluent;
/**
- * 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.
+ * 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.
*/
@Fluent
public final class DataLakeCorsRule {
-
/*
- * 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.
+ * 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.
*/
private String allowedOrigins;
/*
- * The methods (HTTP request verbs) that the origin domain may use for a
- * CORS request. (comma separated)
+ * The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)
*/
private String allowedMethods;
/*
- * the request headers that the origin domain may specify on the CORS
- * request.
+ * the request headers that the origin domain may specify on the CORS request.
*/
private String allowedHeaders;
/*
- * The response headers that may be sent in the response to the CORS
- * request and exposed by the browser to the request issuer
+ * The response headers that may be sent in the response to the CORS request and exposed by the browser to the
+ * request issuer
*/
private String exposedHeaders;
/*
- * The maximum amount time that a browser should cache the preflight
- * OPTIONS request.
+ * The maximum amount time that a browser should cache the preflight OPTIONS request.
*/
private int maxAgeInSeconds;
/**
- * 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.
+ * Creates a new instance of {@link DataLakeCorsRule}.
+ */
+ public DataLakeCorsRule() {
+ }
+
+ /**
+ * 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.
*
* @return the allowedOrigins value.
*/
@@ -64,12 +61,10 @@ public String getAllowedOrigins() {
}
/**
- * 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.
+ * 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.
*
* @param allowedOrigins the allowedOrigins value to set.
* @return the DataLakeCorsRule object itself.
@@ -80,8 +75,8 @@ public DataLakeCorsRule setAllowedOrigins(String allowedOrigins) {
}
/**
- * Get the allowedMethods property: The methods (HTTP request verbs) that
- * the origin domain may use for a CORS request. (comma separated).
+ * Get the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS
+ * request. (comma separated).
*
* @return the allowedMethods value.
*/
@@ -90,8 +85,8 @@ public String getAllowedMethods() {
}
/**
- * Set the allowedMethods property: The methods (HTTP request verbs) that
- * the origin domain may use for a CORS request. (comma separated).
+ * Set the allowedMethods property: The methods (HTTP request verbs) that the origin domain may use for a CORS
+ * request. (comma separated).
*
* @param allowedMethods the allowedMethods value to set.
* @return the DataLakeCorsRule object itself.
@@ -102,8 +97,7 @@ public DataLakeCorsRule setAllowedMethods(String allowedMethods) {
}
/**
- * Get the allowedHeaders property: the request headers that the origin
- * domain may specify on the CORS request.
+ * Get the allowedHeaders property: the request headers that the origin domain may specify on the CORS request.
*
* @return the allowedHeaders value.
*/
@@ -112,8 +106,7 @@ public String getAllowedHeaders() {
}
/**
- * Set the allowedHeaders property: the request headers that the origin
- * domain may specify on the CORS request.
+ * Set the allowedHeaders property: the request headers that the origin domain may specify on the CORS request.
*
* @param allowedHeaders the allowedHeaders value to set.
* @return the DataLakeCorsRule object itself.
@@ -124,9 +117,8 @@ public DataLakeCorsRule setAllowedHeaders(String allowedHeaders) {
}
/**
- * 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.
+ * 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.
*
* @return the exposedHeaders value.
*/
@@ -135,9 +127,8 @@ public String getExposedHeaders() {
}
/**
- * 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.
+ * 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.
*
* @param exposedHeaders the exposedHeaders value to set.
* @return the DataLakeCorsRule object itself.
@@ -148,8 +139,8 @@ public DataLakeCorsRule setExposedHeaders(String exposedHeaders) {
}
/**
- * Get the maxAgeInSeconds property: The maximum amount time that a browser
- * should cache the preflight OPTIONS request.
+ * Get the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS
+ * request.
*
* @return the maxAgeInSeconds value.
*/
@@ -158,8 +149,8 @@ public int getMaxAgeInSeconds() {
}
/**
- * Set the maxAgeInSeconds property: The maximum amount time that a browser
- * should cache the preflight OPTIONS request.
+ * Set the maxAgeInSeconds property: The maximum amount time that a browser should cache the preflight OPTIONS
+ * request.
*
* @param maxAgeInSeconds the maxAgeInSeconds value to set.
* @return the DataLakeCorsRule object itself.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeFileOpenInputStreamResult.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeFileOpenInputStreamResult.java
index f76e1b133432f..75493618db614 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeFileOpenInputStreamResult.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeFileOpenInputStreamResult.java
@@ -10,11 +10,15 @@
*/
public interface DataLakeFileOpenInputStreamResult {
/**
+ * Gets the {@link InputStream} of the target file.
+ *
* @return the {@link InputStream} of the target file.
*/
InputStream getInputStream();
/**
+ * Gets the {@link PathProperties} of the target file.
+ *
* @return the {@link PathProperties} of the target file.
*/
PathProperties getProperties();
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeMetrics.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeMetrics.java
index f510eec53dbcb..7018f2da27863 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeMetrics.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeMetrics.java
@@ -26,11 +26,16 @@ public final class DataLakeMetrics {
private DataLakeRetentionPolicy retentionPolicy;
/*
- * Indicates whether metrics should generate summary statistics for called
- * API operations.
+ * Indicates whether metrics should generate summary statistics for called API operations.
*/
private Boolean includeApis;
+ /**
+ * Creates a new instance of {@link DataLakeMetrics}.
+ */
+ public DataLakeMetrics() {
+ }
+
/**
* Get the version property: The version of Storage Analytics to configure.
*
@@ -52,8 +57,7 @@ public DataLakeMetrics setVersion(String version) {
}
/**
- * Get the enabled property: Indicates whether metrics are enabled for the
- * DataLake service.
+ * Get the enabled property: Indicates whether metrics are enabled for the DataLake service.
*
* @return the enabled value.
*/
@@ -62,8 +66,7 @@ public boolean isEnabled() {
}
/**
- * Set the enabled property: Indicates whether metrics are enabled for the
- * DataLake service.
+ * Set the enabled property: Indicates whether metrics are enabled for the DataLake service.
*
* @param enabled the enabled value to set.
* @return the DataLakeMetrics object itself.
@@ -94,8 +97,8 @@ public DataLakeMetrics setRetentionPolicy(DataLakeRetentionPolicy retentionPolic
}
/**
- * Get the includeApis property: Indicates whether metrics should generate
- * summary statistics for called API operations.
+ * Get the includeApis property: Indicates whether metrics should generate summary statistics for called API
+ * operations.
*
* @return the includeApis value.
*/
@@ -104,8 +107,8 @@ public Boolean isIncludeApis() {
}
/**
- * Set the includeApis property: Indicates whether metrics should generate
- * summary statistics for called API operations.
+ * Set the includeApis property: Indicates whether metrics should generate summary statistics for called API
+ * operations.
*
* @param includeApis the includeApis value to set.
* @return the DataLakeMetrics object itself.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeRequestConditions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeRequestConditions.java
index 8ea7da5a43d4c..3475dead0bf0b 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeRequestConditions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeRequestConditions.java
@@ -18,6 +18,12 @@
public class DataLakeRequestConditions extends RequestConditions {
private String leaseId;
+ /**
+ * Creates a new instance of {@link DataLakeRequestConditions}.
+ */
+ public DataLakeRequestConditions() {
+ }
+
/**
* Optionally limit requests to resources that match the passed ETag.
*
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeRetentionPolicy.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeRetentionPolicy.java
index e275eeec3d3af..4f2c551775172 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeRetentionPolicy.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeRetentionPolicy.java
@@ -17,14 +17,19 @@ public final class DataLakeRetentionPolicy {
private boolean enabled;
/*
- * 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
+ * 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
*/
private Integer days;
/**
- * Get the enabled property: Indicates whether a retention policy is
- * enabled for the storage service.
+ * Creates a new instance of {@link DataLakeRetentionPolicy}.
+ */
+ public DataLakeRetentionPolicy() {
+ }
+
+ /**
+ * Get the enabled property: Indicates whether a retention policy is enabled for the storage service.
*
* @return the enabled value.
*/
@@ -33,8 +38,7 @@ public boolean isEnabled() {
}
/**
- * Set the enabled property: Indicates whether a retention policy is
- * enabled for the storage service.
+ * Set the enabled property: Indicates whether a retention policy is enabled for the storage service.
*
* @param enabled the enabled value to set.
* @return the DataLakeRetentionPolicy object itself.
@@ -45,9 +49,8 @@ public DataLakeRetentionPolicy setEnabled(boolean enabled) {
}
/**
- * 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.
+ * 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.
*
* @return the days value.
*/
@@ -56,9 +59,8 @@ public Integer getDays() {
}
/**
- * 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.
+ * 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.
*
* @param days the days value to set.
* @return the DataLakeRetentionPolicy object itself.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeServiceProperties.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeServiceProperties.java
index 72c28252df688..985adbc6177b5 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeServiceProperties.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeServiceProperties.java
@@ -34,9 +34,8 @@ public final class DataLakeServiceProperties {
private List cors;
/*
- * The default version to use for requests to the DataLake service if an
- * incoming request's version is not specified. Possible values include
- * version 2008-10-27 and all more recent versions
+ * The default version to use for requests to the DataLake service if an incoming request's version is not
+ * specified. Possible values include version 2008-10-27 and all more recent versions
*/
private String defaultServiceVersion;
@@ -50,6 +49,12 @@ public final class DataLakeServiceProperties {
*/
private DataLakeStaticWebsite staticWebsite;
+ /**
+ * Creates a new instance of {@link DataLakeServiceProperties}.
+ */
+ public DataLakeServiceProperties() {
+ }
+
/**
* Get the logging property: The logging property.
*
@@ -134,10 +139,9 @@ public DataLakeServiceProperties setCors(List cors) {
}
/**
- * Get the defaultServiceVersion property: The default version to use for
- * requests to the DataLake service if an incoming request's version is not
- * specified. Possible values include version 2008-10-27 and all more
- * recent versions.
+ * Get the defaultServiceVersion property: The default version to use for requests to the DataLake service if an
+ * incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent
+ * versions.
*
* @return the defaultServiceVersion value.
*/
@@ -146,10 +150,9 @@ public String getDefaultServiceVersion() {
}
/**
- * Set the defaultServiceVersion property: The default version to use for
- * requests to the DataLake service if an incoming request's version is not
- * specified. Possible values include version 2008-10-27 and all more
- * recent versions.
+ * Set the defaultServiceVersion property: The default version to use for requests to the DataLake service if an
+ * incoming request's version is not specified. Possible values include version 2008-10-27 and all more recent
+ * versions.
*
* @param defaultServiceVersion the defaultServiceVersion value to set.
* @return the DataLakeServiceProperties object itself.
@@ -160,8 +163,7 @@ public DataLakeServiceProperties setDefaultServiceVersion(String defaultServiceV
}
/**
- * Get the deleteRetentionPolicy property: The deleteRetentionPolicy
- * property.
+ * Get the deleteRetentionPolicy property: The deleteRetentionPolicy property.
*
* @return the deleteRetentionPolicy value.
*/
@@ -170,8 +172,7 @@ public DataLakeRetentionPolicy getDeleteRetentionPolicy() {
}
/**
- * Set the deleteRetentionPolicy property: The deleteRetentionPolicy
- * property.
+ * Set the deleteRetentionPolicy property: The deleteRetentionPolicy property.
*
* @param deleteRetentionPolicy the deleteRetentionPolicy value to set.
* @return the DataLakeServiceProperties object itself.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeSignedIdentifier.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeSignedIdentifier.java
index 098732f2de029..28e92a4437e34 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeSignedIdentifier.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeSignedIdentifier.java
@@ -20,6 +20,12 @@ public class DataLakeSignedIdentifier {
*/
private DataLakeAccessPolicy accessPolicy;
+ /**
+ * Creates a new instance of {@link DataLakeSignedIdentifier}.
+ */
+ public DataLakeSignedIdentifier() {
+ }
+
/**
* Get the id property: a unique id.
*
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeStaticWebsite.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeStaticWebsite.java
index c26a9a7059259..a13c84413ba23 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeStaticWebsite.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeStaticWebsite.java
@@ -25,6 +25,12 @@ public final class DataLakeStaticWebsite {
*/
private String defaultIndexDocumentPath;
+ /**
+ * Creates a new instance of {@link DataLakeStaticWebsite}.
+ */
+ public DataLakeStaticWebsite() {
+ }
+
/**
* Get the enabled property: Indicates whether this account is hosting a static website.
*
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeStorageException.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeStorageException.java
index dc15f6d0b4b41..3f28baff3834d 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeStorageException.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DataLakeStorageException.java
@@ -35,6 +35,8 @@ public DataLakeStorageException(String message, HttpResponse response, Object va
}
/**
+ * Gets the error code returned by the service.
+ *
* @return The error code returned by the service.
*/
public String getErrorCode() {
@@ -42,6 +44,8 @@ public String getErrorCode() {
}
/**
+ * Gets the message returned by the service.
+ *
* @return The message returned by the service.
*/
public String getServiceMessage() {
@@ -49,6 +53,8 @@ public String getServiceMessage() {
}
/**
+ * Gets the status code on the response.
+ *
* @return The status code on the response.
*/
public int getStatusCode() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DownloadRetryOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DownloadRetryOptions.java
index d475862da1c4c..978d87cb6ed43 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DownloadRetryOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/DownloadRetryOptions.java
@@ -17,12 +17,18 @@ public final class DownloadRetryOptions {
private static final ClientLogger LOGGER = new ClientLogger(DownloadRetryOptions.class);
/*
- We use "retry" here because by the time the user passes this type, the initial request, or try, has already been
- issued and returned. This is in contrast to the retry policy options, which includes the initial try in its count,
- thus the difference in verbiage.
+ * We use "retry" here because by the time the user passes this type, the initial request, or try, has already been
+ * issued and returned. This is in contrast to the retry policy options, which includes the initial try in its
+ * count, thus the difference in verbiage.
*/
private int maxRetryRequests = 5;
+ /**
+ * Creates a new instance of {@link DownloadRetryOptions}.
+ */
+ public DownloadRetryOptions() {
+ }
+
/**
* Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a
* response body.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryArrowField.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryArrowField.java
index 119c08a0184bf..215b3ca14afb1 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryArrowField.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryArrowField.java
@@ -11,13 +11,14 @@
*/
@Fluent
public class FileQueryArrowField {
-
private String name;
private Integer precision;
private Integer scale;
private final FileQueryArrowFieldType type;
/**
+ * Creates a new instance of {@link FileQueryArrowField}.
+ *
* @param type {@link FileQueryArrowFieldType}
*/
public FileQueryArrowField(FileQueryArrowFieldType type) {
@@ -26,6 +27,8 @@ public FileQueryArrowField(FileQueryArrowFieldType type) {
}
/**
+ * Sets the name of the field.
+ *
* @param name The name of the field.
* @return The updated options.
*/
@@ -35,6 +38,8 @@ public FileQueryArrowField setName(String name) {
}
/**
+ * Sets the precision of the field. Required if type is {@link FileQueryArrowFieldType#DECIMAL}.
+ *
* @param precision The precision of the field. Required if type is {@link FileQueryArrowFieldType#DECIMAL}
* @return The updated options.
*/
@@ -44,6 +49,8 @@ public FileQueryArrowField setPrecision(Integer precision) {
}
/**
+ * Sets the scale of the field. Required if type is {@link FileQueryArrowFieldType#DECIMAL}.
+ *
* @param scale The scale of the field. Required if type is {@link FileQueryArrowFieldType#DECIMAL}
* @return The updated options.
*/
@@ -53,6 +60,8 @@ public FileQueryArrowField setScale(Integer scale) {
}
/**
+ * Gets the name of the field.
+ *
* @return The name.
*/
public String getName() {
@@ -60,6 +69,8 @@ public String getName() {
}
/**
+ * Gets the precision of the field.
+ *
* @return The precision.
*/
public Integer getPrecision() {
@@ -67,6 +78,8 @@ public Integer getPrecision() {
}
/**
+ * Gets the scale of the field.
+ *
* @return The scale.
*/
public Integer getScale() {
@@ -74,6 +87,8 @@ public Integer getScale() {
}
/**
+ * Gets the {@link FileQueryArrowFieldType} of the field.
+ *
* @return {@link FileQueryArrowFieldType}
*/
public FileQueryArrowFieldType getType() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryArrowSerialization.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryArrowSerialization.java
index cc2c20c54749b..55caa2a815877 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryArrowSerialization.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryArrowSerialization.java
@@ -10,9 +10,14 @@
* Defines the output arrow serialization for a file quick query request.
*/
public class FileQueryArrowSerialization implements FileQuerySerialization {
-
private List schema;
+ /**
+ * Creates a new instance of {@link FileQueryArrowSerialization}.
+ */
+ public FileQueryArrowSerialization() {
+ }
+
/**
* Gets the arrow fields.
*
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryDelimitedSerialization.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryDelimitedSerialization.java
index 3dbf42b4a2827..fc90fdd479779 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryDelimitedSerialization.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryDelimitedSerialization.java
@@ -7,13 +7,18 @@
* Defines the input or output delimited (CSV) serialization for a blob quick query request.
*/
public class FileQueryDelimitedSerialization implements FileQuerySerialization {
-
private char columnSeparator;
private char fieldQuote;
private char escapeChar;
private boolean headersPresent;
private char recordSeparator;
+ /**
+ * Creates a new instance of {@link FileQueryDelimitedSerialization}.
+ */
+ public FileQueryDelimitedSerialization() {
+ }
+
/**
* Gets the column separator.
* @return the column separator.
@@ -69,16 +74,16 @@ public FileQueryDelimitedSerialization setEscapeChar(char escapeChar) {
}
/**
- * Gets whether or not headers are present.
- * @return Whether or not headers are present.
+ * Gets whether headers are present.
+ * @return Whether headers are present.
*/
public boolean isHeadersPresent() {
return headersPresent;
}
/**
- * Sets whether or not headers are present.
- * @param headersPresent Whether or not headers are present.
+ * Sets whether headers are present.
+ * @param headersPresent Whether headers are present.
* @return the updated FileQueryDelimitedSerialization object.
*/
public FileQueryDelimitedSerialization setHeadersPresent(boolean headersPresent) {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryError.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryError.java
index c9fac59159bd1..1338feafa9293 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryError.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryError.java
@@ -7,7 +7,6 @@
* Defines a file query error that can be returned on parsing a file query request.
*/
public class FileQueryError {
-
private final boolean fatal;
private final String name;
private final String description;
@@ -15,7 +14,7 @@ public class FileQueryError {
/**
* Creates a new FileQueryError object.
- * @param fatal Whether or not the error is fatal.
+ * @param fatal Whether the error is fatal.
* @param name The name of the error.
* @param description A description of the error.
* @param position The file offset at which the error occurred.
@@ -28,16 +27,19 @@ public FileQueryError(boolean fatal, String name, String description, long posit
}
/**
- * Whether or not the error is fatal. If true, this error prevents further query processing. More result data may
- * be returned, but there is no guarantee that all of the original data will be processed. If false, this error
- * does not prevent further query processing.
- * @return Whether or not the error is fatal.
+ * Whether the error is fatal. If true, this error prevents further query processing. More result data may be
+ * returned, but there is no guarantee that all the original data will be processed. If false, this error does not
+ * prevent further query processing.
+ *
+ * @return Whether the error is fatal.
*/
public boolean isFatal() {
return fatal;
}
/**
+ * Gets the name of the error.
+ *
* @return The name of the error.
*/
public String getName() {
@@ -45,6 +47,7 @@ public String getName() {
}
/**
+ * Gets a description of the error.
*
* @return A description of the error.
*/
@@ -53,6 +56,8 @@ public String getDescription() {
}
/**
+ * Gets the file offset at which the error occurred.
+ *
* @return The file offset at which the error occurred.
*/
public long getPosition() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryHeaders.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryHeaders.java
index 607923353bbe4..b88d8190f8902 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryHeaders.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryHeaders.java
@@ -13,7 +13,6 @@
* Defines headers for Read operation.
*/
public final class FileQueryHeaders {
-
private DateTimeRfc1123 lastModified;
private Map metadata;
private Long contentLength;
@@ -46,10 +45,15 @@ public final class FileQueryHeaders {
private String errorCode;
/**
- * Get the lastModified property: Returns the date and time the container
- * was last modified. Any operation that modifies the file, including an
- * update of the file's metadata or properties, changes the last-modified
- * time of the file.
+ * Creates a new instance of {@link FileQueryHeaders}.
+ */
+ public FileQueryHeaders() {
+ }
+
+ /**
+ * Get the lastModified property: Returns the date and time the container was last modified. Any operation that
+ * modifies the file, including an update of the file's metadata or properties, changes the last-modified time of
+ * the file.
*
* @return the lastModified value.
*/
@@ -61,10 +65,9 @@ public OffsetDateTime getLastModified() {
}
/**
- * Set the lastModified property: Returns the date and time the container
- * was last modified. Any operation that modifies the file, including an
- * update of the file's metadata or properties, changes the last-modified
- * time of the file.
+ * Set the lastModified property: Returns the date and time the container was last modified. Any operation that
+ * modifies the file, including an update of the file's metadata or properties, changes the last-modified time of
+ * the file.
*
* @param lastModified the lastModified value to set.
* @return the FileQueryHeaders object itself.
@@ -99,8 +102,7 @@ public FileQueryHeaders setMetadata(Map metadata) {
}
/**
- * Get the contentLength property: The number of bytes present in the
- * response body.
+ * Get the contentLength property: The number of bytes present in the response body.
*
* @return the contentLength value.
*/
@@ -109,8 +111,7 @@ public Long getContentLength() {
}
/**
- * Set the contentLength property: The number of bytes present in the
- * response body.
+ * Set the contentLength property: The number of bytes present in the response body.
*
* @param contentLength the contentLength value to set.
* @return the FileQueryHeaders object itself.
@@ -121,8 +122,8 @@ public FileQueryHeaders setContentLength(Long contentLength) {
}
/**
- * Get the contentType property: The media type of the body of the
- * response. For Download Blob this is 'application/octet-stream'.
+ * Get the contentType property: The media type of the body of the response. For Download Blob this is
+ * 'application/octet-stream'.
*
* @return the contentType value.
*/
@@ -131,8 +132,8 @@ public String getContentType() {
}
/**
- * Set the contentType property: The media type of the body of the
- * response. For Download Blob this is 'application/octet-stream'.
+ * Set the contentType property: The media type of the body of the response. For Download Blob this is
+ * 'application/octet-stream'.
*
* @param contentType the contentType value to set.
* @return the FileQueryHeaders object itself.
@@ -143,9 +144,8 @@ public FileQueryHeaders setContentType(String contentType) {
}
/**
- * Get the contentRange property: Indicates the range of bytes returned in
- * the event that the client requested a subset of the file by setting the
- * 'Range' request header.
+ * Get the contentRange property: Indicates the range of bytes returned in the event that the client requested a
+ * subset of the file by setting the 'Range' request header.
*
* @return the contentRange value.
*/
@@ -154,9 +154,8 @@ public String getContentRange() {
}
/**
- * Set the contentRange property: Indicates the range of bytes returned in
- * the event that the client requested a subset of the file by setting the
- * 'Range' request header.
+ * Set the contentRange property: Indicates the range of bytes returned in the event that the client requested a
+ * subset of the file by setting the 'Range' request header.
*
* @param contentRange the contentRange value to set.
* @return the FileQueryHeaders object itself.
@@ -167,9 +166,8 @@ public FileQueryHeaders setContentRange(String contentRange) {
}
/**
- * Get the eTag property: The ETag contains a value that you can use to
- * perform operations conditionally. If the request version is 2011-08-18
- * or newer, the ETag value will be in quotes.
+ * Get the eTag property: The ETag contains a value that you can use to perform operations conditionally. If the
+ * request version is 2011-08-18 or newer, the ETag value will be in quotes.
*
* @return the eTag value.
*/
@@ -178,9 +176,8 @@ public String getETag() {
}
/**
- * Set the eTag property: The ETag contains a value that you can use to
- * perform operations conditionally. If the request version is 2011-08-18
- * or newer, the ETag value will be in quotes.
+ * Set the eTag property: The ETag contains a value that you can use to perform operations conditionally. If the
+ * request version is 2011-08-18 or newer, the ETag value will be in quotes.
*
* @param eTag the eTag value to set.
* @return the FileQueryHeaders object itself.
@@ -191,9 +188,8 @@ public FileQueryHeaders setETag(String eTag) {
}
/**
- * Get the contentMd5 property: If the file has an MD5 hash and this
- * operation is to read the full file, this response header is returned so
- * that the client can check for message content integrity.
+ * Get the contentMd5 property: If the file has an MD5 hash and this operation is to read the full file, this
+ * response header is returned so that the client can check for message content integrity.
*
* @return the contentMd5 value.
*/
@@ -202,9 +198,8 @@ public byte[] getContentMd5() {
}
/**
- * Set the contentMd5 property: If the file has an MD5 hash and this
- * operation is to read the full file, this response header is returned so
- * that the client can check for message content integrity.
+ * Set the contentMd5 property: If the file has an MD5 hash and this operation is to read the full file, this
+ * response header is returned so that the client can check for message content integrity.
*
* @param contentMd5 the contentMd5 value to set.
* @return the FileQueryHeaders object itself.
@@ -215,8 +210,8 @@ public FileQueryHeaders setContentMd5(byte[] contentMd5) {
}
/**
- * Get the contentEncoding property: This header returns the value that was
- * specified for the Content-Encoding request header.
+ * Get the contentEncoding property: This header returns the value that was specified for the Content-Encoding
+ * request header.
*
* @return the contentEncoding value.
*/
@@ -225,8 +220,8 @@ public String getContentEncoding() {
}
/**
- * Set the contentEncoding property: This header returns the value that was
- * specified for the Content-Encoding request header.
+ * Set the contentEncoding property: This header returns the value that was specified for the Content-Encoding
+ * request header.
*
* @param contentEncoding the contentEncoding value to set.
* @return the FileQueryHeaders object itself.
@@ -237,8 +232,7 @@ public FileQueryHeaders setContentEncoding(String contentEncoding) {
}
/**
- * Get the cacheControl property: This header is returned if it was
- * previously specified for the file.
+ * Get the cacheControl property: This header is returned if it was previously specified for the file.
*
* @return the cacheControl value.
*/
@@ -247,8 +241,7 @@ public String getCacheControl() {
}
/**
- * Set the cacheControl property: This header is returned if it was
- * previously specified for the file.
+ * Set the cacheControl property: This header is returned if it was previously specified for the file.
*
* @param cacheControl the cacheControl value to set.
* @return the FileQueryHeaders object itself.
@@ -259,14 +252,11 @@ public FileQueryHeaders setCacheControl(String cacheControl) {
}
/**
- * Get the contentDisposition property: This header returns the value that
- * was specified for the 'x-ms-blob-content-disposition' header. The
- * Content-Disposition response header field conveys additional information
- * about how to process the response payload, and also can be used to
- * attach additional metadata. For example, if set to attachment, it
- * indicates that the user-agent should not display the response, but
- * instead show a Save As dialog with a filename other than the file name
- * specified.
+ * Get the contentDisposition property: This header returns the value that was specified for the
+ * 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional
+ * information about how to process the response payload, and also can be used to attach additional metadata. For
+ * example, if set to attachment, it indicates that the user-agent should not display the response, but instead show
+ * a Save As dialog with a filename other than the file name specified.
*
* @return the contentDisposition value.
*/
@@ -275,14 +265,11 @@ public String getContentDisposition() {
}
/**
- * Set the contentDisposition property: This header returns the value that
- * was specified for the 'x-ms-blob-content-disposition' header. The
- * Content-Disposition response header field conveys additional information
- * about how to process the response payload, and also can be used to
- * attach additional metadata. For example, if set to attachment, it
- * indicates that the user-agent should not display the response, but
- * instead show a Save As dialog with a filename other than the file name
- * specified.
+ * Set the contentDisposition property: This header returns the value that was specified for the
+ * 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional
+ * information about how to process the response payload, and also can be used to attach additional metadata. For
+ * example, if set to attachment, it indicates that the user-agent should not display the response, but instead show
+ * a Save As dialog with a filename other than the file name specified.
*
* @param contentDisposition the contentDisposition value to set.
* @return the FileQueryHeaders object itself.
@@ -293,8 +280,8 @@ public FileQueryHeaders setContentDisposition(String contentDisposition) {
}
/**
- * Get the contentLanguage property: This header returns the value that was
- * specified for the Content-Language request header.
+ * Get the contentLanguage property: This header returns the value that was specified for the Content-Language
+ * request header.
*
* @return the contentLanguage value.
*/
@@ -303,8 +290,8 @@ public String getContentLanguage() {
}
/**
- * Set the contentLanguage property: This header returns the value that was
- * specified for the Content-Language request header.
+ * Set the contentLanguage property: This header returns the value that was specified for the Content-Language
+ * request header.
*
* @param contentLanguage the contentLanguage value to set.
* @return the FileQueryHeaders object itself.
@@ -315,13 +302,11 @@ public FileQueryHeaders setContentLanguage(String contentLanguage) {
}
/**
- * Get the copyCompletionTime property: Conclusion time of the last
- * attempted Copy Blob operation where this file was the destination file.
- * This value can specify the time of a completed, aborted, or failed copy
- * attempt. This header does not appear if a copy is pending, if this file
- * has never been the destination in a Copy Blob operation, or if this file
- * has been modified after a concluded Copy Blob operation using Set Blob
- * Properties, Put Blob, or Put Block List.
+ * Get the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this file
+ * was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt. This
+ * header does not appear if a copy is pending, if this file has never been the destination in a Copy Blob
+ * operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put
+ * Blob, or Put Block List.
*
* @return the copyCompletionTime value.
*/
@@ -333,13 +318,11 @@ public OffsetDateTime getCopyCompletionTime() {
}
/**
- * Set the copyCompletionTime property: Conclusion time of the last
- * attempted Copy Blob operation where this file was the destination file.
- * This value can specify the time of a completed, aborted, or failed copy
- * attempt. This header does not appear if a copy is pending, if this file
- * has never been the destination in a Copy Blob operation, or if this file
- * has been modified after a concluded Copy Blob operation using Set Blob
- * Properties, Put Blob, or Put Block List.
+ * Set the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this file
+ * was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt. This
+ * header does not appear if a copy is pending, if this file has never been the destination in a Copy Blob
+ * operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put
+ * Blob, or Put Block List.
*
* @param copyCompletionTime the copyCompletionTime value to set.
* @return the FileQueryHeaders object itself.
@@ -354,12 +337,10 @@ public FileQueryHeaders setCopyCompletionTime(OffsetDateTime copyCompletionTime)
}
/**
- * Get the copyStatusDescription property: Only appears when
- * x-ms-copy-status is failed or pending. Describes the cause of the last
- * fatal or non-fatal copy operation failure. This header does not appear
- * if this file has never been the destination in a Copy Blob operation, or
- * if this file has been modified after a concluded Copy Blob operation
- * using Set Blob Properties, Put Blob, or Put Block List.
+ * Get the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending. Describes the
+ * cause of the last fatal or non-fatal copy operation failure. This header does not appear if this file has never
+ * been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob
+ * operation using Set Blob Properties, Put Blob, or Put Block List.
*
* @return the copyStatusDescription value.
*/
@@ -368,12 +349,10 @@ public String getCopyStatusDescription() {
}
/**
- * Set the copyStatusDescription property: Only appears when
- * x-ms-copy-status is failed or pending. Describes the cause of the last
- * fatal or non-fatal copy operation failure. This header does not appear
- * if this file has never been the destination in a Copy Blob operation, or
- * if this file has been modified after a concluded Copy Blob operation
- * using Set Blob Properties, Put Blob, or Put Block List.
+ * Set the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending. Describes the
+ * cause of the last fatal or non-fatal copy operation failure. This header does not appear if this file has never
+ * been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob
+ * operation using Set Blob Properties, Put Blob, or Put Block List.
*
* @param copyStatusDescription the copyStatusDescription value to set.
* @return the FileQueryHeaders object itself.
@@ -384,9 +363,8 @@ public FileQueryHeaders setCopyStatusDescription(String copyStatusDescription) {
}
/**
- * Get the copyId property: String identifier for this copy operation. Use
- * with Get Blob Properties to check the status of this copy operation, or
- * pass to Abort Copy Blob to abort a pending copy.
+ * Get the copyId property: String identifier for this copy operation. Use with Get Blob Properties to check the
+ * status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.
*
* @return the copyId value.
*/
@@ -395,9 +373,8 @@ public String getCopyId() {
}
/**
- * Set the copyId property: String identifier for this copy operation. Use
- * with Get Blob Properties to check the status of this copy operation, or
- * pass to Abort Copy Blob to abort a pending copy.
+ * Set the copyId property: String identifier for this copy operation. Use with Get Blob Properties to check the
+ * status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.
*
* @param copyId the copyId value to set.
* @return the FileQueryHeaders object itself.
@@ -408,13 +385,11 @@ public FileQueryHeaders setCopyId(String copyId) {
}
/**
- * Get the copyProgress property: Contains the number of bytes copied and
- * the total bytes in the source in the last attempted Copy Blob operation
- * where this file was the destination file. Can show between 0 and
- * Content-Length bytes copied. This header does not appear if this file
- * has never been the destination in a Copy Blob operation, or if this file
- * has been modified after a concluded Copy Blob operation using Set Blob
- * Properties, Put Blob, or Put Block List.
+ * Get the copyProgress property: Contains the number of bytes copied and the total bytes in the source in the last
+ * attempted Copy Blob operation where this file was the destination file. Can show between 0 and Content-Length
+ * bytes copied. This header does not appear if this file has never been the destination in a Copy Blob operation,
+ * or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or
+ * Put Block List.
*
* @return the copyProgress value.
*/
@@ -423,13 +398,11 @@ public String getCopyProgress() {
}
/**
- * Set the copyProgress property: Contains the number of bytes copied and
- * the total bytes in the source in the last attempted Copy Blob operation
- * where this file was the destination file. Can show between 0 and
- * Content-Length bytes copied. This header does not appear if this file
- * has never been the destination in a Copy Blob operation, or if this file
- * has been modified after a concluded Copy Blob operation using Set Blob
- * Properties, Put Blob, or Put Block List.
+ * Set the copyProgress property: Contains the number of bytes copied and the total bytes in the source in the last
+ * attempted Copy Blob operation where this file was the destination file. Can show between 0 and Content-Length
+ * bytes copied. This header does not appear if this file has never been the destination in a Copy Blob operation,
+ * or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or
+ * Put Block List.
*
* @param copyProgress the copyProgress value to set.
* @return the FileQueryHeaders object itself.
@@ -440,12 +413,10 @@ public FileQueryHeaders setCopyProgress(String copyProgress) {
}
/**
- * Get the copySource property: URL up to 2 KB in length that specifies the
- * source file or file used in the last attempted Copy Blob operation where
- * this file was the destination file. This header does not appear if this
- * file has never been the destination in a Copy Blob operation, or if this
- * file has been modified after a concluded Copy Blob operation using Set
- * Blob Properties, Put Blob, or Put Block List.
+ * Get the copySource property: URL up to 2 KB in length that specifies the source file or file used in the last
+ * attempted Copy Blob operation where this file was the destination file. This header does not appear if this file
+ * has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy
+ * Blob operation using Set Blob Properties, Put Blob, or Put Block List.
*
* @return the copySource value.
*/
@@ -454,12 +425,10 @@ public String getCopySource() {
}
/**
- * Set the copySource property: URL up to 2 KB in length that specifies the
- * source file or file used in the last attempted Copy Blob operation where
- * this file was the destination file. This header does not appear if this
- * file has never been the destination in a Copy Blob operation, or if this
- * file has been modified after a concluded Copy Blob operation using Set
- * Blob Properties, Put Blob, or Put Block List.
+ * Set the copySource property: URL up to 2 KB in length that specifies the source file or file used in the last
+ * attempted Copy Blob operation where this file was the destination file. This header does not appear if this file
+ * has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy
+ * Blob operation using Set Blob Properties, Put Blob, or Put Block List.
*
* @param copySource the copySource value to set.
* @return the FileQueryHeaders object itself.
@@ -470,9 +439,8 @@ public FileQueryHeaders setCopySource(String copySource) {
}
/**
- * Get the copyStatus property: State of the copy operation identified by
- * x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted',
- * 'failed'.
+ * Get the copyStatus property: State of the copy operation identified by x-ms-copy-id. Possible values include:
+ * 'pending', 'success', 'aborted', 'failed'.
*
* @return the copyStatus value.
*/
@@ -481,9 +449,8 @@ public CopyStatusType getCopyStatus() {
}
/**
- * Set the copyStatus property: State of the copy operation identified by
- * x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted',
- * 'failed'.
+ * Set the copyStatus property: State of the copy operation identified by x-ms-copy-id. Possible values include:
+ * 'pending', 'success', 'aborted', 'failed'.
*
* @param copyStatus the copyStatus value to set.
* @return the FileQueryHeaders object itself.
@@ -494,9 +461,8 @@ public FileQueryHeaders setCopyStatus(CopyStatusType copyStatus) {
}
/**
- * Get the leaseDuration property: When a file is leased, specifies whether
- * the lease is of infinite or fixed duration. Possible values include:
- * 'infinite', 'fixed'.
+ * Get the leaseDuration property: When a file is leased, specifies whether the lease is of infinite or fixed
+ * duration. Possible values include: 'infinite', 'fixed'.
*
* @return the leaseDuration value.
*/
@@ -505,9 +471,8 @@ public LeaseDurationType getLeaseDuration() {
}
/**
- * Set the leaseDuration property: When a file is leased, specifies whether
- * the lease is of infinite or fixed duration. Possible values include:
- * 'infinite', 'fixed'.
+ * Set the leaseDuration property: When a file is leased, specifies whether the lease is of infinite or fixed
+ * duration. Possible values include: 'infinite', 'fixed'.
*
* @param leaseDuration the leaseDuration value to set.
* @return the FileQueryHeaders object itself.
@@ -518,8 +483,8 @@ public FileQueryHeaders setLeaseDuration(LeaseDurationType leaseDuration) {
}
/**
- * Get the leaseState property: Lease state of the file. Possible values
- * include: 'available', 'leased', 'expired', 'breaking', 'broken'.
+ * Get the leaseState property: Lease state of the file. Possible values include: 'available', 'leased', 'expired',
+ * 'breaking', 'broken'.
*
* @return the leaseState value.
*/
@@ -528,8 +493,8 @@ public LeaseStateType getLeaseState() {
}
/**
- * Set the leaseState property: Lease state of the file. Possible values
- * include: 'available', 'leased', 'expired', 'breaking', 'broken'.
+ * Set the leaseState property: Lease state of the file. Possible values include: 'available', 'leased', 'expired',
+ * 'breaking', 'broken'.
*
* @param leaseState the leaseState value to set.
* @return the FileQueryHeaders object itself.
@@ -540,8 +505,8 @@ public FileQueryHeaders setLeaseState(LeaseStateType leaseState) {
}
/**
- * Get the leaseStatus property: The current lease status of the file.
- * Possible values include: 'locked', 'unlocked'.
+ * Get the leaseStatus property: The current lease status of the file. Possible values include: 'locked',
+ * 'unlocked'.
*
* @return the leaseStatus value.
*/
@@ -550,8 +515,8 @@ public LeaseStatusType getLeaseStatus() {
}
/**
- * Set the leaseStatus property: The current lease status of the file.
- * Possible values include: 'locked', 'unlocked'.
+ * Set the leaseStatus property: The current lease status of the file. Possible values include: 'locked',
+ * 'unlocked'.
*
* @param leaseStatus the leaseStatus value to set.
* @return the FileQueryHeaders object itself.
@@ -562,9 +527,8 @@ public FileQueryHeaders setLeaseStatus(LeaseStatusType leaseStatus) {
}
/**
- * Get the clientRequestId property: If a client request id header is sent
- * in the request, this header will be present in the response with the
- * same value.
+ * Get the clientRequestId property: If a client request id header is sent in the request, this header will be
+ * present in the response with the same value.
*
* @return the clientRequestId value.
*/
@@ -573,9 +537,8 @@ public String getClientRequestId() {
}
/**
- * Set the clientRequestId property: If a client request id header is sent
- * in the request, this header will be present in the response with the
- * same value.
+ * Set the clientRequestId property: If a client request id header is sent in the request, this header will be
+ * present in the response with the same value.
*
* @param clientRequestId the clientRequestId value to set.
* @return the FileQueryHeaders object itself.
@@ -586,8 +549,8 @@ public FileQueryHeaders setClientRequestId(String clientRequestId) {
}
/**
- * Get the requestId property: This header uniquely identifies the request
- * that was made and can be used for troubleshooting the request.
+ * Get the requestId property: This header uniquely identifies the request that was made and can be used for
+ * troubleshooting the request.
*
* @return the requestId value.
*/
@@ -596,8 +559,8 @@ public String getRequestId() {
}
/**
- * Set the requestId property: This header uniquely identifies the request
- * that was made and can be used for troubleshooting the request.
+ * Set the requestId property: This header uniquely identifies the request that was made and can be used for
+ * troubleshooting the request.
*
* @param requestId the requestId value to set.
* @return the FileQueryHeaders object itself.
@@ -608,9 +571,8 @@ public FileQueryHeaders setRequestId(String requestId) {
}
/**
- * Get the version property: Indicates the version of the Blob service used
- * to execute the request. This header is returned for requests made
- * against version 2009-09-19 and above.
+ * Get the version property: Indicates the version of the Blob service used to execute the request. This header is
+ * returned for requests made against version 2009-09-19 and above.
*
* @return the version value.
*/
@@ -619,9 +581,8 @@ public String getVersion() {
}
/**
- * Set the version property: Indicates the version of the Blob service used
- * to execute the request. This header is returned for requests made
- * against version 2009-09-19 and above.
+ * Set the version property: Indicates the version of the Blob service used to execute the request. This header is
+ * returned for requests made against version 2009-09-19 and above.
*
* @param version the version value to set.
* @return the FileQueryHeaders object itself.
@@ -632,8 +593,7 @@ public FileQueryHeaders setVersion(String version) {
}
/**
- * Get the acceptRanges property: Indicates that the service supports
- * requests for partial file content.
+ * Get the acceptRanges property: Indicates that the service supports requests for partial file content.
*
* @return the acceptRanges value.
*/
@@ -642,8 +602,7 @@ public String getAcceptRanges() {
}
/**
- * Set the acceptRanges property: Indicates that the service supports
- * requests for partial file content.
+ * Set the acceptRanges property: Indicates that the service supports requests for partial file content.
*
* @param acceptRanges the acceptRanges value to set.
* @return the FileQueryHeaders object itself.
@@ -654,8 +613,8 @@ public FileQueryHeaders setAcceptRanges(String acceptRanges) {
}
/**
- * Get the dateProperty property: UTC date/time value generated by the
- * service that indicates the time at which the response was initiated.
+ * Get the dateProperty property: UTC date/time value generated by the service that indicates the time at which the
+ * response was initiated.
*
* @return the dateProperty value.
*/
@@ -667,8 +626,8 @@ public OffsetDateTime getDateProperty() {
}
/**
- * Set the dateProperty property: UTC date/time value generated by the
- * service that indicates the time at which the response was initiated.
+ * Set the dateProperty property: UTC date/time value generated by the service that indicates the time at which the
+ * response was initiated.
*
* @param dateProperty the dateProperty value to set.
* @return the FileQueryHeaders object itself.
@@ -683,11 +642,9 @@ public FileQueryHeaders setDateProperty(OffsetDateTime dateProperty) {
}
/**
- * Get the isServerEncrypted property: The value of this header is set to
- * true if the file data and application metadata are completely encrypted
- * using the specified algorithm. Otherwise, the value is set to false
- * (when the file is unencrypted, or if only parts of the file/application
- * metadata are encrypted).
+ * Get the isServerEncrypted property: The value of this header is set to true if the file data and application
+ * metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the
+ * file is unencrypted, or if only parts of the file/application metadata are encrypted).
*
* @return the isServerEncrypted value.
*/
@@ -696,11 +653,9 @@ public Boolean isServerEncrypted() {
}
/**
- * Set the isServerEncrypted property: The value of this header is set to
- * true if the file data and application metadata are completely encrypted
- * using the specified algorithm. Otherwise, the value is set to false
- * (when the file is unencrypted, or if only parts of the file/application
- * metadata are encrypted).
+ * Set the isServerEncrypted property: The value of this header is set to true if the file data and application
+ * metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the
+ * file is unencrypted, or if only parts of the file/application metadata are encrypted).
*
* @param serverEncrypted the isServerEncrypted value to set.
* @return the FileQueryHeaders object itself.
@@ -711,9 +666,8 @@ public FileQueryHeaders setServerEncrypted(Boolean serverEncrypted) {
}
/**
- * Get the encryptionKeySha256 property: The SHA-256 hash of the encryption
- * key used to encrypt the file. This header is only returned when the file
- * was encrypted with a customer-provided key.
+ * Get the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the file. This
+ * header is only returned when the file was encrypted with a customer-provided key.
*
* @return the encryptionKeySha256 value.
*/
@@ -722,9 +676,8 @@ public String getEncryptionKeySha256() {
}
/**
- * Set the encryptionKeySha256 property: The SHA-256 hash of the encryption
- * key used to encrypt the file. This header is only returned when the file
- * was encrypted with a customer-provided key.
+ * Set the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the file. This
+ * header is only returned when the file was encrypted with a customer-provided key.
*
* @param encryptionKeySha256 the encryptionKeySha256 value to set.
* @return the FileQueryHeaders object itself.
@@ -735,11 +688,10 @@ public FileQueryHeaders setEncryptionKeySha256(String encryptionKeySha256) {
}
/**
- * Get the fileContentMD5 property: If the file has a MD5 hash, and if
- * request contains range header (Range or x-ms-range), this response
- * header is returned with the value of the whole file's MD5 value. This
- * value may or may not be equal to the value returned in Content-MD5
- * header, with the latter calculated from the requested range.
+ * Get the fileContentMD5 property: If the file has a MD5 hash, and if request contains range header
+ * (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value
+ * may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the
+ * requested range.
*
* @return the fileContentMD5 value.
*/
@@ -748,11 +700,10 @@ public byte[] getFileContentMd5() {
}
/**
- * Set the fileContentMD5 property: If the file has a MD5 hash, and if
- * request contains range header (Range or x-ms-range), this response
- * header is returned with the value of the whole file's MD5 value. This
- * value may or may not be equal to the value returned in Content-MD5
- * header, with the latter calculated from the requested range.
+ * Set the fileContentMD5 property: If the file has a MD5 hash, and if request contains range header
+ * (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value
+ * may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the
+ * requested range.
*
* @param fileContentMd5 the fileContentMD5 value to set.
* @return the FileQueryHeaders object itself.
@@ -763,12 +714,10 @@ public FileQueryHeaders setFileContentMd5(byte[] fileContentMd5) {
}
/**
- * Get the contentCrc64 property: If the request is to read a specified
- * range and the x-ms-range-get-content-crc64 is set to true, then the
- * request returns a crc64 for the range, as long as the range size is less
- * than or equal to 4 MB. If both x-ms-range-get-content-crc64 &
- * x-ms-range-get-content-md5 is specified in the same request, it will
- * fail with 400(Bad Request).
+ * Get the contentCrc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64
+ * is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal
+ * to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request,
+ * it will fail with 400(Bad Request).
*
* @return the contentCrc64 value.
*/
@@ -777,12 +726,10 @@ public byte[] getContentCrc64() {
}
/**
- * Set the contentCrc64 property: If the request is to read a specified
- * range and the x-ms-range-get-content-crc64 is set to true, then the
- * request returns a crc64 for the range, as long as the range size is less
- * than or equal to 4 MB. If both x-ms-range-get-content-crc64 &
- * x-ms-range-get-content-md5 is specified in the same request, it will
- * fail with 400(Bad Request).
+ * Set the contentCrc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64
+ * is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal
+ * to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request,
+ * it will fail with 400(Bad Request).
*
* @param contentCrc64 the contentCrc64 value to set.
* @return the FileQueryHeaders object itself.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryJsonSerialization.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryJsonSerialization.java
index a1f4370207afc..d06de1de1885a 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryJsonSerialization.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryJsonSerialization.java
@@ -7,9 +7,14 @@
* Defines the input or output JSON serialization for a file query request.
*/
public class FileQueryJsonSerialization implements FileQuerySerialization {
-
private char recordSeparator;
+ /**
+ * Creates a new instance of {@link FileQueryJsonSerialization}.
+ */
+ public FileQueryJsonSerialization() {
+ }
+
/**
* Gets the record separator.
*
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryParquetSerialization.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryParquetSerialization.java
index 67759e53063d7..a6f2225dd7a0d 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryParquetSerialization.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryParquetSerialization.java
@@ -7,4 +7,9 @@
* Defines the input parquet serialization for a file quick query request.
*/
public final class FileQueryParquetSerialization implements FileQuerySerialization {
+ /**
+ * Creates a new instance of {@link FileQueryParquetSerialization}.
+ */
+ public FileQueryParquetSerialization() {
+ }
}
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryProgress.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryProgress.java
index 291c60965046b..abb29f4da5204 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryProgress.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileQueryProgress.java
@@ -7,7 +7,6 @@
* Defines a file query error that can be returned on parsing a file query request.
*/
public class FileQueryProgress {
-
private final long bytesScanned;
private final long totalBytes;
@@ -22,6 +21,8 @@ public FileQueryProgress(long bytesScanned, long totalBytes) {
}
/**
+ * Gets the number of bytes scanned so far.
+ *
* @return The number of bytes scanned so far.
*/
public long getBytesScanned() {
@@ -29,6 +30,8 @@ public long getBytesScanned() {
}
/**
+ * Gets the total number of bytes in the file.
+ *
* @return The total number of bytes in the file.
*/
public long getTotalBytes() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileRange.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileRange.java
index 5b9fd23ba60cb..f49844be88c49 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileRange.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileRange.java
@@ -67,7 +67,8 @@ public Long getCount() {
}
/**
- * @return A {@code String} compliant with the format of the Azure Storage x-ms-range and Range headers.
+ * Gets the string representation of the FileRange.
+ * @return A string compliant with the format of the Azure Storage x-ms-range and Range headers.
*/
@Override
public String toString() {
@@ -80,6 +81,8 @@ public String toString() {
}
/**
+ * Gets the string representation of the FileRange for use in a header value.
+ *
* @return {@link FileRange#toString()} if {@code count} isn't {@code null} or {@code offset} isn't 0, otherwise
* null.
*/
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileReadHeaders.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileReadHeaders.java
index 7bd77ff3f959a..84ffabfb0485c 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileReadHeaders.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileReadHeaders.java
@@ -14,7 +14,6 @@
* Defines headers for Read operation.
*/
public final class FileReadHeaders {
-
private DateTimeRfc1123 lastModified;
private Map metadata;
private Long contentLength;
@@ -50,10 +49,15 @@ public final class FileReadHeaders {
private List accessControlList;
/**
- * Get the lastModified property: Returns the date and time the container
- * was last modified. Any operation that modifies the file, including an
- * update of the file's metadata or properties, changes the last-modified
- * time of the file.
+ * Creates a new instance of {@link FileReadHeaders}.
+ */
+ public FileReadHeaders() {
+ }
+
+ /**
+ * Get the lastModified property: Returns the date and time the container was last modified. Any operation that
+ * modifies the file, including an update of the file's metadata or properties, changes the last-modified time of
+ * the file.
*
* @return the lastModified value.
*/
@@ -65,10 +69,9 @@ public OffsetDateTime getLastModified() {
}
/**
- * Set the lastModified property: Returns the date and time the container
- * was last modified. Any operation that modifies the file, including an
- * update of the file's metadata or properties, changes the last-modified
- * time of the file.
+ * Set the lastModified property: Returns the date and time the container was last modified. Any operation that
+ * modifies the file, including an update of the file's metadata or properties, changes the last-modified time of
+ * the file.
*
* @param lastModified the lastModified value to set.
* @return the FileReadHeaders object itself.
@@ -103,8 +106,7 @@ public FileReadHeaders setMetadata(Map metadata) {
}
/**
- * Get the contentLength property: The number of bytes present in the
- * response body.
+ * Get the contentLength property: The number of bytes present in the response body.
*
* @return the contentLength value.
*/
@@ -113,8 +115,7 @@ public Long getContentLength() {
}
/**
- * Set the contentLength property: The number of bytes present in the
- * response body.
+ * Set the contentLength property: The number of bytes present in the response body.
*
* @param contentLength the contentLength value to set.
* @return the FileReadHeaders object itself.
@@ -125,8 +126,8 @@ public FileReadHeaders setContentLength(Long contentLength) {
}
/**
- * Get the contentType property: The media type of the body of the
- * response. For Download Blob this is 'application/octet-stream'.
+ * Get the contentType property: The media type of the body of the response. For Download Blob this is
+ * 'application/octet-stream'.
*
* @return the contentType value.
*/
@@ -135,8 +136,8 @@ public String getContentType() {
}
/**
- * Set the contentType property: The media type of the body of the
- * response. For Download Blob this is 'application/octet-stream'.
+ * Set the contentType property: The media type of the body of the response. For Download Blob this is
+ * 'application/octet-stream'.
*
* @param contentType the contentType value to set.
* @return the FileReadHeaders object itself.
@@ -147,9 +148,8 @@ public FileReadHeaders setContentType(String contentType) {
}
/**
- * Get the contentRange property: Indicates the range of bytes returned in
- * the event that the client requested a subset of the file by setting the
- * 'Range' request header.
+ * Get the contentRange property: Indicates the range of bytes returned in the event that the client requested a
+ * subset of the file by setting the 'Range' request header.
*
* @return the contentRange value.
*/
@@ -158,9 +158,8 @@ public String getContentRange() {
}
/**
- * Set the contentRange property: Indicates the range of bytes returned in
- * the event that the client requested a subset of the file by setting the
- * 'Range' request header.
+ * Set the contentRange property: Indicates the range of bytes returned in the event that the client requested a
+ * subset of the file by setting the 'Range' request header.
*
* @param contentRange the contentRange value to set.
* @return the FileReadHeaders object itself.
@@ -171,9 +170,8 @@ public FileReadHeaders setContentRange(String contentRange) {
}
/**
- * Get the eTag property: The ETag contains a value that you can use to
- * perform operations conditionally. If the request version is 2011-08-18
- * or newer, the ETag value will be in quotes.
+ * Get the eTag property: The ETag contains a value that you can use to perform operations conditionally. If the
+ * request version is 2011-08-18 or newer, the ETag value will be in quotes.
*
* @return the eTag value.
*/
@@ -182,9 +180,8 @@ public String getETag() {
}
/**
- * Set the eTag property: The ETag contains a value that you can use to
- * perform operations conditionally. If the request version is 2011-08-18
- * or newer, the ETag value will be in quotes.
+ * Set the eTag property: The ETag contains a value that you can use to perform operations conditionally. If the
+ * request version is 2011-08-18 or newer, the ETag value will be in quotes.
*
* @param eTag the eTag value to set.
* @return the FileReadHeaders object itself.
@@ -195,9 +192,8 @@ public FileReadHeaders setETag(String eTag) {
}
/**
- * Get the contentMd5 property: If the file has an MD5 hash and this
- * operation is to read the full file, this response header is returned so
- * that the client can check for message content integrity.
+ * Get the contentMd5 property: If the file has an MD5 hash and this operation is to read the full file, this
+ * response header is returned so that the client can check for message content integrity.
*
* @return the contentMd5 value.
*/
@@ -206,9 +202,8 @@ public byte[] getContentMd5() {
}
/**
- * Set the contentMd5 property: If the file has an MD5 hash and this
- * operation is to read the full file, this response header is returned so
- * that the client can check for message content integrity.
+ * Set the contentMd5 property: If the file has an MD5 hash and this operation is to read the full file, this
+ * response header is returned so that the client can check for message content integrity.
*
* @param contentMd5 the contentMd5 value to set.
* @return the FileReadHeaders object itself.
@@ -219,8 +214,8 @@ public FileReadHeaders setContentMd5(byte[] contentMd5) {
}
/**
- * Get the contentEncoding property: This header returns the value that was
- * specified for the Content-Encoding request header.
+ * Get the contentEncoding property: This header returns the value that was specified for the Content-Encoding
+ * request header.
*
* @return the contentEncoding value.
*/
@@ -229,8 +224,8 @@ public String getContentEncoding() {
}
/**
- * Set the contentEncoding property: This header returns the value that was
- * specified for the Content-Encoding request header.
+ * Set the contentEncoding property: This header returns the value that was specified for the Content-Encoding
+ * request header.
*
* @param contentEncoding the contentEncoding value to set.
* @return the FileReadHeaders object itself.
@@ -241,8 +236,7 @@ public FileReadHeaders setContentEncoding(String contentEncoding) {
}
/**
- * Get the cacheControl property: This header is returned if it was
- * previously specified for the file.
+ * Get the cacheControl property: This header is returned if it was previously specified for the file.
*
* @return the cacheControl value.
*/
@@ -251,8 +245,7 @@ public String getCacheControl() {
}
/**
- * Set the cacheControl property: This header is returned if it was
- * previously specified for the file.
+ * Set the cacheControl property: This header is returned if it was previously specified for the file.
*
* @param cacheControl the cacheControl value to set.
* @return the FileReadHeaders object itself.
@@ -263,14 +256,11 @@ public FileReadHeaders setCacheControl(String cacheControl) {
}
/**
- * Get the contentDisposition property: This header returns the value that
- * was specified for the 'x-ms-blob-content-disposition' header. The
- * Content-Disposition response header field conveys additional information
- * about how to process the response payload, and also can be used to
- * attach additional metadata. For example, if set to attachment, it
- * indicates that the user-agent should not display the response, but
- * instead show a Save As dialog with a filename other than the file name
- * specified.
+ * Get the contentDisposition property: This header returns the value that was specified for the
+ * 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional
+ * information about how to process the response payload, and also can be used to attach additional metadata. For
+ * example, if set to attachment, it indicates that the user-agent should not display the response, but instead show
+ * a Save As dialog with a filename other than the file name specified.
*
* @return the contentDisposition value.
*/
@@ -279,14 +269,11 @@ public String getContentDisposition() {
}
/**
- * Set the contentDisposition property: This header returns the value that
- * was specified for the 'x-ms-blob-content-disposition' header. The
- * Content-Disposition response header field conveys additional information
- * about how to process the response payload, and also can be used to
- * attach additional metadata. For example, if set to attachment, it
- * indicates that the user-agent should not display the response, but
- * instead show a Save As dialog with a filename other than the file name
- * specified.
+ * Set the contentDisposition property: This header returns the value that was specified for the
+ * 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional
+ * information about how to process the response payload, and also can be used to attach additional metadata. For
+ * example, if set to attachment, it indicates that the user-agent should not display the response, but instead show
+ * a Save As dialog with a filename other than the file name specified.
*
* @param contentDisposition the contentDisposition value to set.
* @return the FileReadHeaders object itself.
@@ -297,8 +284,8 @@ public FileReadHeaders setContentDisposition(String contentDisposition) {
}
/**
- * Get the contentLanguage property: This header returns the value that was
- * specified for the Content-Language request header.
+ * Get the contentLanguage property: This header returns the value that was specified for the Content-Language
+ * request header.
*
* @return the contentLanguage value.
*/
@@ -307,8 +294,8 @@ public String getContentLanguage() {
}
/**
- * Set the contentLanguage property: This header returns the value that was
- * specified for the Content-Language request header.
+ * Set the contentLanguage property: This header returns the value that was specified for the Content-Language
+ * request header.
*
* @param contentLanguage the contentLanguage value to set.
* @return the FileReadHeaders object itself.
@@ -319,13 +306,11 @@ public FileReadHeaders setContentLanguage(String contentLanguage) {
}
/**
- * Get the copyCompletionTime property: Conclusion time of the last
- * attempted Copy Blob operation where this file was the destination file.
- * This value can specify the time of a completed, aborted, or failed copy
- * attempt. This header does not appear if a copy is pending, if this file
- * has never been the destination in a Copy Blob operation, or if this file
- * has been modified after a concluded Copy Blob operation using Set Blob
- * Properties, Put Blob, or Put Block List.
+ * Get the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this file
+ * was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt. This
+ * header does not appear if a copy is pending, if this file has never been the destination in a Copy Blob
+ * operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put
+ * Blob, or Put Block List.
*
* @return the copyCompletionTime value.
*/
@@ -337,13 +322,11 @@ public OffsetDateTime getCopyCompletionTime() {
}
/**
- * Set the copyCompletionTime property: Conclusion time of the last
- * attempted Copy Blob operation where this file was the destination file.
- * This value can specify the time of a completed, aborted, or failed copy
- * attempt. This header does not appear if a copy is pending, if this file
- * has never been the destination in a Copy Blob operation, or if this file
- * has been modified after a concluded Copy Blob operation using Set Blob
- * Properties, Put Blob, or Put Block List.
+ * Set the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this file
+ * was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt. This
+ * header does not appear if a copy is pending, if this file has never been the destination in a Copy Blob
+ * operation, or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put
+ * Blob, or Put Block List.
*
* @param copyCompletionTime the copyCompletionTime value to set.
* @return the FileReadHeaders object itself.
@@ -358,12 +341,10 @@ public FileReadHeaders setCopyCompletionTime(OffsetDateTime copyCompletionTime)
}
/**
- * Get the copyStatusDescription property: Only appears when
- * x-ms-copy-status is failed or pending. Describes the cause of the last
- * fatal or non-fatal copy operation failure. This header does not appear
- * if this file has never been the destination in a Copy Blob operation, or
- * if this file has been modified after a concluded Copy Blob operation
- * using Set Blob Properties, Put Blob, or Put Block List.
+ * Get the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending. Describes the
+ * cause of the last fatal or non-fatal copy operation failure. This header does not appear if this file has never
+ * been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob
+ * operation using Set Blob Properties, Put Blob, or Put Block List.
*
* @return the copyStatusDescription value.
*/
@@ -372,12 +353,10 @@ public String getCopyStatusDescription() {
}
/**
- * Set the copyStatusDescription property: Only appears when
- * x-ms-copy-status is failed or pending. Describes the cause of the last
- * fatal or non-fatal copy operation failure. This header does not appear
- * if this file has never been the destination in a Copy Blob operation, or
- * if this file has been modified after a concluded Copy Blob operation
- * using Set Blob Properties, Put Blob, or Put Block List.
+ * Set the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending. Describes the
+ * cause of the last fatal or non-fatal copy operation failure. This header does not appear if this file has never
+ * been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy Blob
+ * operation using Set Blob Properties, Put Blob, or Put Block List.
*
* @param copyStatusDescription the copyStatusDescription value to set.
* @return the FileReadHeaders object itself.
@@ -388,9 +367,8 @@ public FileReadHeaders setCopyStatusDescription(String copyStatusDescription) {
}
/**
- * Get the copyId property: String identifier for this copy operation. Use
- * with Get Blob Properties to check the status of this copy operation, or
- * pass to Abort Copy Blob to abort a pending copy.
+ * Get the copyId property: String identifier for this copy operation. Use with Get Blob Properties to check the
+ * status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.
*
* @return the copyId value.
*/
@@ -399,9 +377,8 @@ public String getCopyId() {
}
/**
- * Set the copyId property: String identifier for this copy operation. Use
- * with Get Blob Properties to check the status of this copy operation, or
- * pass to Abort Copy Blob to abort a pending copy.
+ * Set the copyId property: String identifier for this copy operation. Use with Get Blob Properties to check the
+ * status of this copy operation, or pass to Abort Copy Blob to abort a pending copy.
*
* @param copyId the copyId value to set.
* @return the FileReadHeaders object itself.
@@ -412,13 +389,11 @@ public FileReadHeaders setCopyId(String copyId) {
}
/**
- * Get the copyProgress property: Contains the number of bytes copied and
- * the total bytes in the source in the last attempted Copy Blob operation
- * where this file was the destination file. Can show between 0 and
- * Content-Length bytes copied. This header does not appear if this file
- * has never been the destination in a Copy Blob operation, or if this file
- * has been modified after a concluded Copy Blob operation using Set Blob
- * Properties, Put Blob, or Put Block List.
+ * Get the copyProgress property: Contains the number of bytes copied and the total bytes in the source in the last
+ * attempted Copy Blob operation where this file was the destination file. Can show between 0 and Content-Length
+ * bytes copied. This header does not appear if this file has never been the destination in a Copy Blob operation,
+ * or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or
+ * Put Block List.
*
* @return the copyProgress value.
*/
@@ -427,13 +402,11 @@ public String getCopyProgress() {
}
/**
- * Set the copyProgress property: Contains the number of bytes copied and
- * the total bytes in the source in the last attempted Copy Blob operation
- * where this file was the destination file. Can show between 0 and
- * Content-Length bytes copied. This header does not appear if this file
- * has never been the destination in a Copy Blob operation, or if this file
- * has been modified after a concluded Copy Blob operation using Set Blob
- * Properties, Put Blob, or Put Block List.
+ * Set the copyProgress property: Contains the number of bytes copied and the total bytes in the source in the last
+ * attempted Copy Blob operation where this file was the destination file. Can show between 0 and Content-Length
+ * bytes copied. This header does not appear if this file has never been the destination in a Copy Blob operation,
+ * or if this file has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or
+ * Put Block List.
*
* @param copyProgress the copyProgress value to set.
* @return the FileReadHeaders object itself.
@@ -444,12 +417,10 @@ public FileReadHeaders setCopyProgress(String copyProgress) {
}
/**
- * Get the copySource property: URL up to 2 KB in length that specifies the
- * source file or file used in the last attempted Copy Blob operation where
- * this file was the destination file. This header does not appear if this
- * file has never been the destination in a Copy Blob operation, or if this
- * file has been modified after a concluded Copy Blob operation using Set
- * Blob Properties, Put Blob, or Put Block List.
+ * Get the copySource property: URL up to 2 KB in length that specifies the source file or file used in the last
+ * attempted Copy Blob operation where this file was the destination file. This header does not appear if this file
+ * has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy
+ * Blob operation using Set Blob Properties, Put Blob, or Put Block List.
*
* @return the copySource value.
*/
@@ -458,12 +429,10 @@ public String getCopySource() {
}
/**
- * Set the copySource property: URL up to 2 KB in length that specifies the
- * source file or file used in the last attempted Copy Blob operation where
- * this file was the destination file. This header does not appear if this
- * file has never been the destination in a Copy Blob operation, or if this
- * file has been modified after a concluded Copy Blob operation using Set
- * Blob Properties, Put Blob, or Put Block List.
+ * Set the copySource property: URL up to 2 KB in length that specifies the source file or file used in the last
+ * attempted Copy Blob operation where this file was the destination file. This header does not appear if this file
+ * has never been the destination in a Copy Blob operation, or if this file has been modified after a concluded Copy
+ * Blob operation using Set Blob Properties, Put Blob, or Put Block List.
*
* @param copySource the copySource value to set.
* @return the FileReadHeaders object itself.
@@ -474,9 +443,8 @@ public FileReadHeaders setCopySource(String copySource) {
}
/**
- * Get the copyStatus property: State of the copy operation identified by
- * x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted',
- * 'failed'.
+ * Get the copyStatus property: State of the copy operation identified by x-ms-copy-id. Possible values include:
+ * 'pending', 'success', 'aborted', 'failed'.
*
* @return the copyStatus value.
*/
@@ -485,9 +453,8 @@ public CopyStatusType getCopyStatus() {
}
/**
- * Set the copyStatus property: State of the copy operation identified by
- * x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted',
- * 'failed'.
+ * Set the copyStatus property: State of the copy operation identified by x-ms-copy-id. Possible values include:
+ * 'pending', 'success', 'aborted', 'failed'.
*
* @param copyStatus the copyStatus value to set.
* @return the FileReadHeaders object itself.
@@ -498,9 +465,8 @@ public FileReadHeaders setCopyStatus(CopyStatusType copyStatus) {
}
/**
- * Get the leaseDuration property: When a file is leased, specifies whether
- * the lease is of infinite or fixed duration. Possible values include:
- * 'infinite', 'fixed'.
+ * Get the leaseDuration property: When a file is leased, specifies whether the lease is of infinite or fixed
+ * duration. Possible values include: 'infinite', 'fixed'.
*
* @return the leaseDuration value.
*/
@@ -509,9 +475,8 @@ public LeaseDurationType getLeaseDuration() {
}
/**
- * Set the leaseDuration property: When a file is leased, specifies whether
- * the lease is of infinite or fixed duration. Possible values include:
- * 'infinite', 'fixed'.
+ * Set the leaseDuration property: When a file is leased, specifies whether the lease is of infinite or fixed
+ * duration. Possible values include: 'infinite', 'fixed'.
*
* @param leaseDuration the leaseDuration value to set.
* @return the FileReadHeaders object itself.
@@ -522,8 +487,8 @@ public FileReadHeaders setLeaseDuration(LeaseDurationType leaseDuration) {
}
/**
- * Get the leaseState property: Lease state of the file. Possible values
- * include: 'available', 'leased', 'expired', 'breaking', 'broken'.
+ * Get the leaseState property: Lease state of the file. Possible values include: 'available', 'leased', 'expired',
+ * 'breaking', 'broken'.
*
* @return the leaseState value.
*/
@@ -532,8 +497,8 @@ public LeaseStateType getLeaseState() {
}
/**
- * Set the leaseState property: Lease state of the file. Possible values
- * include: 'available', 'leased', 'expired', 'breaking', 'broken'.
+ * Set the leaseState property: Lease state of the file. Possible values include: 'available', 'leased', 'expired',
+ * 'breaking', 'broken'.
*
* @param leaseState the leaseState value to set.
* @return the FileReadHeaders object itself.
@@ -544,8 +509,8 @@ public FileReadHeaders setLeaseState(LeaseStateType leaseState) {
}
/**
- * Get the leaseStatus property: The current lease status of the file.
- * Possible values include: 'locked', 'unlocked'.
+ * Get the leaseStatus property: The current lease status of the file. Possible values include: 'locked',
+ * 'unlocked'.
*
* @return the leaseStatus value.
*/
@@ -554,8 +519,8 @@ public LeaseStatusType getLeaseStatus() {
}
/**
- * Set the leaseStatus property: The current lease status of the file.
- * Possible values include: 'locked', 'unlocked'.
+ * Set the leaseStatus property: The current lease status of the file. Possible values include: 'locked',
+ * 'unlocked'.
*
* @param leaseStatus the leaseStatus value to set.
* @return the FileReadHeaders object itself.
@@ -566,9 +531,8 @@ public FileReadHeaders setLeaseStatus(LeaseStatusType leaseStatus) {
}
/**
- * Get the clientRequestId property: If a client request id header is sent
- * in the request, this header will be present in the response with the
- * same value.
+ * Get the clientRequestId property: If a client request id header is sent in the request, this header will be
+ * present in the response with the same value.
*
* @return the clientRequestId value.
*/
@@ -577,9 +541,8 @@ public String getClientRequestId() {
}
/**
- * Set the clientRequestId property: If a client request id header is sent
- * in the request, this header will be present in the response with the
- * same value.
+ * Set the clientRequestId property: If a client request id header is sent in the request, this header will be
+ * present in the response with the same value.
*
* @param clientRequestId the clientRequestId value to set.
* @return the FileReadHeaders object itself.
@@ -590,8 +553,8 @@ public FileReadHeaders setClientRequestId(String clientRequestId) {
}
/**
- * Get the requestId property: This header uniquely identifies the request
- * that was made and can be used for troubleshooting the request.
+ * Get the requestId property: This header uniquely identifies the request that was made and can be used for
+ * troubleshooting the request.
*
* @return the requestId value.
*/
@@ -600,8 +563,8 @@ public String getRequestId() {
}
/**
- * Set the requestId property: This header uniquely identifies the request
- * that was made and can be used for troubleshooting the request.
+ * Set the requestId property: This header uniquely identifies the request that was made and can be used for
+ * troubleshooting the request.
*
* @param requestId the requestId value to set.
* @return the FileReadHeaders object itself.
@@ -612,9 +575,8 @@ public FileReadHeaders setRequestId(String requestId) {
}
/**
- * Get the version property: Indicates the version of the Blob service used
- * to execute the request. This header is returned for requests made
- * against version 2009-09-19 and above.
+ * Get the version property: Indicates the version of the Blob service used to execute the request. This header is
+ * returned for requests made against version 2009-09-19 and above.
*
* @return the version value.
*/
@@ -623,9 +585,8 @@ public String getVersion() {
}
/**
- * Set the version property: Indicates the version of the Blob service used
- * to execute the request. This header is returned for requests made
- * against version 2009-09-19 and above.
+ * Set the version property: Indicates the version of the Blob service used to execute the request. This header is
+ * returned for requests made against version 2009-09-19 and above.
*
* @param version the version value to set.
* @return the FileReadHeaders object itself.
@@ -636,8 +597,7 @@ public FileReadHeaders setVersion(String version) {
}
/**
- * Get the acceptRanges property: Indicates that the service supports
- * requests for partial file content.
+ * Get the acceptRanges property: Indicates that the service supports requests for partial file content.
*
* @return the acceptRanges value.
*/
@@ -646,8 +606,7 @@ public String getAcceptRanges() {
}
/**
- * Set the acceptRanges property: Indicates that the service supports
- * requests for partial file content.
+ * Set the acceptRanges property: Indicates that the service supports requests for partial file content.
*
* @param acceptRanges the acceptRanges value to set.
* @return the FileReadHeaders object itself.
@@ -658,8 +617,8 @@ public FileReadHeaders setAcceptRanges(String acceptRanges) {
}
/**
- * Get the dateProperty property: UTC date/time value generated by the
- * service that indicates the time at which the response was initiated.
+ * Get the dateProperty property: UTC date/time value generated by the service that indicates the time at which the
+ * response was initiated.
*
* @return the dateProperty value.
*/
@@ -671,8 +630,8 @@ public OffsetDateTime getDateProperty() {
}
/**
- * Set the dateProperty property: UTC date/time value generated by the
- * service that indicates the time at which the response was initiated.
+ * Set the dateProperty property: UTC date/time value generated by the service that indicates the time at which the
+ * response was initiated.
*
* @param dateProperty the dateProperty value to set.
* @return the FileReadHeaders object itself.
@@ -687,11 +646,9 @@ public FileReadHeaders setDateProperty(OffsetDateTime dateProperty) {
}
/**
- * Get the isServerEncrypted property: The value of this header is set to
- * true if the file data and application metadata are completely encrypted
- * using the specified algorithm. Otherwise, the value is set to false
- * (when the file is unencrypted, or if only parts of the file/application
- * metadata are encrypted).
+ * Get the isServerEncrypted property: The value of this header is set to true if the file data and application
+ * metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the
+ * file is unencrypted, or if only parts of the file/application metadata are encrypted).
*
* @return the isServerEncrypted value.
*/
@@ -700,11 +657,9 @@ public Boolean isServerEncrypted() {
}
/**
- * Set the isServerEncrypted property: The value of this header is set to
- * true if the file data and application metadata are completely encrypted
- * using the specified algorithm. Otherwise, the value is set to false
- * (when the file is unencrypted, or if only parts of the file/application
- * metadata are encrypted).
+ * Set the isServerEncrypted property: The value of this header is set to true if the file data and application
+ * metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the
+ * file is unencrypted, or if only parts of the file/application metadata are encrypted).
*
* @param serverEncrypted the isServerEncrypted value to set.
* @return the FileReadHeaders object itself.
@@ -715,9 +670,8 @@ public FileReadHeaders setServerEncrypted(Boolean serverEncrypted) {
}
/**
- * Get the encryptionKeySha256 property: The SHA-256 hash of the encryption
- * key used to encrypt the file. This header is only returned when the file
- * was encrypted with a customer-provided key.
+ * Get the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the file. This
+ * header is only returned when the file was encrypted with a customer-provided key.
*
* @return the encryptionKeySha256 value.
*/
@@ -726,9 +680,8 @@ public String getEncryptionKeySha256() {
}
/**
- * Set the encryptionKeySha256 property: The SHA-256 hash of the encryption
- * key used to encrypt the file. This header is only returned when the file
- * was encrypted with a customer-provided key.
+ * Set the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the file. This
+ * header is only returned when the file was encrypted with a customer-provided key.
*
* @param encryptionKeySha256 the encryptionKeySha256 value to set.
* @return the FileReadHeaders object itself.
@@ -739,11 +692,10 @@ public FileReadHeaders setEncryptionKeySha256(String encryptionKeySha256) {
}
/**
- * Get the fileContentMD5 property: If the file has a MD5 hash, and if
- * request contains range header (Range or x-ms-range), this response
- * header is returned with the value of the whole file's MD5 value. This
- * value may or may not be equal to the value returned in Content-MD5
- * header, with the latter calculated from the requested range.
+ * Get the fileContentMD5 property: If the file has a MD5 hash, and if request contains range header
+ * (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value
+ * may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the
+ * requested range.
*
* @return the fileContentMD5 value.
*/
@@ -752,11 +704,10 @@ public byte[] getFileContentMd5() {
}
/**
- * Set the fileContentMD5 property: If the file has a MD5 hash, and if
- * request contains range header (Range or x-ms-range), this response
- * header is returned with the value of the whole file's MD5 value. This
- * value may or may not be equal to the value returned in Content-MD5
- * header, with the latter calculated from the requested range.
+ * Set the fileContentMD5 property: If the file has a MD5 hash, and if request contains range header
+ * (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value
+ * may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the
+ * requested range.
*
* @param fileContentMd5 the fileContentMD5 value to set.
* @return the FileReadHeaders object itself.
@@ -767,12 +718,10 @@ public FileReadHeaders setFileContentMd5(byte[] fileContentMd5) {
}
/**
- * Get the contentCrc64 property: If the request is to read a specified
- * range and the x-ms-range-get-content-crc64 is set to true, then the
- * request returns a crc64 for the range, as long as the range size is less
- * than or equal to 4 MB. If both x-ms-range-get-content-crc64 &
- * x-ms-range-get-content-md5 is specified in the same request, it will
- * fail with 400(Bad Request).
+ * Get the contentCrc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64
+ * is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal
+ * to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request,
+ * it will fail with 400(Bad Request).
*
* @return the contentCrc64 value.
*/
@@ -781,12 +730,10 @@ public byte[] getContentCrc64() {
}
/**
- * Set the contentCrc64 property: If the request is to read a specified
- * range and the x-ms-range-get-content-crc64 is set to true, then the
- * request returns a crc64 for the range, as long as the range size is less
- * than or equal to 4 MB. If both x-ms-range-get-content-crc64 &
- * x-ms-range-get-content-md5 is specified in the same request, it will
- * fail with 400(Bad Request).
+ * Set the contentCrc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64
+ * is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal
+ * to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is specified in the same request,
+ * it will fail with 400(Bad Request).
*
* @param contentCrc64 the contentCrc64 value to set.
* @return the FileReadHeaders object itself.
@@ -846,8 +793,8 @@ public String getEncryptionContext() {
}
/**
- * Encryption context that can be set on the file. Encryption context is intended to store metadata that
- * can be used to decrypt the blob.
+ * Encryption context that can be set on the file. Encryption context is intended to store metadata that can be used
+ * to decrypt the blob.
*
* @param encryptionContext the encryption context to be set on the file.
* @return the FileReadHeaders object itself.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemAccessPolicies.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemAccessPolicies.java
index 5ea3e34dd35d7..a5ee411b6a073 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemAccessPolicies.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemAccessPolicies.java
@@ -24,6 +24,8 @@ public FileSystemAccessPolicies(PublicAccessType dataLakeAccessType, List getIdentifiers() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemItem.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemItem.java
index 75c32652f9f65..7850f7f373ccf 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemItem.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemItem.java
@@ -15,6 +15,12 @@ public class FileSystemItem {
private FileSystemItemProperties properties;
private Map metadata;
+ /**
+ * Creates a new instance of {@link FileSystemItem}.
+ */
+ public FileSystemItem() {
+ }
+
/**
* Get the name property: The name property.
*
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemItemProperties.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemItemProperties.java
index 230c791a94fec..d44d4ed01f803 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemItemProperties.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemItemProperties.java
@@ -11,7 +11,6 @@
* Properties of a file system.
*/
public final class FileSystemItemProperties {
-
private DateTimeRfc1123 lastModified;
private String eTag;
private LeaseStatusType leaseStatus;
@@ -23,6 +22,12 @@ public final class FileSystemItemProperties {
private String encryptionScope;
private Boolean encryptionScopeOverridePrevented;
+ /**
+ * Creates a new instance of {@link FileSystemItemProperties}.
+ */
+ public FileSystemItemProperties() {
+ }
+
/**
* Get the lastModified property: The lastModified property.
*
@@ -71,8 +76,7 @@ public FileSystemItemProperties setETag(String eTag) {
}
/**
- * Get the leaseStatus property: Possible values include: 'locked',
- * 'unlocked'.
+ * Get the leaseStatus property: Possible values include: 'locked', 'unlocked'.
*
* @return the leaseStatus value.
*/
@@ -81,8 +85,7 @@ public LeaseStatusType getLeaseStatus() {
}
/**
- * Set the leaseStatus property: Possible values include: 'locked',
- * 'unlocked'.
+ * Set the leaseStatus property: Possible values include: 'locked', 'unlocked'.
*
* @param leaseStatus the leaseStatus value to set.
* @return the FileSystemItemProperties object itself.
@@ -93,8 +96,7 @@ public FileSystemItemProperties setLeaseStatus(LeaseStatusType leaseStatus) {
}
/**
- * Get the leaseState property: Possible values include: 'available',
- * 'leased', 'expired', 'breaking', 'broken'.
+ * Get the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
*
* @return the leaseState value.
*/
@@ -103,8 +105,7 @@ public LeaseStateType getLeaseState() {
}
/**
- * Set the leaseState property: Possible values include: 'available',
- * 'leased', 'expired', 'breaking', 'broken'.
+ * Set the leaseState property: Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
*
* @param leaseState the leaseState value to set.
* @return the FileSystemItemProperties object itself.
@@ -115,8 +116,7 @@ public FileSystemItemProperties setLeaseState(LeaseStateType leaseState) {
}
/**
- * Get the leaseDuration property: Possible values include: 'infinite',
- * 'fixed'.
+ * Get the leaseDuration property: Possible values include: 'infinite', 'fixed'.
*
* @return the leaseDuration value.
*/
@@ -125,8 +125,7 @@ public LeaseDurationType getLeaseDuration() {
}
/**
- * Set the leaseDuration property: Possible values include: 'infinite',
- * 'fixed'.
+ * Set the leaseDuration property: Possible values include: 'infinite', 'fixed'.
*
* @param leaseDuration the leaseDuration value to set.
* @return the FileSystemItemProperties object itself.
@@ -137,8 +136,7 @@ public FileSystemItemProperties setLeaseDuration(LeaseDurationType leaseDuration
}
/**
- * Get the publicAccess property: Possible values include: 'container',
- * 'blob'.
+ * Get the publicAccess property: Possible values include: 'container', 'blob'.
*
* @return the publicAccess value.
*/
@@ -147,8 +145,7 @@ public PublicAccessType getPublicAccess() {
}
/**
- * Set the publicAccess property: Possible values include: 'container',
- * 'blob'.
+ * Set the publicAccess property: Possible values include: 'container', 'blob'.
*
* @param publicAccess the publicAccess value to set.
* @return the FileSystemItemProperties object itself.
@@ -159,8 +156,7 @@ public FileSystemItemProperties setPublicAccess(PublicAccessType publicAccess) {
}
/**
- * Get the hasImmutabilityPolicy property: The hasImmutabilityPolicy
- * property.
+ * Get the hasImmutabilityPolicy property: The hasImmutabilityPolicy property.
*
* @return the hasImmutabilityPolicy value.
*/
@@ -169,8 +165,7 @@ public Boolean hasImmutabilityPolicy() {
}
/**
- * Set the hasImmutabilityPolicy property: The hasImmutabilityPolicy
- * property.
+ * Set the hasImmutabilityPolicy property: The hasImmutabilityPolicy property.
*
* @param hasImmutabilityPolicy the hasImmutabilityPolicy value to set.
* @return the FileSystemItemProperties object itself.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemListDetails.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemListDetails.java
index b17490deab1d0..96bc5a3c984bd 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemListDetails.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemListDetails.java
@@ -12,7 +12,6 @@
* new object. Null may be passed if none of the options are desirable.
*/
public final class FileSystemListDetails {
-
private boolean retrieveMetadata;
private boolean retrieveDeleted;
private boolean retrieveSystemFileSystems;
@@ -21,7 +20,6 @@ public final class FileSystemListDetails {
* Creates a new instance of {@link FileSystemListDetails}.
*/
public FileSystemListDetails() {
-
}
/**
@@ -85,6 +83,8 @@ public FileSystemListDetails setRetrieveSystemFileSystems(boolean retrieveSystem
}
/**
+ * Gets the listing flags.
+ *
* @return the listing flags
*/
public ListFileSystemsIncludeType toIncludeType() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemProperties.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemProperties.java
index d0e6702e2cb17..ef47f2b3e71a9 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemProperties.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/FileSystemProperties.java
@@ -62,6 +62,8 @@ public FileSystemProperties(final Map metadata, final String eTa
}
/**
+ * Gets the metadata associated with the file system.
+ *
* @return the metadata associated with the file system
*/
public Map getMetadata() {
@@ -69,6 +71,8 @@ public Map getMetadata() {
}
/**
+ * Gets the eTag of the file system.
+ *
* @return the eTag of the file system
*/
public String getETag() {
@@ -76,6 +80,8 @@ public String getETag() {
}
/**
+ * Gets the time the file system was last modified.
+ *
* @return the time the file system was last modified
*/
public OffsetDateTime getLastModified() {
@@ -83,6 +89,8 @@ public OffsetDateTime getLastModified() {
}
/**
+ * Gets the type of lease on the file system.
+ *
* @return the type of lease on the file system
*/
public LeaseDurationType getLeaseDuration() {
@@ -90,6 +98,8 @@ public LeaseDurationType getLeaseDuration() {
}
/**
+ * Gets the lease state of the file system.
+ *
* @return the lease state of the file system
*/
public LeaseStateType getLeaseState() {
@@ -97,6 +107,8 @@ public LeaseStateType getLeaseState() {
}
/**
+ * Gets the lease status of the file system.
+ *
* @return the lease status of the file system
*/
public LeaseStatusType getLeaseStatus() {
@@ -104,6 +116,8 @@ public LeaseStatusType getLeaseStatus() {
}
/**
+ * Gets the access type for the file system.
+ *
* @return the access type for the file system
*/
public PublicAccessType getDataLakePublicAccess() {
@@ -111,6 +125,8 @@ public PublicAccessType getDataLakePublicAccess() {
}
/**
+ * Gets the immutability status for the file system.
+ *
* @return the immutability status for the file system
*/
public boolean hasImmutabilityPolicy() {
@@ -118,6 +134,8 @@ public boolean hasImmutabilityPolicy() {
}
/**
+ * Gets the legal hold status for the file system.
+ *
* @return the legal hold status for the file system
*/
public boolean hasLegalHold() {
@@ -125,6 +143,8 @@ public boolean hasLegalHold() {
}
/**
+ * Gets the file system's encryption scope.
+ *
* @return the file system's encryption scope
*/
public String getEncryptionScope() {
@@ -132,6 +152,8 @@ public String getEncryptionScope() {
}
/**
+ * Gets the file system's deny encryption scope override property.
+ *
* @return the file system's deny encryption scope override property.
*/
public Boolean isEncryptionScopeOverridePrevented() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/ListFileSystemsOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/ListFileSystemsOptions.java
index cd0a9df1c484c..40ae87419f748 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/ListFileSystemsOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/ListFileSystemsOptions.java
@@ -15,9 +15,7 @@ public final class ListFileSystemsOptions {
private static final ClientLogger LOGGER = new ClientLogger(ListFileSystemsOptions.class);
private FileSystemListDetails details;
-
private String prefix;
-
private Integer maxResultsPerPage;
/**
@@ -28,6 +26,8 @@ public ListFileSystemsOptions() {
}
/**
+ * Gets the details for listing specific file systems.
+ *
* @return the details for listing specific file systems
*/
public FileSystemListDetails getDetails() {
@@ -35,6 +35,8 @@ public FileSystemListDetails getDetails() {
}
/**
+ * Sets the details for listing specific file systems.
+ *
* @param details The details for listing specific file systems
* @return the updated FileSystemListDetails object
*/
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathAccessControl.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathAccessControl.java
index 76e3cd6ffc020..fb87c1fe3b242 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathAccessControl.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathAccessControl.java
@@ -9,7 +9,6 @@
* This class contains properties that are gettable and settable for path access control.
*/
public class PathAccessControl {
-
private final List accessControlList;
private final String group;
private final String owner;
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathAccessControlEntry.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathAccessControlEntry.java
index a4b83f6653a6f..9ff4aef89da8e 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathAccessControlEntry.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathAccessControlEntry.java
@@ -65,7 +65,7 @@ public class PathAccessControlEntry {
/**
* Specifies the entity for which this entry applies. This is an AAD ObjectId.
- *
+ *
* Must be omitted for types mask or other. It must also be omitted when the user or group is the owner.
*/
private String entityId;
@@ -136,7 +136,7 @@ public String toString() {
/**
* Parses the provided string into a {@code List<{@link PathAccessControlEntry}>}.
- *
+ *
* Must be of the format "[scope:][type]:[id]:[permissions]".
*
* @param str The string representation of the ACL.
@@ -234,7 +234,7 @@ public RolePermissions getPermissions() {
}
/**
- * Sets whether or not this entry is the default for a directory.
+ * Sets whether this entry is the default for a directory.
*
* @param defaultScope {@code true} to set as the default scope and {@code false} otherwise.
* @return The updated PathAccessControlEntry object.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathInfo.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathInfo.java
index 39c8a63069c53..59aa550fd70c9 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathInfo.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathInfo.java
@@ -10,7 +10,6 @@
* operations.
*/
public class PathInfo {
-
private final String eTag;
private final OffsetDateTime lastModified;
private final boolean isServerEncrypted;
@@ -58,6 +57,8 @@ public OffsetDateTime getLastModified() {
}
/**
+ * Gets the encryption status of the block blob on the server.
+ *
* @return the encryption status of the block blob on the server
*/
public Boolean isServerEncrypted() {
@@ -65,6 +66,8 @@ public Boolean isServerEncrypted() {
}
/**
+ * Gets the key used to encrypt the block blob.
+ *
* @return the key used to encrypt the block blob
*/
public String getEncryptionKeySha256() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathItem.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathItem.java
index 6eda02fefba53..52d51e0cd9000 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathItem.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathItem.java
@@ -39,7 +39,7 @@ public class PathItem {
* @param lastModified Datetime when the path was last modified.
* @param contentLength The content length of the path.
* @param group The group the path belongs to.
- * @param isDirectory Whether or not the path is a directory.
+ * @param isDirectory Whether the path is a directory.
* @param name The name of the path.
* @param owner The owner the path belongs to.
* @param permissions The permissions set on the path.
@@ -55,7 +55,7 @@ public PathItem(String eTag, OffsetDateTime lastModified, long contentLength, St
* @param lastModified Datetime when the path was last modified.
* @param contentLength The content length of the path.
* @param group The group the path belongs to.
- * @param isDirectory Whether or not the path is a directory.
+ * @param isDirectory Whether the path is a directory.
* @param name The name of the path.
* @param owner The owner the path belongs to.
* @param permissions The permissions set on the path.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathPermissions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathPermissions.java
index 2087641c853aa..430a00f560aaf 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathPermissions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathPermissions.java
@@ -14,7 +14,6 @@
* Manipulating resource permissions is only supported when ADLS interop and Hierarchical Namespace are enabled.
*/
public class PathPermissions {
-
private static final String PATH_PERMISSIONS_OCTAL_FORMAT_ERROR
= "String cannot be null and must be four " + "characters (first bit--sticky bit--must be set to 0 for umask).";
private static final String PATH_PERMISSIONS_SYMBOLIC_FORMAT_ERROR
@@ -94,7 +93,7 @@ public int hashCode() {
/**
* Converts an octal string into a {@code PathPermissions} object.
- *
+ *
* e.g. 1752
* 0/1 in the first digit indicates sticky bit. Each subsequent octal character can be expanded into three bits.
* In order of MSB to LSB, the bits represent read, write, execute.
@@ -119,7 +118,7 @@ public static PathPermissions parseOctal(String octal) {
/**
* Converts a symbolic representation of the permissions into a {@code PathPermissions} object.
- *
+ *
* e.g. rwxr-x-wT
* Each set of three characters correspondes to owner, owning group, and other respectively. 'r', 'w', and 'x'
* respectively refer to read, write, and execute. A '-' indicates the permission is not given. The sticky bit, if
@@ -233,7 +232,7 @@ public PathPermissions setOther(RolePermissions other) {
}
/**
- * Returns whether or not the sticky bit has been set. The sticky bit may be set on directories, the files in that
+ * Returns whether the sticky bit has been set. The sticky bit may be set on directories, the files in that
* directory may only be renamed or deleted by the file's owner, the directory's owner, or the root user.
*
* @return {@code true} if the sticky bit is set and {@code false} otherwise.
@@ -255,7 +254,7 @@ public PathPermissions setStickyBit(boolean hasStickyBit) {
}
/**
- * Returns whether or not there is more permissions information in the ACLs. The permissions string only returns
+ * Returns whether there is more permissions information in the ACLs. The permissions string only returns
* information on the owner, owning group, and other, but the ACLs may contain more permissions for specific users
* or groups.
*
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathProperties.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathProperties.java
index f488933e00713..bbfe90b43c335 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathProperties.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathProperties.java
@@ -187,6 +187,8 @@ public PathProperties(final OffsetDateTime creationTime, final OffsetDateTime la
}
/**
+ * Gets the time when the path was created.
+ *
* @return the time when the path was created
*/
public OffsetDateTime getCreationTime() {
@@ -194,6 +196,8 @@ public OffsetDateTime getCreationTime() {
}
/**
+ * Gets the time when the path was last modified.
+ *
* @return the time when the path was last modified
*/
public OffsetDateTime getLastModified() {
@@ -201,6 +205,8 @@ public OffsetDateTime getLastModified() {
}
/**
+ * Gets the eTag of the path.
+ *
* @return the eTag of the path
*/
public String getETag() {
@@ -208,6 +214,8 @@ public String getETag() {
}
/**
+ * Gets the size of the path in bytes.
+ *
* @return the size of the path in bytes
*/
public long getFileSize() {
@@ -215,6 +223,8 @@ public long getFileSize() {
}
/**
+ * Gets the content type of the path.
+ *
* @return the content type of the path
*/
public String getContentType() {
@@ -222,6 +232,8 @@ public String getContentType() {
}
/**
+ * Gets the MD5 of the path's content.
+ *
* @return the MD5 of the path's content
*/
public byte[] getContentMd5() {
@@ -229,6 +241,8 @@ public byte[] getContentMd5() {
}
/**
+ * Gets the content encoding of the path.
+ *
* @return the content encoding of the path
*/
public String getContentEncoding() {
@@ -236,6 +250,8 @@ public String getContentEncoding() {
}
/**
+ * Gets the content disposition of the path.
+ *
* @return the content disposition of the path
*/
public String getContentDisposition() {
@@ -243,6 +259,8 @@ public String getContentDisposition() {
}
/**
+ * Gets the content language of the path.
+ *
* @return the content language of the path
*/
public String getContentLanguage() {
@@ -250,6 +268,8 @@ public String getContentLanguage() {
}
/**
+ * Gets the cache control of the path.
+ *
* @return the cache control of the path
*/
public String getCacheControl() {
@@ -257,6 +277,8 @@ public String getCacheControl() {
}
/**
+ * Gets the lease status of the path.
+ *
* @return the lease status of the path
*/
public LeaseStatusType getLeaseStatus() {
@@ -264,6 +286,8 @@ public LeaseStatusType getLeaseStatus() {
}
/**
+ * Gets the lease state of the path.
+ *
* @return the lease state of the path
*/
public LeaseStateType getLeaseState() {
@@ -271,6 +295,8 @@ public LeaseStateType getLeaseState() {
}
/**
+ * Gets the lease duration if the path is leased.
+ *
* @return the lease duration if the path is leased
*/
public LeaseDurationType getLeaseDuration() {
@@ -278,6 +304,8 @@ public LeaseDurationType getLeaseDuration() {
}
/**
+ * Gets the identifier of the last copy operation.
+ *
* @return the identifier of the last copy operation. If this path hasn't been the target of a copy operation or has
* been modified since this won't be set.
*/
@@ -286,6 +314,8 @@ public String getCopyId() {
}
/**
+ * Gets the status of the last copy operation.
+ *
* @return the status of the last copy operation. If this path hasn't been the target of a copy operation or has
* been modified since this won't be set.
*/
@@ -294,6 +324,8 @@ public CopyStatusType getCopyStatus() {
}
/**
+ * Gets the source path URL from the last copy operation.
+ *
* @return the source path URL from the last copy operation. If this path hasn't been the target of a copy operation
* or has been modified since this won't be set.
*/
@@ -302,6 +334,8 @@ public String getCopySource() {
}
/**
+ * Gets the number of bytes copied and total bytes in the source from the last copy operation.
+ *
* @return the number of bytes copied and total bytes in the source from the last copy operation (bytes copied/total
* bytes). If this path hasn't been the target of a copy operation or has been modified since this won't be set.
*/
@@ -310,6 +344,8 @@ public String getCopyProgress() {
}
/**
+ * Gets the completion time of the last copy operation.
+ *
* @return the completion time of the last copy operation. If this path hasn't been the target of a copy operation
* or has been modified since this won't be set.
*/
@@ -318,6 +354,8 @@ public OffsetDateTime getCopyCompletionTime() {
}
/**
+ * Gets the description of the last copy failure.
+ *
* @return the description of the last copy failure, this is set when the {@link #getCopyStatus() getCopyStatus} is
* {@link CopyStatusType#FAILED failed} or {@link CopyStatusType#ABORTED aborted}. If this path hasn't been the
* target of a copy operation or has been modified since this won't be set.
@@ -327,6 +365,8 @@ public String getCopyStatusDescription() {
}
/**
+ * Gets the status of the path being encrypted on the server.
+ *
* @return the status of the path being encrypted on the server
*/
public Boolean isServerEncrypted() {
@@ -334,6 +374,8 @@ public Boolean isServerEncrypted() {
}
/**
+ * Gets the status of the path being an incremental copy file.
+ *
* @return the status of the path being an incremental copy file
*/
public Boolean isIncrementalCopy() {
@@ -341,6 +383,8 @@ public Boolean isIncrementalCopy() {
}
/**
+ * Gets the tier of the path.
+ *
* @return the tier of the path.
*/
public AccessTier getAccessTier() {
@@ -348,6 +392,8 @@ public AccessTier getAccessTier() {
}
/**
+ * Gets the archive status of the path.
+ *
* @return the archive status of the path.
*/
public ArchiveStatus getArchiveStatus() {
@@ -355,6 +401,8 @@ public ArchiveStatus getArchiveStatus() {
}
/**
+ * Gets the SHA256 of the encryption key used to encrypt the path.
+ *
* @return the key used to encrypt the path
*/
public String getEncryptionKeySha256() {
@@ -362,6 +410,8 @@ public String getEncryptionKeySha256() {
}
/**
+ * Gets the time when the access tier for the path was last changed.
+ *
* @return the time when the access tier for the path was last changed
*/
public OffsetDateTime getAccessTierChangeTime() {
@@ -369,6 +419,8 @@ public OffsetDateTime getAccessTierChangeTime() {
}
/**
+ * Gets the metadata associated to this path.
+ *
* @return the metadata associated to this path
*/
public Map getMetadata() {
@@ -376,13 +428,17 @@ public Map getMetadata() {
}
/**
- * @return whether or not this path represents a directory
+ * Gets whether this path represents a directory.
+ *
+ * @return whether this path represents a directory
*/
public Boolean isDirectory() {
return isDirectory;
}
/**
+ * Gets the time when the path is going to expire.
+ *
* @return the time when the path is going to expire.
*/
public OffsetDateTime getExpiresOn() {
@@ -390,6 +446,8 @@ public OffsetDateTime getExpiresOn() {
}
/**
+ * Gets the path's encryption scope.
+ *
* @return the path's encryption scope.
*/
public String getEncryptionScope() {
@@ -397,6 +455,8 @@ public String getEncryptionScope() {
}
/**
+ * Gets the encryption context for this path. Only applicable for files.
+ *
* @return the encryption context for this path. Only applicable for files.
*/
public String getEncryptionContext() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathRemoveAccessControlEntry.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathRemoveAccessControlEntry.java
index 128c00bcd4b34..653054bc78508 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathRemoveAccessControlEntry.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PathRemoveAccessControlEntry.java
@@ -105,7 +105,7 @@ public String toString() {
/**
* Parses the provided string into a {@code PathAccessControlEntry}.
- *
+ *
* Must be of the format "[scope:][type]:[id]".
*
* @param str The string representation of the ACL.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PublicAccessType.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PublicAccessType.java
index bbadf1f700ee3..f127be7d5c491 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PublicAccessType.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/PublicAccessType.java
@@ -21,6 +21,15 @@ public final class PublicAccessType extends ExpandableStringEnum values() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/RolePermissions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/RolePermissions.java
index d8192dc886d2c..f7afe282ffa44 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/RolePermissions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/RolePermissions.java
@@ -188,6 +188,8 @@ public int hashCode() {
}
/**
+ * Gets the read permission status.
+ *
* @return the read permission status
*/
public boolean hasReadPermission() {
@@ -195,6 +197,8 @@ public boolean hasReadPermission() {
}
/**
+ * Gets the write permission status.
+ *
* @return the write permission status
*/
public boolean hasWritePermission() {
@@ -202,6 +206,8 @@ public boolean hasWritePermission() {
}
/**
+ * Gets the execute permission status.
+ *
* @return the execute permission status
*/
public boolean hasExecutePermission() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/UserDelegationKey.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/UserDelegationKey.java
index 20a182b08e65d..8d6eb10d89e1e 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/UserDelegationKey.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/models/UserDelegationKey.java
@@ -46,8 +46,13 @@ public final class UserDelegationKey {
private String value;
/**
- * Get the signedObjectId property: The Azure Active Directory object ID in
- * GUID format.
+ * Creates a new instance of {@link UserDelegationKey}.
+ */
+ public UserDelegationKey() {
+ }
+
+ /**
+ * Get the signedObjectId property: The Azure Active Directory object ID in GUID format.
*
* @return the signedObjectId value.
*/
@@ -56,8 +61,7 @@ public String getSignedObjectId() {
}
/**
- * Set the signedObjectId property: The Azure Active Directory object ID in
- * GUID format.
+ * Set the signedObjectId property: The Azure Active Directory object ID in GUID format.
*
* @param signedObjectId the signedObjectId value to set.
* @return the UserDelegationKey object itself.
@@ -68,8 +72,7 @@ public UserDelegationKey setSignedObjectId(String signedObjectId) {
}
/**
- * Get the signedTenantId property: The Azure Active Directory tenant ID in
- * GUID format.
+ * Get the signedTenantId property: The Azure Active Directory tenant ID in GUID format.
*
* @return the signedTenantId value.
*/
@@ -78,8 +81,7 @@ public String getSignedTenantId() {
}
/**
- * Set the signedTenantId property: The Azure Active Directory tenant ID in
- * GUID format.
+ * Set the signedTenantId property: The Azure Active Directory tenant ID in GUID format.
*
* @param signedTenantId the signedTenantId value to set.
* @return the UserDelegationKey object itself.
@@ -130,8 +132,7 @@ public UserDelegationKey setSignedExpiry(OffsetDateTime signedExpiry) {
}
/**
- * Get the signedService property: Abbreviation of the Azure Storage
- * service that accepts the key.
+ * Get the signedService property: Abbreviation of the Azure Storage service that accepts the key.
*
* @return the signedService value.
*/
@@ -140,8 +141,7 @@ public String getSignedService() {
}
/**
- * Set the signedService property: Abbreviation of the Azure Storage
- * service that accepts the key.
+ * Set the signedService property: Abbreviation of the Azure Storage service that accepts the key.
*
* @param signedService the signedService value to set.
* @return the UserDelegationKey object itself.
@@ -152,8 +152,7 @@ public UserDelegationKey setSignedService(String signedService) {
}
/**
- * Get the signedVersion property: The service version that created the
- * key.
+ * Get the signedVersion property: The service version that created the key.
*
* @return the signedVersion value.
*/
@@ -162,8 +161,7 @@ public String getSignedVersion() {
}
/**
- * Set the signedVersion property: The service version that created the
- * key.
+ * Set the signedVersion property: The service version that created the key.
*
* @param signedVersion the signedVersion value to set.
* @return the UserDelegationKey object itself.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileAppendOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileAppendOptions.java
index 3db142885fa06..ca3c4f5c04824 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileAppendOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileAppendOptions.java
@@ -13,7 +13,6 @@
*/
@Fluent
public class DataLakeFileAppendOptions {
-
private String leaseId;
private byte[] contentMd5;
private Boolean flush;
@@ -21,6 +20,12 @@ public class DataLakeFileAppendOptions {
private Integer leaseDuration;
private String proposedLeaseId;
+ /**
+ * Creates a new instance of {@link DataLakeFileAppendOptions}.
+ */
+ public DataLakeFileAppendOptions() {
+ }
+
/**
* Gets the lease ID to access the file.
*
@@ -123,6 +128,8 @@ public DataLakeFileAppendOptions setLeaseAction(LeaseAction leaseAction) {
}
/**
+ * Gets the lease duration in seconds.
+ *
* @return the lease duration in seconds.
*/
public Integer getLeaseDuration() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileFlushOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileFlushOptions.java
index 6e1c214363d6f..4b297f15a2f36 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileFlushOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileFlushOptions.java
@@ -16,7 +16,6 @@
*/
@Fluent
public class DataLakeFileFlushOptions {
-
private Boolean retainUncommittedData;
private Boolean close;
private PathHttpHeaders pathHttpHeaders;
@@ -25,6 +24,12 @@ public class DataLakeFileFlushOptions {
private Integer leaseDuration;
private String proposedLeaseId;
+ /**
+ * Creates a new instance of {@link DataLakeFileFlushOptions}.
+ */
+ public DataLakeFileFlushOptions() {
+ }
+
/**
* If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is
* deleted after the flush operation. The default is false. Data at offsets less than the specified position are
@@ -161,6 +166,8 @@ public DataLakeFileFlushOptions setLeaseAction(LeaseAction leaseAction) {
}
/**
+ * Gets the lease duration in seconds.
+ *
* @return the lease duration in seconds.
*/
public Integer getLeaseDuration() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileInputStreamOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileInputStreamOptions.java
index fa69204126809..861a2af068de1 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileInputStreamOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileInputStreamOptions.java
@@ -13,7 +13,6 @@
*/
@Fluent
public final class DataLakeFileInputStreamOptions {
-
private FileRange range;
private DataLakeRequestConditions requestConditions;
private Integer blockSize;
@@ -21,6 +20,14 @@ public final class DataLakeFileInputStreamOptions {
private Boolean userPrincipalName;
/**
+ * Creates a new instance of {@link DataLakeFileInputStreamOptions}.
+ */
+ public DataLakeFileInputStreamOptions() {
+ }
+
+ /**
+ * Gets the {@link FileRange}.
+ *
* @return {@link FileRange}
*/
public FileRange getRange() {
@@ -28,6 +35,8 @@ public FileRange getRange() {
}
/**
+ * Sets the {@link FileRange}.
+ *
* @param range {@link FileRange}
* @return The updated options.
*/
@@ -37,6 +46,8 @@ public DataLakeFileInputStreamOptions setRange(FileRange range) {
}
/**
+ * Gets the {@link DataLakeRequestConditions}.
+ *
* @return {@link DataLakeRequestConditions}
*/
public DataLakeRequestConditions getRequestConditions() {
@@ -44,6 +55,8 @@ public DataLakeRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link DataLakeRequestConditions}.
+ *
* @param requestConditions {@link DataLakeRequestConditions}
* @return The updated options.
*/
@@ -53,6 +66,10 @@ public DataLakeFileInputStreamOptions setRequestConditions(DataLakeRequestCondit
}
/**
+ * Gets the size of each data chunk returned from the service. If block size is large, input stream will make
+ * fewer network calls, but each individual call will send more data and will therefore take longer.
+ * The default value is 4 MB.
+ *
* @return The size of each data chunk returned from the service. If block size is large, input stream will make
* fewer network calls, but each individual call will send more data and will therefore take longer.
* The default value is 4 MB.
@@ -62,6 +79,10 @@ public Integer getBlockSize() {
}
/**
+ * Sets the size of each data chunk returned from the service. If block size is large, input stream will make
+ * fewer network calls, but each individual call will send more data and will therefore take longer.
+ * The default value is 4 MB.
+ *
* @param blockSize The size of each data chunk returned from the service. If block size is large, input stream
* will make fewer network calls, but each individual call will send more data and will therefore take longer.
* The default value is 4 MB.
@@ -73,6 +94,8 @@ public DataLakeFileInputStreamOptions setBlockSize(Integer blockSize) {
}
/**
+ * Gets the {@link ConsistentReadControl} Default is E-Tag.
+ *
* @return {@link ConsistentReadControl} Default is E-Tag.
*/
public ConsistentReadControl getConsistentReadControl() {
@@ -80,6 +103,8 @@ public ConsistentReadControl getConsistentReadControl() {
}
/**
+ * Sets the {@link ConsistentReadControl} Default is E-Tag.
+ *
* @param consistentReadControl {@link ConsistentReadControl} Default is E-Tag.
* @return The updated options.
*/
@@ -89,6 +114,8 @@ public DataLakeFileInputStreamOptions setConsistentReadControl(ConsistentReadCon
}
/**
+ * Gets the value for the x-ms-upn header.
+ *
* @return The value for the x-ms-upn header.
*/
public Boolean isUserPrincipalName() {
@@ -96,6 +123,8 @@ public Boolean isUserPrincipalName() {
}
/**
+ * Sets the value for the x-ms-upn header.
+ *
* @param userPrincipalName The value for the x-ms-upn header.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileOutputStreamOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileOutputStreamOptions.java
index 5f0cb8a8863c6..02c6381f02ae6 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileOutputStreamOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakeFileOutputStreamOptions.java
@@ -22,6 +22,14 @@ public class DataLakeFileOutputStreamOptions {
private DataLakeRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link DataLakeFileOutputStreamOptions}.
+ */
+ public DataLakeFileOutputStreamOptions() {
+ }
+
+ /**
+ * Gets the {@link ParallelTransferOptions}.
+ *
* @return {@link ParallelTransferOptions}
*/
public ParallelTransferOptions getParallelTransferOptions() {
@@ -29,6 +37,8 @@ public ParallelTransferOptions getParallelTransferOptions() {
}
/**
+ * Sets the {@link ParallelTransferOptions}.
+ *
* @param parallelTransferOptions {@link ParallelTransferOptions}
* @return The updated options.
*/
@@ -38,6 +48,8 @@ public DataLakeFileOutputStreamOptions setParallelTransferOptions(ParallelTransf
}
/**
+ * Gets the {@link PathHttpHeaders}.
+ *
* @return {@link PathHttpHeaders}
*/
public PathHttpHeaders getHeaders() {
@@ -45,6 +57,8 @@ public PathHttpHeaders getHeaders() {
}
/**
+ * Sets the {@link PathHttpHeaders}.
+ *
* @param headers {@link PathHttpHeaders}
* @return The updated options.
*/
@@ -54,6 +68,8 @@ public DataLakeFileOutputStreamOptions setHeaders(PathHttpHeaders headers) {
}
/**
+ * Gets the metadata to associate with the file.
+ *
* @return The metadata to associate with the file.
*/
public Map getMetadata() {
@@ -61,6 +77,8 @@ public Map getMetadata() {
}
/**
+ * Sets the metadata to associate with the file.
+ *
* @param metadata The metadata to associate with the file.
* @return The updated options
*/
@@ -70,6 +88,8 @@ public DataLakeFileOutputStreamOptions setMetadata(Map metadata)
}
/**
+ * Gets the tags to associate with the file.
+ *
* @return The tags to associate with the file.
*/
public Map getTags() {
@@ -77,6 +97,8 @@ public Map getTags() {
}
/**
+ * Sets the tags to associate with the file.
+ *
* @param tags The tags to associate with the file.
* @return The updated options.
*/
@@ -86,6 +108,8 @@ public DataLakeFileOutputStreamOptions setTags(Map tags) {
}
/**
+ * Gets the {@link AccessTier}.
+ *
* @return {@link AccessTier}
*/
public AccessTier getAccessTier() {
@@ -93,6 +117,8 @@ public AccessTier getAccessTier() {
}
/**
+ * Sets the {@link AccessTier}.
+ *
* @param tier {@link AccessTier}
* @return The updated options.
*/
@@ -102,6 +128,8 @@ public DataLakeFileOutputStreamOptions setAccessTier(AccessTier tier) {
}
/**
+ * Gets the {@link DataLakeRequestConditions}.
+ *
* @return {@link DataLakeRequestConditions}
*/
public DataLakeRequestConditions getRequestConditions() {
@@ -109,6 +137,8 @@ public DataLakeRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link DataLakeRequestConditions}.
+ *
* @param requestConditions {@link DataLakeRequestConditions}
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakePathCreateOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakePathCreateOptions.java
index 229757e3e81da..e9f41879ebc3b 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakePathCreateOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakePathCreateOptions.java
@@ -16,7 +16,6 @@
*/
@Fluent
public class DataLakePathCreateOptions {
-
private String permissions;
private String umask;
private List accessControlEntryList;
@@ -38,6 +37,10 @@ public DataLakePathCreateOptions() {
}
/**
+ * Gets the POSIX access permissions for the file owner, the file owning group, and others. Each class may be
+ * granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and
+ * 4-digit octal notation (e.g. 0766) are supported.
+ *
* @return the permissions
*/
public String getPermissions() {
@@ -58,6 +61,11 @@ public DataLakePathCreateOptions setPermissions(String permissions) {
}
/**
+ * Gets the umask restricts the permissions of the file or directory to be created. The resulting permission is
+ * given by p bitwise-and ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057,
+ * then the resulting permission is 0720. The default permission is 0777 for a directory and 0666 for a file. The
+ * default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766).
+ *
* @return the umask.
*/
public String getUmask() {
@@ -65,12 +73,11 @@ public String getUmask() {
}
/**
- * When creating a file or directory and the parent folder does not have a default ACL,
- * the umask restricts the permissions of the file or directory to be created. The resulting
- * permission is given by p bitwise-and ^u, where p is the permission and u is the umask. For example,
- * if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is
- * 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified
- * in 4-digit octal notation (e.g. 0766).
+ * When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the
+ * permissions of the file or directory to be created. The resulting permission is given by p bitwise-and ^u, where
+ * p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is
+ * 0720. The default permission is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask
+ * must be specified in 4-digit octal notation (e.g. 0766).
*
* @param umask The umask.
* @return the updated options.
@@ -81,6 +88,8 @@ public DataLakePathCreateOptions setUmask(String umask) {
}
/**
+ * Gets the POSIX access control list for the file/directory.
+ *
* @return the POSIX access control list for the file/directory.
*/
public List getAccessControlList() {
@@ -99,6 +108,8 @@ public DataLakePathCreateOptions setAccessControlList(List getMetadata() {
@@ -210,6 +227,8 @@ public DataLakePathCreateOptions setRequestConditions(DataLakeRequestConditions
}
/**
+ * Gets the source lease ID.
+ *
* @return the source lease ID
*/
public String getSourceLeaseId() {
@@ -227,6 +246,8 @@ public DataLakePathCreateOptions setSourceLeaseId(String leaseId) {
}
/**
+ * Gets the proposed lease ID.
+ *
* @return the proposed lease ID.
*/
public String getProposedLeaseId() {
@@ -246,6 +267,8 @@ public DataLakePathCreateOptions setProposedLeaseId(String leaseId) {
}
/**
+ * Gets the lease duration in seconds.
+ *
* @return the lease duration in seconds.
*/
public Integer getLeaseDuration() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakePathDeleteOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakePathDeleteOptions.java
index 2825aafc5cff3..788e242d6fd73 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakePathDeleteOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakePathDeleteOptions.java
@@ -11,7 +11,6 @@
*/
@Fluent
public class DataLakePathDeleteOptions {
-
private boolean isRecursive;
private DataLakeRequestConditions requestConditions;
@@ -22,6 +21,8 @@ public DataLakePathDeleteOptions() {
}
/**
+ * Gets whether everything under the resource should be deleted recursively.
+ *
* @return whether everything under the resource should be deleted recursively
*/
public boolean getIsRecursive() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakePathScheduleDeletionOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakePathScheduleDeletionOptions.java
index 617cd092291d2..0feb5e5293d34 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakePathScheduleDeletionOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/DataLakePathScheduleDeletionOptions.java
@@ -14,7 +14,6 @@
*/
@Fluent
public class DataLakePathScheduleDeletionOptions {
-
private final OffsetDateTime expiresOn;
private final Duration timeToExpire;
@@ -40,6 +39,8 @@ public DataLakePathScheduleDeletionOptions(Duration timeToExpire) {
}
/**
+ * Gets the expiry date.
+ *
* @return the expiry date.
*/
public OffsetDateTime getExpiresOn() {
@@ -47,6 +48,8 @@ public OffsetDateTime getExpiresOn() {
}
/**
+ * Gets the time to expire.
+ *
* @return the time to expire.
*/
public Duration getTimeToExpire() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileParallelUploadOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileParallelUploadOptions.java
index 8d391cc61c7ee..ca25c5dbf58a5 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileParallelUploadOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileParallelUploadOptions.java
@@ -38,6 +38,7 @@ public class FileParallelUploadOptions {
* @param dataFlux The data to write to the file. Unlike other upload methods, this method does not require that
* the {@code Flux} be replayable. In other words, it does not have to support multiple subscribers and is not
* expected to produce the same values across subscriptions.
+ * @throws NullPointerException If {@code dataFlux} is null.
*/
public FileParallelUploadOptions(Flux dataFlux) {
StorageImplUtils.assertNotNull("dataFlux", dataFlux);
@@ -51,6 +52,7 @@ public FileParallelUploadOptions(Flux dataFlux) {
* Constructs a new {@code FileParallelUploadOptions}.
*
* @param data The {@link BinaryData} to write to the file.
+ * @throws NullPointerException If {@code data} is null.
*/
public FileParallelUploadOptions(BinaryData data) {
StorageImplUtils.assertNotNull("data must not be null", data);
@@ -62,7 +64,7 @@ public FileParallelUploadOptions(BinaryData data) {
/**
* Constructs a new {@code FileParallelUploadOptions}.
- *
+ *
* Use {@link #FileParallelUploadOptions(InputStream)} instead to supply an InputStream without knowing the exact
* length beforehand.
*
@@ -71,6 +73,8 @@ public FileParallelUploadOptions(BinaryData data) {
* mark support.
* @param length The exact length of the data. It is important that this value match precisely the length of the
* data provided in the {@link InputStream}.
+ * @throws NullPointerException If {@code dataStream} is null.
+ * @throws IllegalArgumentException If {@code length} is less than 0 or greater than {@link Long#MAX_VALUE}.
* @deprecated length is no longer necessary; use {@link #FileParallelUploadOptions(InputStream)} instead.
*/
@Deprecated
@@ -84,6 +88,7 @@ public FileParallelUploadOptions(InputStream dataStream, long length) {
* @param dataStream The data to write to the blob. The data must be markable. This is in order to support retries.
* If the data is not markable, consider wrapping your data source in a {@link java.io.BufferedInputStream} to add
* mark support.
+ * @throws NullPointerException If {@code dataStream} is null.
*/
public FileParallelUploadOptions(InputStream dataStream) {
this(dataStream, null);
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileQueryOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileQueryOptions.java
index 9f4f3cdc6e61f..3eb9a36c50f5c 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileQueryOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileQueryOptions.java
@@ -18,7 +18,6 @@
*/
@Fluent
public class FileQueryOptions {
-
private final String expression;
private final OutputStream outputStream;
private FileQuerySerialization inputSerialization;
@@ -30,6 +29,7 @@ public class FileQueryOptions {
/**
* Constructs a {@link FileQueryOptions}.
* @param expression The query expression.
+ * @throws NullPointerException If {@code expression} is null.
*/
public FileQueryOptions(String expression) {
StorageImplUtils.assertNotNull("expression", expression);
@@ -41,6 +41,7 @@ public FileQueryOptions(String expression) {
* Constructs a {@link FileQueryOptions}.
* @param expression The query expression.
* @param outputStream Gets the OutputStream where the downloaded data will be written.
+ * @throws NullPointerException If {@code expression} or {@code outputStream} is null.
*/
public FileQueryOptions(String expression, OutputStream outputStream) {
StorageImplUtils.assertNotNull("expression", expression);
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileScheduleDeletionOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileScheduleDeletionOptions.java
index e1b1078414b3d..8c272d58d048d 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileScheduleDeletionOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileScheduleDeletionOptions.java
@@ -33,6 +33,7 @@ public FileScheduleDeletionOptions() {
* @param timeToExpire Duration before file will be deleted.
* @param expiryRelativeTo Specifies if TimeToExpire should be
* set relative to the file's creation time, or the current time.
+ * @throws NullPointerException If {@code timeToExpire} or {@code expiryRelativeTo} is null.
*/
public FileScheduleDeletionOptions(Duration timeToExpire, FileExpirationOffset expiryRelativeTo) {
StorageImplUtils.assertNotNull("timeToExpire", timeToExpire);
@@ -45,6 +46,7 @@ public FileScheduleDeletionOptions(Duration timeToExpire, FileExpirationOffset e
/**
* Sets the {@link OffsetDateTime} when the file will be deleted.
* @param expiresOn The {@link OffsetDateTime} when the file will be deleted.
+ * @throws NullPointerException If {@code expiresOn} is null.
*/
public FileScheduleDeletionOptions(OffsetDateTime expiresOn) {
StorageImplUtils.assertNotNull("expiresOn", expiresOn);
@@ -54,6 +56,8 @@ public FileScheduleDeletionOptions(OffsetDateTime expiresOn) {
}
/**
+ * Gets the duration before the file will be deleted.
+ *
* @return Duration before file should be deleted.
*/
public Duration getTimeToExpire() {
@@ -61,16 +65,18 @@ public Duration getTimeToExpire() {
}
/**
- * @return if {@link #getTimeToExpire()} should be
- * set relative to the file's creation time, or the current time.
+ * Gets the offset to set the expiry time relative to.
+ *
+ * @return if {@link #getTimeToExpire()} should be set relative to the file's creation time, or the current time.
*/
public FileExpirationOffset getExpiryRelativeTo() {
return expiryRelativeTo;
}
/**
- * @return The {@link OffsetDateTime} to set for when
- * the file will be deleted.
+ * Gets the {@link OffsetDateTime} to set for when the file will be deleted.
+ *
+ * @return The {@link OffsetDateTime} to set for when the file will be deleted.
*/
public OffsetDateTime getExpiresOn() {
return expiresOn;
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileSystemEncryptionScopeOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileSystemEncryptionScopeOptions.java
index bd683b0e9a1a5..dfba5e7d55dce 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileSystemEncryptionScopeOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileSystemEncryptionScopeOptions.java
@@ -14,7 +14,6 @@
* Encryption scope options to be used when creating a file system.
*/
public final class FileSystemEncryptionScopeOptions implements JsonSerializable {
-
/*
* Optional. Version 2021-06-08 and later. Specifies the default
* encryption scope to set on the container and use for all future writes.
@@ -28,6 +27,12 @@ public final class FileSystemEncryptionScopeOptions implements JsonSerializable<
*/
private Boolean encryptionScopeOverridePrevented;
+ /**
+ * Creates a new instance of {@link FileSystemEncryptionScopeOptions}.
+ */
+ public FileSystemEncryptionScopeOptions() {
+ }
+
/**
* Get the defaultEncryptionScope property: Optional. Version 2021-06-08 and later. Specifies the default encryption
* scope to set on the file system and use for all future writes.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileSystemRenameOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileSystemRenameOptions.java
index c9fbf98af3d23..8f7d0dbda208b 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileSystemRenameOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileSystemRenameOptions.java
@@ -13,7 +13,6 @@
*/
@Fluent
class FileSystemRenameOptions {
-
private final String destinationFileSystemName;
private DataLakeRequestConditions requestConditions;
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileSystemUndeleteOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileSystemUndeleteOptions.java
index 251eaa8e0f7f6..5f55103038530 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileSystemUndeleteOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/FileSystemUndeleteOptions.java
@@ -20,6 +20,7 @@ public final class FileSystemUndeleteOptions {
*
* @param deletedFileSystemName The name of the previously deleted file system.
* @param deletedFileSystemVersion The version of the previously deleted file system.
+ * @throws NullPointerException If {@code deletedFileSystemName} or {@code deletedFileSystemVersion} is null.
*/
public FileSystemUndeleteOptions(String deletedFileSystemName, String deletedFileSystemVersion) {
StorageImplUtils.assertNotNull("deletedFileSystemName", deletedFileSystemName);
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathGetPropertiesOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathGetPropertiesOptions.java
index ad253933faf96..f1bb3f147afb7 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathGetPropertiesOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathGetPropertiesOptions.java
@@ -14,6 +14,14 @@ public class PathGetPropertiesOptions {
private Boolean userPrincipalName;
/**
+ * Creates a new instance of {@link PathGetPropertiesOptions}.
+ */
+ public PathGetPropertiesOptions() {
+ }
+
+ /**
+ * Gets the {@link DataLakeRequestConditions}.
+ *
* @return {@link DataLakeRequestConditions}
*/
public DataLakeRequestConditions getRequestConditions() {
@@ -21,6 +29,8 @@ public DataLakeRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link DataLakeRequestConditions}.
+ *
* @param requestConditions {@link DataLakeRequestConditions}
* @return The updated options.
*/
@@ -30,6 +40,8 @@ public PathGetPropertiesOptions setRequestConditions(DataLakeRequestConditions r
}
/**
+ * Gets the value for the x-ms-upn header.
+ *
* @return The value for the x-ms-upn header.
*/
public Boolean isUserPrincipalName() {
@@ -37,6 +49,8 @@ public Boolean isUserPrincipalName() {
}
/**
+ * Sets the value for the x-ms-upn header.
+ *
* @param userPrincipalName The value for the x-ms-upn header.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathRemoveAccessControlRecursiveOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathRemoveAccessControlRecursiveOptions.java
index 194716212c5a3..e3b441a1ee813 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathRemoveAccessControlRecursiveOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathRemoveAccessControlRecursiveOptions.java
@@ -25,6 +25,7 @@ public class PathRemoveAccessControlRecursiveOptions {
/**
* Constructs a new options object.
* @param accessControlList The POSIX access control list for the file or directory.
+ * @throws NullPointerException If {@code accessControlList} is null.
*/
public PathRemoveAccessControlRecursiveOptions(List accessControlList) {
StorageImplUtils.assertNotNull("accessControllList", accessControlList);
@@ -71,7 +72,7 @@ public PathRemoveAccessControlRecursiveOptions setBatchSize(Integer batchSize) {
*
* If maximum is reached before all subpaths are processed then continuation token can be used to resume operation.
* Empty value indicates that maximum number of batches in unbound and operation continues till end. Operation may
- * * also halt if an error is hit and {@code continueOnFailure} is false.
+ * also halt if an error is hit and {@code continueOnFailure} is false.
*
* @return The maximum number of batches.
*/
@@ -84,7 +85,7 @@ public Integer getMaxBatches() {
*
* If maximum is reached before all subpaths are processed then continuation token can be used to resume operation.
* Empty value indicates that maximum number of batches in unbound and operation continues till end. Operation may
- * * also halt if an error is hit and {@code continueOnFailure} is false.
+ * also halt if an error is hit and {@code continueOnFailure} is false.
*
* @param maxBatches The maximum number of batches.
* @return The updated object.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathSetAccessControlRecursiveOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathSetAccessControlRecursiveOptions.java
index 7ed3f57cf2d99..28a56c4c12993 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathSetAccessControlRecursiveOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathSetAccessControlRecursiveOptions.java
@@ -25,6 +25,7 @@ public class PathSetAccessControlRecursiveOptions {
/**
* Constructs a new options object.
* @param accessControlList The POSIX access control list for the file or directory.
+ * @throws NullPointerException If {@code accessControlList} is null.
*/
public PathSetAccessControlRecursiveOptions(List accessControlList) {
StorageImplUtils.assertNotNull("accessControllList", accessControlList);
@@ -71,7 +72,7 @@ public PathSetAccessControlRecursiveOptions setBatchSize(Integer batchSize) {
*
* If maximum is reached before all subpaths are processed then continuation token can be used to resume operation.
* Empty value indicates that maximum number of batches in unbound and operation continues till end. Operation may
- * * also halt if an error is hit and {@code continueOnFailure} is false.
+ * also halt if an error is hit and {@code continueOnFailure} is false.
*
* @return The maximum number of batches.
*/
@@ -84,7 +85,7 @@ public Integer getMaxBatches() {
*
* If maximum is reached before all subpaths are processed then continuation token can be used to resume operation.
* Empty value indicates that maximum number of batches in unbound and operation continues till end. Operation may
- * * also halt if an error is hit and {@code continueOnFailure} is false.
+ * also halt if an error is hit and {@code continueOnFailure} is false.
*
* @param maxBatches The maximum number of batches.
* @return The updated object.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathUpdateAccessControlRecursiveOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathUpdateAccessControlRecursiveOptions.java
index 0495f62fcbc9b..6cd538518092f 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathUpdateAccessControlRecursiveOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/PathUpdateAccessControlRecursiveOptions.java
@@ -25,6 +25,7 @@ public class PathUpdateAccessControlRecursiveOptions {
/**
* Constructs a new options object.
* @param accessControlList The POSIX access control list for the file or directory.
+ * @throws NullPointerException If {@code accessControlList} is null.
*/
public PathUpdateAccessControlRecursiveOptions(List accessControlList) {
StorageImplUtils.assertNotNull("accessControllList", accessControlList);
@@ -84,7 +85,7 @@ public Integer getMaxBatches() {
*
* If maximum is reached before all subpaths are processed then continuation token can be used to resume operation.
* Empty value indicates that maximum number of batches in unbound and operation continues till end. Operation may
- * * also halt if an error is hit and {@code continueOnFailure} is false.
+ * also halt if an error is hit and {@code continueOnFailure} is false.
*
* @param maxBatches The maximum number of batches.
* @return The updated object.
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/ReadToFileOptions.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/ReadToFileOptions.java
index 648be9f88748a..28006b6466c1e 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/ReadToFileOptions.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/options/ReadToFileOptions.java
@@ -31,6 +31,7 @@ public class ReadToFileOptions {
* Constructs a {@link ReadToFileOptions}.
*
* @param filePath Path of the file to download to.
+ * @throws NullPointerException If {@code filePath} is null.
*/
public ReadToFileOptions(String filePath) {
StorageImplUtils.assertNotNull("filePath", filePath);
@@ -38,13 +39,17 @@ public ReadToFileOptions(String filePath) {
}
/**
- * @return A {@link String} representing the filePath where the downloaded data will be written.
+ * Gets the path of the file to download to.
+ *
+ * @return The path where the downloaded data will be written.
*/
public String getFilePath() {
return filePath;
}
/**
+ * Gets the {@link FileRange}.
+ *
* @return {@link FileRange}
*/
public FileRange getRange() {
@@ -52,6 +57,8 @@ public FileRange getRange() {
}
/**
+ * Sets the {@link FileRange}.
+ *
* @param range {@link FileRange}
* @return The updated options.
*/
@@ -61,14 +68,20 @@ public ReadToFileOptions setRange(FileRange range) {
}
/**
- * @return {@link ParallelTransferOptions} to use to download to file. Number of parallel
- * transfers parameter is ignored.
+ * Gets the {@link ParallelTransferOptions} to use to download to file. Number of parallel transfers parameter is
+ * ignored.
+ *
+ * @return {@link ParallelTransferOptions} to use to download to file. Number of parallel transfers parameter is
+ * ignored.
*/
public ParallelTransferOptions getParallelTransferOptions() {
return parallelTransferOptions;
}
/**
+ * Sets the {@link ParallelTransferOptions} to use to download to file. Number of parallel transfers parameter is
+ * ignored.
+ *
* @param parallelTransferOptions {@link ParallelTransferOptions} to use to download to file. Number of parallel
* transfers parameter is ignored.
* @return The updated options.
@@ -79,6 +92,8 @@ public ReadToFileOptions setParallelTransferOptions(ParallelTransferOptions para
}
/**
+ * Gets the {@link DownloadRetryOptions}.
+ *
* @return {@link DownloadRetryOptions}
*/
public DownloadRetryOptions getDownloadRetryOptions() {
@@ -86,6 +101,8 @@ public DownloadRetryOptions getDownloadRetryOptions() {
}
/**
+ * Sets the {@link DownloadRetryOptions}.
+ *
* @param downloadRetryOptions {@link DownloadRetryOptions}
* @return The updated options.
*/
@@ -95,6 +112,8 @@ public ReadToFileOptions setDownloadRetryOptions(DownloadRetryOptions downloadRe
}
/**
+ * Gets the {@link DataLakeRequestConditions}.
+ *
* @return requestConditions {@link DataLakeRequestConditions}
*/
public DataLakeRequestConditions getDataLakeRequestConditions() {
@@ -102,6 +121,8 @@ public DataLakeRequestConditions getDataLakeRequestConditions() {
}
/**
+ * Sets the {@link DataLakeRequestConditions}.
+ *
* @param dataLakeRequestConditions {@link DataLakeRequestConditions}
* @return The updated options.
* @throws UncheckedIOException If an I/O error occurs.
@@ -112,6 +133,8 @@ public ReadToFileOptions setDataLakeRequestConditions(DataLakeRequestConditions
}
/**
+ * Gets whether the contentMD5 for the specified file range should be returned.
+ *
* @return Whether the contentMD5 for the specified file range should be returned.
*/
public Boolean isRangeGetContentMd5() {
@@ -119,6 +142,8 @@ public Boolean isRangeGetContentMd5() {
}
/**
+ * Sets whether the contentMD5 for the specified file range should be returned.
+ *
* @param rangeGetContentMd5 Whether the contentMD5 for the specified file range should be returned.
* @return The updated options.
*/
@@ -128,6 +153,8 @@ public ReadToFileOptions setRangeGetContentMd5(Boolean rangeGetContentMd5) {
}
/**
+ * Gets the {@link OpenOption OpenOptions} to use to configure how to open or create the file.
+ *
* @return {@link OpenOption OpenOptions} to use to configure how to open or create the file.
*/
public Set getOpenOptions() {
@@ -135,6 +162,8 @@ public Set getOpenOptions() {
}
/**
+ * Sets the {@link OpenOption OpenOptions} to use to configure how to open or create the file.
+ *
* @param openOptions {@link OpenOption OpenOptions} to use to configure how to open or create the file.
* @return The updated options.
*/
@@ -144,6 +173,8 @@ public ReadToFileOptions setOpenOptions(Set openOptions) {
}
/**
+ * Gets the value for the x-ms-upn header.
+ *
* @return The value for the x-ms-upn header.
*/
public Boolean isUserPrincipalName() {
@@ -151,6 +182,8 @@ public Boolean isUserPrincipalName() {
}
/**
+ * Sets the value for the x-ms-upn header.
+ *
* @param userPrincipalName The value for the x-ms-upn header.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/sas/DataLakeServiceSasSignatureValues.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/sas/DataLakeServiceSasSignatureValues.java
index bee1c2b9c62b2..5177240086e52 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/sas/DataLakeServiceSasSignatureValues.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/sas/DataLakeServiceSasSignatureValues.java
@@ -26,38 +26,23 @@
* User Delegation SAS
*/
public final class DataLakeServiceSasSignatureValues {
-
private static final String VERSION = Configuration.getGlobalConfiguration()
.get(Constants.PROPERTY_AZURE_STORAGE_SAS_SERVICE_VERSION, DataLakeServiceVersion.getLatest().getVersion());
private SasProtocol protocol;
-
private OffsetDateTime startTime;
-
private OffsetDateTime expiryTime;
-
private String permissions;
-
private SasIpRange sasIpRange;
-
private String identifier;
-
private String cacheControl;
-
private String contentDisposition;
-
private String contentEncoding;
-
private String contentLanguage;
-
private String contentType;
-
private String preauthorizedAgentObjectId; /* saoid */
-
private String agentObjectId; /* suoid */
-
private String correlationId;
-
private String encryptionScope;
/**
@@ -98,6 +83,9 @@ public DataLakeServiceSasSignatureValues(String identifier) {
}
/**
+ * Gets the version of the service this SAS will target. If not specified, it will default to the version targeted
+ * by the library.
+ *
* @return the version of the service this SAS will target. If not specified, it will default to the version
* targeted by the library.
*/
@@ -121,6 +109,8 @@ public DataLakeServiceSasSignatureValues setVersion(String version) {
}
/**
+ * Gets the {@link SasProtocol} which determines the protocols allowed by the SAS.
+ *
* @return the {@link SasProtocol} which determines the protocols allowed by the SAS.
*/
public SasProtocol getProtocol() {
@@ -139,6 +129,8 @@ public DataLakeServiceSasSignatureValues setProtocol(SasProtocol protocol) {
}
/**
+ * Gets when the SAS will take effect.
+ *
* @return when the SAS will take effect.
*/
public OffsetDateTime getStartTime() {
@@ -157,6 +149,8 @@ public DataLakeServiceSasSignatureValues setStartTime(OffsetDateTime startTime)
}
/**
+ * Gets the time after which the SAS will no longer work.
+ *
* @return the time after which the SAS will no longer work.
*/
public OffsetDateTime getExpiryTime() {
@@ -175,6 +169,9 @@ public DataLakeServiceSasSignatureValues setExpiryTime(OffsetDateTime expiryTime
}
/**
+ * Gets the permissions string allowed by the SAS. Please refer to either {@link FileSystemSasPermission} or
+ * {@link PathSasPermission} depending on the resource being accessed for help determining the permissions allowed.
+ *
* @return the permissions string allowed by the SAS. Please refer to either {@link FileSystemSasPermission} or
* {@link PathSasPermission} depending on the resource being accessed for help determining the permissions allowed.
*/
@@ -209,6 +206,8 @@ public DataLakeServiceSasSignatureValues setPermissions(FileSystemSasPermission
}
/**
+ * Gets the {@link SasIpRange} which determines the IP ranges that are allowed to use the SAS.
+ *
* @return the {@link SasIpRange} which determines the IP ranges that are allowed to use the SAS.
*/
public SasIpRange getSasIpRange() {
@@ -228,6 +227,10 @@ public DataLakeServiceSasSignatureValues setSasIpRange(SasIpRange sasIpRange) {
}
/**
+ * Gets the name of the access policy on the file system this SAS references if any. Please see
+ * here
+ * for more information.
+ *
* @return the name of the access policy on the file system this SAS references if any. Please see
* here
* for more information.
@@ -250,6 +253,8 @@ public DataLakeServiceSasSignatureValues setIdentifier(String identifier) {
}
/**
+ * Gets the cache-control header for the SAS.
+ *
* @return the cache-control header for the SAS.
*/
public String getCacheControl() {
@@ -268,6 +273,8 @@ public DataLakeServiceSasSignatureValues setCacheControl(String cacheControl) {
}
/**
+ * Gets the content-disposition header for the SAS.
+ *
* @return the content-disposition header for the SAS.
*/
public String getContentDisposition() {
@@ -286,6 +293,8 @@ public DataLakeServiceSasSignatureValues setContentDisposition(String contentDis
}
/**
+ * Gets the content-encoding header for the SAS.
+ *
* @return the content-encoding header for the SAS.
*/
public String getContentEncoding() {
@@ -304,6 +313,8 @@ public DataLakeServiceSasSignatureValues setContentEncoding(String contentEncodi
}
/**
+ * Gets the content-language header for the SAS.
+ *
* @return the content-language header for the SAS.
*/
public String getContentLanguage() {
@@ -322,6 +333,8 @@ public DataLakeServiceSasSignatureValues setContentLanguage(String contentLangua
}
/**
+ * Gets the content-type header for the SAS.
+ *
* @return the content-type header for the SAS.
*/
public String getContentType() {
@@ -340,6 +353,9 @@ public DataLakeServiceSasSignatureValues setContentType(String contentType) {
}
/**
+ * Gets the AAD object ID of a user assumed to be authorized by the owner of the user delegation key to perform the
+ * action granted by the SAS token.
+ *
* @return The AAD object ID of a user assumed to be authorized by the owner of the user delegation key to perform
* the action granted by the SAS token. The service will validate the SAS token and ensure that the owner of the
* user delegation key has the required permissions before granting access but no additional permission check for
@@ -365,6 +381,9 @@ public DataLakeServiceSasSignatureValues setPreauthorizedAgentObjectId(String pr
}
/**
+ * Gets the AAD object ID of a user assumed to be unauthorized by the owner of the user delegation key to perform
+ * the action granted by the SAS token.
+ *
* @return The AAD object ID of a user assumed to be unauthorized by the owner of the user delegation key to
* perform the action granted by the SAS token. The service will validate the SAS token and ensure that the owner
* of the user delegation key has the required permissions before granting access and the service will perform an
@@ -390,6 +409,8 @@ public DataLakeServiceSasSignatureValues setAgentObjectId(String agentObjectId)
}
/**
+ * Gets the correlation id value for the SAS.
+ *
* @return the correlation id value for the SAS.
*/
public String getCorrelationId() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/sas/FileSystemSasPermission.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/sas/FileSystemSasPermission.java
index 8c99fd2b719f8..b6e53bfeed4ed 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/sas/FileSystemSasPermission.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/sas/FileSystemSasPermission.java
@@ -15,23 +15,14 @@
*/
public final class FileSystemSasPermission {
private boolean readPermission;
-
private boolean addPermission;
-
private boolean createPermission;
-
private boolean writePermission;
-
private boolean deletePermission;
-
private boolean listPermission;
-
private boolean movePermission;
-
private boolean executePermission;
-
private boolean manageOwnershipPermission;
-
private boolean manageAccessControlPermission;
/**
@@ -104,6 +95,8 @@ public static FileSystemSasPermission parse(String permissionString) {
}
/**
+ * Gets the read permission status.
+ *
* @return the read permission status
*/
public boolean hasReadPermission() {
@@ -122,6 +115,8 @@ public FileSystemSasPermission setReadPermission(boolean hasReadPermission) {
}
/**
+ * Gets the add permission status.
+ *
* @return the add permission status
*/
public boolean hasAddPermission() {
@@ -140,6 +135,8 @@ public FileSystemSasPermission setAddPermission(boolean hasAddPermission) {
}
/**
+ * Gets the create permission status.
+ *
* @return the create permission status
*/
public boolean hasCreatePermission() {
@@ -158,6 +155,8 @@ public FileSystemSasPermission setCreatePermission(boolean hasCreatePermission)
}
/**
+ * Gets the write permission status.
+ *
* @return the write permission status
*/
public boolean hasWritePermission() {
@@ -176,6 +175,8 @@ public FileSystemSasPermission setWritePermission(boolean hasWritePermission) {
}
/**
+ * Gets the delete permission status.
+ *
* @return the delete permission status
*/
public boolean hasDeletePermission() {
@@ -194,6 +195,8 @@ public FileSystemSasPermission setDeletePermission(boolean hasDeletePermission)
}
/**
+ * Gets the list permission status.
+ *
* @return the list permission status
*/
public boolean hasListPermission() {
@@ -212,6 +215,8 @@ public FileSystemSasPermission setListPermission(boolean hasListPermission) {
}
/**
+ * Gets the move permission status.
+ *
* @return the move permission status.
*/
public boolean hasMovePermission() {
@@ -230,6 +235,8 @@ public FileSystemSasPermission setMovePermission(boolean hasMovePermission) {
}
/**
+ * Gets the execute permission status.
+ *
* @return the execute permission status.
*/
public boolean hasExecutePermission() {
@@ -248,6 +255,8 @@ public FileSystemSasPermission setExecutePermission(boolean hasExecutePermission
}
/**
+ * Gets the manage ownership permission status.
+ *
* @return the manage ownership permission status.
*/
public boolean hasManageOwnershipPermission() {
@@ -266,6 +275,8 @@ public FileSystemSasPermission setManageOwnershipPermission(boolean hasManageOwn
}
/**
+ * Gets the manage access control permission status.
+ *
* @return the manage access control permission status.
*/
public boolean hasManageAccessControlPermission() {
diff --git a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/sas/PathSasPermission.java b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/sas/PathSasPermission.java
index db30565378154..8f1d1a3664608 100644
--- a/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/sas/PathSasPermission.java
+++ b/sdk/storage/azure-storage-file-datalake/src/main/java/com/azure/storage/file/datalake/sas/PathSasPermission.java
@@ -14,25 +14,15 @@
* this class guarantees correctness.
*/
public final class PathSasPermission {
-
private boolean readPermission;
-
private boolean addPermission;
-
private boolean createPermission;
-
private boolean writePermission;
-
private boolean deletePermission;
-
private boolean listPermission;
-
private boolean movePermission;
-
private boolean executePermission;
-
private boolean manageOwnershipPermission;
-
private boolean manageAccessControlPermission;
/**
@@ -105,6 +95,8 @@ public static PathSasPermission parse(String permissionString) {
}
/**
+ * Gets the read permission status.
+ *
* @return the read permission status.
*/
public boolean hasReadPermission() {
@@ -123,6 +115,8 @@ public PathSasPermission setReadPermission(boolean hasReadPermission) {
}
/**
+ * Gets the add permission status.
+ *
* @return the add permission status.
*/
public boolean hasAddPermission() {
@@ -141,6 +135,8 @@ public PathSasPermission setAddPermission(boolean hasAddPermission) {
}
/**
+ * Gets the create permission status.
+ *
* @return the create permission status.
*/
public boolean hasCreatePermission() {
@@ -159,6 +155,8 @@ public PathSasPermission setCreatePermission(boolean hasCreatePermission) {
}
/**
+ * Gets the write permission status.
+ *
* @return the write permission status.
*/
public boolean hasWritePermission() {
@@ -177,6 +175,8 @@ public PathSasPermission setWritePermission(boolean hasWritePermission) {
}
/**
+ * Gets the delete permission status.
+ *
* @return the delete permission status.
*/
public boolean hasDeletePermission() {
@@ -195,6 +195,8 @@ public PathSasPermission setDeletePermission(boolean hasDeletePermission) {
}
/**
+ * Gets the list permission status.
+ *
* @return the list permission status.
*/
public boolean hasListPermission() {
@@ -213,6 +215,8 @@ public PathSasPermission setListPermission(boolean hasListPermission) {
}
/**
+ * Gets the move permission status.
+ *
* @return the move permission status.
*/
public boolean hasMovePermission() {
@@ -231,6 +235,8 @@ public PathSasPermission setMovePermission(boolean hasMovePermission) {
}
/**
+ * Gets the execute permission status.
+ *
* @return the execute permission status.
*/
public boolean hasExecutePermission() {
@@ -249,6 +255,8 @@ public PathSasPermission setExecutePermission(boolean hasExecutePermission) {
}
/**
+ * Gets the manage ownership permission status.
+ *
* @return the manage ownership permission status.
*/
public boolean hasManageOwnershipPermission() {
@@ -267,6 +275,8 @@ public PathSasPermission setManageOwnershipPermission(boolean hasManageOwnership
}
/**
+ * Gets the manage access control permission status.
+ *
* @return the manage access control permission status.
*/
public boolean hasManageAccessControlPermission() {
diff --git a/sdk/storage/azure-storage-file-share/pom.xml b/sdk/storage/azure-storage-file-share/pom.xml
index d51c2148e1259..599fb0870e9a3 100644
--- a/sdk/storage/azure-storage-file-share/pom.xml
+++ b/sdk/storage/azure-storage-file-share/pom.xml
@@ -60,7 +60,6 @@
com.azure.json,com.azure.xml,com.azure.core.*
${basedir}/src/main/java:${basedir}/../../core/azure-core/src/main/java:${basedir}/../../serialization/azure-json/src/main/java:${basedir}/../../serialization/azure-xml/src/main/java
- -
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/FileConstants.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/FileConstants.java
index 2761a77b47b60..5a3179a178ec8 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/FileConstants.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/FileConstants.java
@@ -7,6 +7,12 @@
* Holds the Constants used for the File Service.
*/
public final class FileConstants {
+ /**
+ * Creates a new instance of {@link FileConstants}.
+ */
+ public FileConstants() {
+ }
+
/**
* Default header value for file permission.
*/
@@ -69,7 +75,7 @@ static final class HeaderConstants {
public static final String FILE_ID = "x-ms-file-id";
/**
- * Header that spcifies file parent id.
+ * Header that specifies file parent id.
*/
public static final String FILE_PARENT_ID = "x-ms-file-parent-id";
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/FileSmbProperties.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/FileSmbProperties.java
index 6c9dcd917d26f..3ae99da78cb34 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/FileSmbProperties.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/FileSmbProperties.java
@@ -15,7 +15,6 @@
* A class used to represent the SMB properties of a file.
*/
public class FileSmbProperties {
-
private String filePermissionKey;
private EnumSet ntfsFileAttributes;
private OffsetDateTime fileCreationTime;
@@ -34,6 +33,8 @@ public FileSmbProperties() {
}
/**
+ * Gets the file's permission key.
+ *
* @return The file's permission key.
*/
public String getFilePermissionKey() {
@@ -41,6 +42,8 @@ public String getFilePermissionKey() {
}
/**
+ * Gets the file's {@link NtfsFileAttributes}.
+ *
* @return The file's {@link NtfsFileAttributes}.
*/
public EnumSet getNtfsFileAttributes() {
@@ -48,6 +51,8 @@ public EnumSet getNtfsFileAttributes() {
}
/**
+ * Gets the file's creation time.
+ *
* @return The file's creation time.
*/
public OffsetDateTime getFileCreationTime() {
@@ -55,6 +60,8 @@ public OffsetDateTime getFileCreationTime() {
}
/**
+ * Gets the file's last write time.
+ *
* @return The file's last write time.
*/
public OffsetDateTime getFileLastWriteTime() {
@@ -62,6 +69,8 @@ public OffsetDateTime getFileLastWriteTime() {
}
/**
+ * Gets the file's change time.
+ *
* @return The file's change time.
*/
public OffsetDateTime getFileChangeTime() {
@@ -69,6 +78,8 @@ public OffsetDateTime getFileChangeTime() {
}
/**
+ * Gets the file's ID.
+ *
* @return The file's ID.
*/
public String getFileId() {
@@ -76,6 +87,8 @@ public String getFileId() {
}
/**
+ * Gets the file's parent ID.
+ *
* @return The file's parent ID.
*/
public String getParentId() {
@@ -220,11 +233,6 @@ static String parseFileSMBDate(OffsetDateTime time) {
}
static {
- FileSmbPropertiesHelper.setAccessor(new FileSmbPropertiesHelper.FileSmbPropertiesAccessor() {
- @Override
- public FileSmbProperties create(HttpHeaders httpHeaders) {
- return new FileSmbProperties(httpHeaders);
- }
- });
+ FileSmbPropertiesHelper.setAccessor(FileSmbProperties::new);
}
}
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/DownloadRetryOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/DownloadRetryOptions.java
index d01394495c5b8..a3c921ae09757 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/DownloadRetryOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/DownloadRetryOptions.java
@@ -19,12 +19,18 @@ public final class DownloadRetryOptions {
private static final ClientLogger LOGGER = new ClientLogger(DownloadRetryOptions.class);
/*
- We use "retry" here because by the time the user passes this type, the initial request, or try, has already been
- issued and returned. This is in contrast to the retry policy options, which includes the initial try in its count,
- thus the difference in verbiage.
+ * We use "retry" here because by the time the user passes this type, the initial request, or try, has already been
+ * issued and returned. This is in contrast to the retry policy options, which includes the initial try in its
+ * count, thus the difference in verbiage.
*/
private int maxRetryRequests = 5;
+ /**
+ * Creates a new instance of {@link DownloadRetryOptions}.
+ */
+ public DownloadRetryOptions() {
+ }
+
/**
* Specifies the maximum number of additional HTTP Get requests that will be made while reading the data from a
* response body.
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ListSharesOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ListSharesOptions.java
index 1cad82449288a..a809630f4f14f 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ListSharesOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ListSharesOptions.java
@@ -40,6 +40,12 @@ public final class ListSharesOptions {
private boolean includeSnapshots;
private boolean includeDeleted;
+ /**
+ * Creates a new instance of {@link ListSharesOptions}.
+ */
+ public ListSharesOptions() {
+ }
+
/**
* Sets the prefix that a share must match to be included in the listing.
*
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/Range.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/Range.java
index 7ebc5f84254da..32b8a9695a622 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/Range.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/Range.java
@@ -29,6 +29,12 @@ public final class Range implements XmlSerializable {
*/
private long end;
+ /**
+ * Creates a new instance of the Range class.
+ */
+ public Range() {
+ }
+
/**
* Get the start property: Start of the range.
*
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ShareFilePermission.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ShareFilePermission.java
index 03fc4ecc8b810..efcb009b76211 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ShareFilePermission.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ShareFilePermission.java
@@ -17,6 +17,12 @@ public class ShareFilePermission {
*/
private String permission;
+ /**
+ * Creates a new instance of {@link ShareFilePermission}.
+ */
+ public ShareFilePermission() {
+ }
+
/**
* Get the format of file permission.
*
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ShareItem.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ShareItem.java
index c76a5ce0ed532..8d5dedd976b7d 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ShareItem.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ShareItem.java
@@ -51,6 +51,12 @@ public final class ShareItem implements XmlSerializable {
*/
private Map metadata;
+ /**
+ * Creates an instance of ShareItem.
+ */
+ public ShareItem() {
+ }
+
/**
* Get the name property: The name property.
*
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ShareProperties.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ShareProperties.java
index 6ef443ff34e64..1aa3056540334 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ShareProperties.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/models/ShareProperties.java
@@ -162,6 +162,12 @@ public final class ShareProperties implements XmlSerializable {
*/
private OffsetDateTime nextAllowedProvisionedBandwidthDowngradeTime;
+ /**
+ * Creates a new instance of {@link ShareProperties}.
+ */
+ public ShareProperties() {
+ }
+
/**
* Get the lastModified property: The lastModified property.
*
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareCreateOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareCreateOptions.java
index 4217e9e1da8ee..8c07e9870bd08 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareCreateOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareCreateOptions.java
@@ -137,7 +137,8 @@ public ShareCreateOptions setRootSquash(ShareRootSquash rootSquash) {
/**
* Get the enableSnapshotVirtualDirectoryAccess property: The EnableSnapshotVirtualDirectoryAccess property.
* Optional. Supported in version 2023-08-03 and above. Only applicable for premium file storage accounts.
- * Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled.
+ * Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS
+ * is enabled.
* If not specified, the default is true.
* @return the enableSnapshotVirtualDirectoryAccess value.
*/
@@ -148,7 +149,8 @@ public Boolean isSnapshotVirtualDirectoryAccessEnabled() {
/**
* Set the enableSnapshotVirtualDirectoryAccess property:
* Optional. Supported in version 2023-08-03 and above. Only applicable for premium file storage accounts.
- * Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled.
+ * Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS
+ * is enabled.
* If not specified, the default is true.
* @param snapshotVirtualDirectoryAccessEnabled the enableSnapshotVirtualDirectoryAccess value to set.
* @return the ShareCreateOptions object itself.
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareDirectorySetPropertiesOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareDirectorySetPropertiesOptions.java
index 559301c69961f..d3d5eac2b25d4 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareDirectorySetPropertiesOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareDirectorySetPropertiesOptions.java
@@ -15,6 +15,14 @@ public class ShareDirectorySetPropertiesOptions {
private ShareFilePermission filePermissions;
/**
+ * Creates a new instance of {@link ShareDirectorySetPropertiesOptions}.
+ */
+ public ShareDirectorySetPropertiesOptions() {
+ }
+
+ /**
+ * Gets the optional SMB properties to set on the destination file or directory.
+ *
* @return Optional SMB properties to set on the destination file or directory. The only properties that are
* considered are file attributes, file creation time, file last write time, and file permission key. The rest are
* ignored.
@@ -24,6 +32,8 @@ public FileSmbProperties getSmbProperties() {
}
/**
+ * Sets the optional SMB properties to set on the destination file or directory.
+ *
* @param smbProperties Optional SMB properties to set on the destination file or directory. The only properties
* that are considered are file attributes, file creation time, file last write time, and file permission key. The
* rest are ignored.
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileCreateOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileCreateOptions.java
index dc3021cb4a0f6..bddc32347af46 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileCreateOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileCreateOptions.java
@@ -25,6 +25,8 @@ public class ShareFileCreateOptions {
private ShareRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link ShareFileCreateOptions}.
+ *
* @param size Specifies the maximum size for the file share.
*/
public ShareFileCreateOptions(long size) {
@@ -32,6 +34,8 @@ public ShareFileCreateOptions(long size) {
}
/**
+ * Gets the maximum size for the file share.
+ *
* @return Specifies the maximum size for the file share.
*/
public long getSize() {
@@ -39,6 +43,8 @@ public long getSize() {
}
/**
+ * Gets the file's http headers.
+ *
* @return the file's http headers.
*/
public ShareFileHttpHeaders getShareFileHttpHeaders() {
@@ -47,6 +53,7 @@ public ShareFileHttpHeaders getShareFileHttpHeaders() {
/**
* Sets the file's http headers.
+ *
* @param headers the http headers.
* @return the updated options.
*/
@@ -56,6 +63,8 @@ public ShareFileCreateOptions setShareFileHttpHeaders(ShareFileHttpHeaders heade
}
/**
+ * Gets the optional SMB properties to set on the destination file or directory.
+ *
* @return Optional SMB properties to set on the destination file or directory. The only properties that are
* considered are file attributes, file creation time, file last write time, and file permission key. The rest are
* ignored.
@@ -65,6 +74,8 @@ public FileSmbProperties getSmbProperties() {
}
/**
+ * Sets the optional SMB properties to set on the destination file or directory.
+ *
* @param smbProperties Optional SMB properties to set on the destination file or directory. The only properties
* that are considered are file attributes, file creation time, file last write time, and file permission key. The
* rest are ignored.
@@ -76,6 +87,8 @@ public ShareFileCreateOptions setSmbProperties(FileSmbProperties smbProperties)
}
/**
+ * Gets the metadata to associate with the share.
+ *
* @return Metadata to associate with the share
*/
public Map getMetadata() {
@@ -83,6 +96,8 @@ public Map getMetadata() {
}
/**
+ * Sets the metadata to associate with the share.
+ *
* @param metadata Metadata to associate with the share. If there is leading or trailing whitespace in any
* metadata key or value, it must be removed or encoded.
* @return The updated options.
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileDownloadOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileDownloadOptions.java
index a5d5a858402ea..abd06ec0a4d9c 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileDownloadOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileDownloadOptions.java
@@ -13,13 +13,20 @@
*/
@Fluent
public final class ShareFileDownloadOptions {
-
private ShareFileRange range;
private Boolean rangeContentMd5Requested;
private ShareRequestConditions requestConditions;
private DownloadRetryOptions retryOptions;
/**
+ * Creates a new instance of {@link ShareFileDownloadOptions}.
+ */
+ public ShareFileDownloadOptions() {
+ }
+
+ /**
+ * Gets the range of bytes over which to list ranges, inclusively.
+ *
* @return The range of bytes over which to list ranges, inclusively.
*/
public ShareFileRange getRange() {
@@ -27,6 +34,8 @@ public ShareFileRange getRange() {
}
/**
+ * Sets the range of bytes over which to list ranges, inclusively.
+ *
* @param range The range of bytes over which to list ranges, inclusively.
* @return The updated options.
*/
@@ -36,14 +45,18 @@ public ShareFileDownloadOptions setRange(ShareFileRange range) {
}
/**
- * @return Whether or not the service returns the MD5 hash for the range.
+ * Gets whether the service returns the MD5 hash for the range.
+ *
+ * @return Whether the service returns the MD5 hash for the range.
*/
public Boolean isRangeContentMd5Requested() {
return rangeContentMd5Requested;
}
/**
- * @param rangeContentMd5Requested Whether or not the service returns the MD5 hash for the range.
+ * Sets whether the service returns the MD5 hash for the range.
+ *
+ * @param rangeContentMd5Requested Whether the service returns the MD5 hash for the range.
* @return The updated options.
*/
public ShareFileDownloadOptions setRangeContentMd5Requested(Boolean rangeContentMd5Requested) {
@@ -52,6 +65,8 @@ public ShareFileDownloadOptions setRangeContentMd5Requested(Boolean rangeContent
}
/**
+ * Gets the {@link ShareRequestConditions}.
+ *
* @return {@link ShareRequestConditions}
*/
public ShareRequestConditions getRequestConditions() {
@@ -59,6 +74,8 @@ public ShareRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link ShareRequestConditions} for the file.
+ *
* @param requestConditions {@link ShareRequestConditions} for the file.
* @return The updated options.
*/
@@ -68,6 +85,8 @@ public ShareFileDownloadOptions setRequestConditions(ShareRequestConditions requ
}
/**
+ * Gets the {@link DownloadRetryOptions}.
+ *
* @return {@link DownloadRetryOptions}
*/
public DownloadRetryOptions getRetryOptions() {
@@ -75,6 +94,8 @@ public DownloadRetryOptions getRetryOptions() {
}
/**
+ * Sets the {@link DownloadRetryOptions}.
+ *
* @param retryOptions {@link DownloadRetryOptions}
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileListRangesDiffOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileListRangesDiffOptions.java
index cec098d946c3e..546fe98f72b33 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileListRangesDiffOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileListRangesDiffOptions.java
@@ -13,16 +13,18 @@
*/
@Fluent
public class ShareFileListRangesDiffOptions {
-
private ShareFileRange range;
private final String previousSnapshot;
private ShareRequestConditions requestConditions;
private Boolean supportRename;
/**
+ * Creates a new instance of {@link ShareFileListRangesDiffOptions}.
+ *
* @param previousSnapshot Specifies that the response will contain only ranges that were changed between target
* file and previous snapshot. Changed ranges include both updated and cleared ranges. The target file may be a
* snapshot, as long as the snapshot specified by previousSnapshot is the older of the two.
+ * @throws NullPointerException If {@code previousSnapshot} is null.
*/
public ShareFileListRangesDiffOptions(String previousSnapshot) {
StorageImplUtils.assertNotNull("previousSnapshot", previousSnapshot);
@@ -30,6 +32,8 @@ public ShareFileListRangesDiffOptions(String previousSnapshot) {
}
/**
+ * Gets the range of bytes over which to list ranges, inclusively.
+ *
* @return The range of bytes over which to list ranges, inclusively.
*/
public ShareFileRange getRange() {
@@ -37,6 +41,8 @@ public ShareFileRange getRange() {
}
/**
+ * Sets the range of bytes over which to list ranges, inclusively.
+ *
* @param range The range of bytes over which to list ranges, inclusively.
* @return The updated options.
*/
@@ -46,6 +52,8 @@ public ShareFileListRangesDiffOptions setRange(ShareFileRange range) {
}
/**
+ * Gets the previous snapshot to compare to.
+ *
* @return The previous snapshot to compare to.
*/
public String getPreviousSnapshot() {
@@ -53,6 +61,8 @@ public String getPreviousSnapshot() {
}
/**
+ * Gets the {@link ShareRequestConditions}.
+ *
* @return {@link ShareRequestConditions}
*/
public ShareRequestConditions getRequestConditions() {
@@ -60,6 +70,8 @@ public ShareRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link ShareRequestConditions}.
+ *
* @param requestConditions {@link ShareRequestConditions} for the file.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileRenameOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileRenameOptions.java
index 1dc298368d2d6..9d770f7385ea3 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileRenameOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileRenameOptions.java
@@ -34,6 +34,7 @@ public final class ShareFileRenameOptions {
* Creates a {@code ShareFileRenameOptions} object.
*
* @param destinationPath Relative path from the share to rename the file to.
+ * @throws NullPointerException If {@code destinationPath} is null.
*/
public ShareFileRenameOptions(String destinationPath) {
StorageImplUtils.assertNotNull("destinationPath", destinationPath);
@@ -41,6 +42,8 @@ public ShareFileRenameOptions(String destinationPath) {
}
/**
+ * Gets the path to which the file should be renamed.
+ *
* @return The path to which the file should be renamed.
*/
public String getDestinationPath() {
@@ -48,6 +51,9 @@ public String getDestinationPath() {
}
/**
+ * Gets a boolean value which, if the destination file already exists, determines whether this request will
+ * overwrite the file or not.
+ *
* @return A boolean value which, if the destination file already exists, determines whether this
* request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file.
* If not provided or if false and the destination file does exist, the request will not overwrite the destination
@@ -58,6 +64,9 @@ public Boolean getReplaceIfExists() {
}
/**
+ * Sets a boolean value which, if the destination file already exists, determines whether this request will
+ * overwrite the file or not.
+ *
* @param replaceIfExists A boolean value which, if the destination file already exists, determines whether this
* request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file.
* If not provided or if false and the destination file does exist, the request will not overwrite the destination
@@ -70,6 +79,9 @@ public ShareFileRenameOptions setReplaceIfExists(Boolean replaceIfExists) {
}
/**
+ * Gets a boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be
+ * respected.
+ *
* @return A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be
* respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly
* attribute set will cause the rename to fail.
@@ -79,6 +91,9 @@ public Boolean isIgnoreReadOnly() {
}
/**
+ * Sets a boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be
+ * respected.
+ *
* @param ignoreReadOnly A boolean value that specifies whether the ReadOnly attribute on a preexisting destination
* file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with
* the ReadOnly attribute set will cause the rename to fail.
@@ -90,6 +105,8 @@ public ShareFileRenameOptions setIgnoreReadOnly(Boolean ignoreReadOnly) {
}
/**
+ * Gets the source request conditions. This parameter is only applicable if the source is a file.
+ *
* @return Source request conditions. This parameter is only applicable if the source is a file.
*/
public ShareRequestConditions getSourceRequestConditions() {
@@ -97,6 +114,8 @@ public ShareRequestConditions getSourceRequestConditions() {
}
/**
+ * Sets the source request conditions. This parameter is only applicable if the source is a file.
+ *
* @param sourceRequestConditions Source request conditions. This parameter is only applicable if the source is a
* file.
* @return The updated options.
@@ -107,6 +126,8 @@ public ShareFileRenameOptions setSourceRequestConditions(ShareRequestConditions
}
/**
+ * Gets the destination request conditions.
+ *
* @return The destination request conditions.
*/
public ShareRequestConditions getDestinationRequestConditions() {
@@ -114,6 +135,8 @@ public ShareRequestConditions getDestinationRequestConditions() {
}
/**
+ * Sets the destination request conditions.
+ *
* @param destinationRequestConditions The destination request conditions.
* @return The updated options.
*/
@@ -123,6 +146,9 @@ public ShareFileRenameOptions setDestinationRequestConditions(ShareRequestCondit
}
/**
+ * Gets the optional file permission to set on the destination file or directory. The value in SmbProperties will be
+ * ignored.
+ *
* @return Optional file permission to set on the destination file or directory. The value in SmbProperties will be
* ignored.
*/
@@ -131,6 +157,9 @@ public String getFilePermission() {
}
/**
+ * Sets the optional file permission to set on the destination file or directory. The value in SmbProperties will be
+ * ignored.
+ *
* @param filePermission Optional file permission to set on the destination file or directory. The value in
* SmbProperties will be ignored.
* @return The updated options.
@@ -141,6 +170,8 @@ public ShareFileRenameOptions setFilePermission(String filePermission) {
}
/**
+ * Gets the optional SMB properties to set on the destination file or directory.
+ *
* @return Optional SMB properties to set on the destination file or directory. The only properties that are
* considered are file attributes, file creation time, file last write time, and file permission key. The rest are
* ignored.
@@ -150,6 +181,8 @@ public FileSmbProperties getSmbProperties() {
}
/**
+ * Sets the optional SMB properties to set on the destination file or directory.
+ *
* @param smbProperties Optional SMB properties to set on the destination file or directory. The only properties
* that are considered are file attributes, file creation time, file last write time, and file permission key. The
* rest are ignored.
@@ -161,6 +194,8 @@ public ShareFileRenameOptions setSmbProperties(FileSmbProperties smbProperties)
}
/**
+ * Gets the metadata to associate with the renamed file.
+ *
* @return The metadata to associate with the renamed file.
*/
public Map getMetadata() {
@@ -168,6 +203,8 @@ public Map getMetadata() {
}
/**
+ * Sets the metadata to associate with the renamed file.
+ *
* @param metadata The metadata to associate with the renamed file.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileSeekableByteChannelReadOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileSeekableByteChannelReadOptions.java
index c19a67b6fd931..b55cee38c5ec1 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileSeekableByteChannelReadOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileSeekableByteChannelReadOptions.java
@@ -13,6 +13,14 @@ public final class ShareFileSeekableByteChannelReadOptions {
private Long chunkSizeInBytes;
/**
+ * Creates a new instance of {@link ShareFileSeekableByteChannelReadOptions}.
+ */
+ public ShareFileSeekableByteChannelReadOptions() {
+ }
+
+ /**
+ * Gets the size of individual writes to the service.
+ *
* @return The size of individual writes to the service.
*/
public Long getChunkSizeInBytes() {
@@ -20,6 +28,8 @@ public Long getChunkSizeInBytes() {
}
/**
+ * Sets the size of individual writes to the service.
+ *
* @param chunkSizeInBytes The size of individual writes to the service.
* @return The updated instance.
*/
@@ -29,6 +39,8 @@ public ShareFileSeekableByteChannelReadOptions setChunkSizeInBytes(Long chunkSiz
}
/**
+ * Gets the request conditions to be used by the resulting channel.
+ *
* @return Request conditions to be used by the resulting channel.
*/
public ShareRequestConditions getRequestConditions() {
@@ -36,6 +48,8 @@ public ShareRequestConditions getRequestConditions() {
}
/**
+ * Sets the request conditions to be used by the resulting channel.
+ *
* @param requestConditions Request conditions to be used by the resulting channel.
* @return The updated instance.
*/
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileSeekableByteChannelWriteOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileSeekableByteChannelWriteOptions.java
index 6ba4d3a8952c5..9e73f93d0529f 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileSeekableByteChannelWriteOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileSeekableByteChannelWriteOptions.java
@@ -28,6 +28,8 @@ public ShareFileSeekableByteChannelWriteOptions(boolean overwriteMode) {
}
/**
+ * Gets whether the channel is in write mode.
+ *
* @return Whether the channel is in write mode.
*/
public boolean isOverwriteMode() {
@@ -43,6 +45,8 @@ public Long getFileSizeInBytes() {
}
/**
+ * Gets the size of individual writes to the service.
+ *
* @param fileSize New size of the target file.
* @return The updated instance.
* @throws UnsupportedOperationException When setting a file size on options that don't create a new file.
@@ -62,6 +66,8 @@ public ShareFileSeekableByteChannelWriteOptions setFileSize(Long fileSize) {
}
/**
+ * Gets the size of individual writes to the service.
+ *
* @return The size of individual writes to the service.
*/
public Long getChunkSizeInBytes() {
@@ -69,6 +75,8 @@ public Long getChunkSizeInBytes() {
}
/**
+ * Sets the size of individual writes to the service.
+ *
* @param chunkSizeInBytes The size of individual writes to the service.
* @return The updated instance.
*/
@@ -78,6 +86,8 @@ public ShareFileSeekableByteChannelWriteOptions setChunkSizeInBytes(Long chunkSi
}
/**
+ * Gets the request conditions to be used by the resulting channel.
+ *
* @return Request conditions to be used by the resulting channel.
*/
public ShareRequestConditions getRequestConditions() {
@@ -85,6 +95,8 @@ public ShareRequestConditions getRequestConditions() {
}
/**
+ * Sets the request conditions to be used by the resulting channel.
+ *
* @param requestConditions Request conditions to be used by the resulting channel.
* @return The updated instance.
*/
@@ -94,14 +106,18 @@ public ShareFileSeekableByteChannelWriteOptions setRequestConditions(ShareReques
}
/**
- * @return The last wriiten mode to be used by the resulting channel.
+ * Gets the last written mode to be used by the resulting channel.
+ *
+ * @return The last written mode to be used by the resulting channel.
*/
public FileLastWrittenMode getFileLastWrittenMode() {
return fileLastWrittenMode;
}
/**
- * @param fileLastWrittenMode The last wriiten mode to be used by the resulting channel.
+ * Sets the last written mode to be used by the resulting channel.
+ *
+ * @param fileLastWrittenMode The last written mode to be used by the resulting channel.
* @return The updated instance.
*/
public ShareFileSeekableByteChannelWriteOptions setFileLastWrittenMode(FileLastWrittenMode fileLastWrittenMode) {
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileSetPropertiesOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileSetPropertiesOptions.java
index b6c5b5802d73f..463bdc5588c9b 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileSetPropertiesOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileSetPropertiesOptions.java
@@ -20,6 +20,8 @@ public class ShareFileSetPropertiesOptions {
private ShareRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link ShareFileSetPropertiesOptions}.
+ *
* @param sizeInBytes Specifies the new size for the file share in bytes. If the specified byte value is less than the
* current size of the file, then all ranges above the specified byte value are cleared.
*/
@@ -28,6 +30,8 @@ public ShareFileSetPropertiesOptions(long sizeInBytes) {
}
/**
+ * Gets the new size for the file share.
+ *
* @return Gets the new size for the file share.
*/
public long getSizeInBytes() {
@@ -35,6 +39,8 @@ public long getSizeInBytes() {
}
/**
+ * Gets the file's http headers.
+ *
* @return the file's http headers.
*/
public ShareFileHttpHeaders getHttpHeaders() {
@@ -52,6 +58,8 @@ public ShareFileSetPropertiesOptions setHttpHeaders(ShareFileHttpHeaders httpHea
}
/**
+ * Gets the optional SMB properties to set on the destination file or directory.
+ *
* @return Optional SMB properties to set on the destination file or directory. The only properties that are
* considered are file attributes, file creation time, file last write time, and file permission key. The rest are
* ignored.
@@ -61,6 +69,8 @@ public FileSmbProperties getSmbProperties() {
}
/**
+ * Sets the optional SMB properties to set on the destination file or directory.
+ *
* @param smbProperties Optional SMB properties to set on the destination file or directory. The only properties
* that are considered are file attributes, file creation time, file last write time, and file permission key. The
* rest are ignored.
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileUploadRangeFromUrlOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileUploadRangeFromUrlOptions.java
index 51582ca09ab28..dbd32297f2300 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileUploadRangeFromUrlOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareFileUploadRangeFromUrlOptions.java
@@ -23,8 +23,11 @@ public final class ShareFileUploadRangeFromUrlOptions {
private FileLastWrittenMode lastWrittenMode;
/**
+ * Creates a new instance of {@link ShareFileUploadRangeFromUrlOptions}.
+ *
* @param length data length to upload for this operation.
* @param sourceUrl source URL for this operation.
+ * @throws NullPointerException if {@code sourceUrl} is null.
*/
public ShareFileUploadRangeFromUrlOptions(long length, String sourceUrl) {
StorageImplUtils.assertNotNull("sourceUrl", sourceUrl);
@@ -33,6 +36,8 @@ public ShareFileUploadRangeFromUrlOptions(long length, String sourceUrl) {
}
/**
+ * Gets the length of the data to upload for this operation.
+ *
* @return data length to upload for this operation.
*/
public long getLength() {
@@ -40,6 +45,8 @@ public long getLength() {
}
/**
+ * Gets the source URL for this operation.
+ *
* @return source URL for this operation.
*/
public String getSourceUrl() {
@@ -47,6 +54,8 @@ public String getSourceUrl() {
}
/**
+ * Gets the destination offset for this operation.
+ *
* @return destination offset for this operation.
*/
public long getDestinationOffset() {
@@ -54,6 +63,8 @@ public long getDestinationOffset() {
}
/**
+ * Sets the destination offset for this operation.
+ *
* @param destinationOffset offset for upload destination.
* @return modified options.
*/
@@ -63,6 +74,8 @@ public ShareFileUploadRangeFromUrlOptions setDestinationOffset(long destinationO
}
/**
+ * Gets the source offset for this operation.
+ *
* @return source offset for this operation.
*/
public long getSourceOffset() {
@@ -70,6 +83,8 @@ public long getSourceOffset() {
}
/**
+ * Sets the source offset for this operation.
+ *
* @param sourceOffset offset for upload source.
* @return modified options.
*/
@@ -79,6 +94,9 @@ public ShareFileUploadRangeFromUrlOptions setSourceOffset(long sourceOffset) {
}
/**
+ * Gets "Authorization" header for accessing source URL. Currently only "Bearer" authentication is accepted by
+ * Storage.
+ *
* @return optional auth header for access to source URL for this operation.
*/
public HttpAuthorization getSourceAuthorization() {
@@ -98,6 +116,8 @@ public ShareFileUploadRangeFromUrlOptions setSourceAuthorization(HttpAuthorizati
}
/**
+ * Gets {@link ShareRequestConditions} for this operation.
+ *
* @return {@link ShareRequestConditions} for this operation.
*/
public ShareRequestConditions getDestinationRequestConditions() {
@@ -105,6 +125,8 @@ public ShareRequestConditions getDestinationRequestConditions() {
}
/**
+ * Sets {@link ShareRequestConditions} for this operation.
+ *
* @param destinationRequestConditions {@link ShareRequestConditions} for this operation.
* @return modified options.
*/
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareGetAccessPolicyOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareGetAccessPolicyOptions.java
index 2b880340eb3fe..a1bf06b71807a 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareGetAccessPolicyOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareGetAccessPolicyOptions.java
@@ -11,10 +11,17 @@
*/
@Fluent
public class ShareGetAccessPolicyOptions {
-
private ShareRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link ShareGetAccessPolicyOptions}.
+ */
+ public ShareGetAccessPolicyOptions() {
+ }
+
+ /**
+ * Gets the {@link ShareRequestConditions}.
+ *
* @return {@link ShareRequestConditions}.
*/
public ShareRequestConditions getRequestConditions() {
@@ -22,6 +29,8 @@ public ShareRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link ShareRequestConditions}.
+ *
* @param requestConditions {@link ShareRequestConditions}.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareGetPropertiesOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareGetPropertiesOptions.java
index 7ecb4e99dafc7..38f70f6574c08 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareGetPropertiesOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareGetPropertiesOptions.java
@@ -11,10 +11,17 @@
*/
@Fluent
public class ShareGetPropertiesOptions {
-
private ShareRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link ShareGetPropertiesOptions}.
+ */
+ public ShareGetPropertiesOptions() {
+ }
+
+ /**
+ * Gets the {@link ShareRequestConditions}.
+ *
* @return {@link ShareRequestConditions}.
*/
public ShareRequestConditions getRequestConditions() {
@@ -22,6 +29,8 @@ public ShareRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link ShareRequestConditions}.
+ *
* @param requestConditions {@link ShareRequestConditions}.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareGetStatisticsOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareGetStatisticsOptions.java
index 0d7ef0009fe3e..0821b23220155 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareGetStatisticsOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareGetStatisticsOptions.java
@@ -11,10 +11,17 @@
*/
@Fluent
public class ShareGetStatisticsOptions {
-
private ShareRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link ShareGetStatisticsOptions}.
+ */
+ public ShareGetStatisticsOptions() {
+ }
+
+ /**
+ * Gets the {@link ShareRequestConditions}.
+ *
* @return {@link ShareRequestConditions}.
*/
public ShareRequestConditions getRequestConditions() {
@@ -22,6 +29,8 @@ public ShareRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link ShareRequestConditions}.
+ *
* @param requestConditions {@link ShareRequestConditions}.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareListFilesAndDirectoriesOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareListFilesAndDirectoriesOptions.java
index e336dd7911516..0b5138331c401 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareListFilesAndDirectoriesOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareListFilesAndDirectoriesOptions.java
@@ -16,6 +16,14 @@ public final class ShareListFilesAndDirectoriesOptions {
private Boolean includeExtendedInfo;
/**
+ * Creates a new instance of {@link ShareListFilesAndDirectoriesOptions}.
+ */
+ public ShareListFilesAndDirectoriesOptions() {
+ }
+
+ /**
+ * Gets the prefix for a listing operation.
+ *
* @return prefix for this listing operation.
*/
public String getPrefix() {
@@ -34,6 +42,8 @@ public ShareListFilesAndDirectoriesOptions setPrefix(String prefix) {
}
/**
+ * Gets the max results per page for a listing operation.
+ *
* @return max results per page for this listing operation.
*/
public Integer getMaxResultsPerPage() {
@@ -54,7 +64,7 @@ public ShareListFilesAndDirectoriesOptions setMaxResultsPerPage(Integer maxResul
/**
* Note that setting timestamps, etag, attributes, or permission key will also set this option as true. Attempting
* to set it back to false while any of these options are true will be unsuccessful.
- *
+ *
* Including extended info in a listing operation can result in a more expensive operation, but will present
* more accurate information on the listing item.
*
@@ -67,9 +77,9 @@ public Boolean includeExtendedInfo() {
/**
* Note that setting timestamps, etag, attributes, or permission key will also set this option as true. Attempting
* to set it back to false will be unsuccessful.
- *
+ *
* Sets the prefix for a listing operation.
- *
+ *
* Including extended info in a listing operation can result in a more expensive operation, but will present
* more accurate information on the listing item.
*
@@ -83,6 +93,8 @@ public ShareListFilesAndDirectoriesOptions setIncludeExtendedInfo(Boolean includ
}
/**
+ * Gets whether to include timestamps on a listing operation.
+ *
* @return whether to include timestamps on this listing operation.
*/
public boolean includeTimestamps() {
@@ -90,6 +102,8 @@ public boolean includeTimestamps() {
}
/**
+ * Sets whether to include timestamps on a listing operation.
+ *
* @param includeTimestamps whether to include timestamps on this listing operation.
* @return updated options
*/
@@ -99,6 +113,8 @@ public ShareListFilesAndDirectoriesOptions setIncludeTimestamps(boolean includeT
}
/**
+ * Gets whether to include the etag on a listing operation.
+ *
* @return whether to include the etag on this listing operation.
*/
public boolean includeETag() {
@@ -106,6 +122,8 @@ public boolean includeETag() {
}
/**
+ * Sets whether to include the etag on a listing operation.
+ *
* @param includeETag whether to include the etag on this listing operation.
* @return updated options
*/
@@ -115,6 +133,8 @@ public ShareListFilesAndDirectoriesOptions setIncludeETag(boolean includeETag) {
}
/**
+ * Gets whether to include file attributes on a listing operation.
+ *
* @return whether to include file attributes on this listing operation.
*/
public boolean includeAttributes() {
@@ -122,6 +142,8 @@ public boolean includeAttributes() {
}
/**
+ * Sets whether to include file attributes on a listing operation.
+ *
* @param includeAttributes whether to include file attributes on this listing operation.
* @return updated options
*/
@@ -131,6 +153,8 @@ public ShareListFilesAndDirectoriesOptions setIncludeAttributes(boolean includeA
}
/**
+ * Gets whether to include the permission key on a listing operation.
+ *
* @return whether to include the permission key on this listing operation.
*/
public boolean includePermissionKey() {
@@ -138,6 +162,8 @@ public boolean includePermissionKey() {
}
/**
+ * Sets whether to include the permission key on a listing operation.
+ *
* @param includePermissionKey whether to include the permission key on this listing operation.
* @return updated options
*/
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareSetAccessPolicyOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareSetAccessPolicyOptions.java
index c86c19a6af608..63bed05e0dca9 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareSetAccessPolicyOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareSetAccessPolicyOptions.java
@@ -15,11 +15,18 @@
*/
@Fluent
public class ShareSetAccessPolicyOptions {
-
private List permissions;
private ShareRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link ShareSetAccessPolicyOptions}.
+ */
+ public ShareSetAccessPolicyOptions() {
+ }
+
+ /**
+ * Gets the access policies to set on the share.
+ *
* @return Access policies to set on the share.
*/
public List getPermissions() {
@@ -27,6 +34,8 @@ public List getPermissions() {
}
/**
+ * Sets the access policies to set on the share.
+ *
* @param permissions Access policies to set on the share.
* @return The updated options.
*/
@@ -36,6 +45,8 @@ public ShareSetAccessPolicyOptions setPermissions(List pe
}
/**
+ * Gets the {@link ShareRequestConditions}.
+ *
* @return {@link ShareRequestConditions}.
*/
public ShareRequestConditions getRequestConditions() {
@@ -43,6 +54,8 @@ public ShareRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link ShareRequestConditions}.
+ *
* @param requestConditions {@link ShareRequestConditions}.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareSetMetadataOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareSetMetadataOptions.java
index ad0282ad6b8f5..b28f360c8fe0c 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareSetMetadataOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareSetMetadataOptions.java
@@ -14,11 +14,18 @@
*/
@Fluent
public class ShareSetMetadataOptions {
-
private Map metadata;
private ShareRequestConditions requestConditions;
/**
+ * Creates a new instance of {@link ShareSetMetadataOptions}.
+ */
+ public ShareSetMetadataOptions() {
+ }
+
+ /**
+ * Gets the metadata to set on the share.
+ *
* @return Metadata to set on the share, if null is passed the metadata for the share is cleared.
*/
public Map getMetadata() {
@@ -26,6 +33,8 @@ public Map getMetadata() {
}
/**
+ * Sets the metadata to set on the share.
+ *
* @param metadata Metadata to set on the share, if null is passed the metadata for the share is cleared.
* @return The updated options.
*/
@@ -35,6 +44,8 @@ public ShareSetMetadataOptions setMetadata(Map metadata) {
}
/**
+ * Gets the {@link ShareRequestConditions}.
+ *
* @return {@link ShareRequestConditions}.
*/
public ShareRequestConditions getRequestConditions() {
@@ -42,6 +53,8 @@ public ShareRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link ShareRequestConditions}.
+ *
* @param requestConditions {@link ShareRequestConditions}.
* @return The updated options.
*/
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareSetPropertiesOptions.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareSetPropertiesOptions.java
index 33b10d2155f09..1e398ee52872d 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareSetPropertiesOptions.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/options/ShareSetPropertiesOptions.java
@@ -13,7 +13,6 @@
*/
@Fluent
public class ShareSetPropertiesOptions {
-
private Integer quotaInGb;
private ShareAccessTier accessTier;
private ShareRootSquash rootSquash;
@@ -26,6 +25,14 @@ public class ShareSetPropertiesOptions {
private Long provisionedMaxBandwidthMibps;
/**
+ * Creates a new instance of {@link ShareSetPropertiesOptions}.
+ */
+ public ShareSetPropertiesOptions() {
+ }
+
+ /**
+ * Gets the {@link ShareAccessTier}.
+ *
* @return {@link ShareAccessTier}
*/
public ShareAccessTier getAccessTier() {
@@ -33,6 +40,8 @@ public ShareAccessTier getAccessTier() {
}
/**
+ * Sets the {@link ShareAccessTier}.
+ *
* @param accessTier {@link ShareAccessTier}.
* @return The updated options.
*/
@@ -42,6 +51,8 @@ public ShareSetPropertiesOptions setAccessTier(ShareAccessTier accessTier) {
}
/**
+ * Gets the size in GB to limit the share's growth.
+ *
* @return Size in GB to limit the share's growth.
*/
public Integer getQuotaInGb() {
@@ -49,6 +60,8 @@ public Integer getQuotaInGb() {
}
/**
+ * Sets the size in GB to limit the share's growth.
+ *
* @param quotaInGb Size in GB to limit the share's growth.
* @return The updated options.
*/
@@ -58,6 +71,8 @@ public ShareSetPropertiesOptions setQuotaInGb(Integer quotaInGb) {
}
/**
+ * Gets the root squash to set for the share. Only valid for NFS.
+ *
* @return The root squash to set for the share. Only valid for NFS.
*/
public ShareRootSquash getRootSquash() {
@@ -65,6 +80,8 @@ public ShareRootSquash getRootSquash() {
}
/**
+ * Sets the root squash to set for the share. Only valid for NFS.
+ *
* @param rootSquash The root squash to set for the share. Only valid for NFS.
* @return The updated options.
*/
@@ -74,6 +91,8 @@ public ShareSetPropertiesOptions setRootSquash(ShareRootSquash rootSquash) {
}
/**
+ * Gets the {@link ShareRequestConditions}.
+ *
* @return {@link ShareRequestConditions}.
*/
public ShareRequestConditions getRequestConditions() {
@@ -81,6 +100,8 @@ public ShareRequestConditions getRequestConditions() {
}
/**
+ * Sets the {@link ShareRequestConditions}.
+ *
* @param requestConditions {@link ShareRequestConditions}.
* @return The updated options.
*/
@@ -92,7 +113,8 @@ public ShareSetPropertiesOptions setRequestConditions(ShareRequestConditions req
/**
* Get the enableSnapshotVirtualDirectoryAccess property: The EnableSnapshotVirtualDirectoryAccess property.
* Optional. Supported in version 2023-08-03 and above. Only applicable for premium file storage accounts.
- * Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled.
+ * Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS
+ * is enabled.
* If not specified, the default is true.
*
* @return the enableSnapshotVirtualDirectoryAccess value.
@@ -104,7 +126,8 @@ public Boolean isSnapshotVirtualDirectoryAccessEnabled() {
/**
* Set the enableSnapshotVirtualDirectoryAccess property: The EnableSnapshotVirtualDirectoryAccess property.
* Optional. Supported in version 2023-08-03 and above. Only applicable for premium file storage accounts.
- * Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS is enabled.
+ * Specifies whether the snapshot virtual directory should be accessible at the root of share mount point when NFS
+ * is enabled.
* If not specified, the default is true.
*
* @param snapshotVirtualDirectoryAccessEnabled the enableSnapshotVirtualDirectoryAccess value to set.
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareFileSasPermission.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareFileSasPermission.java
index c48ae72dd4363..128bcc7c4827d 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareFileSasPermission.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareFileSasPermission.java
@@ -24,11 +24,8 @@
*/
public final class ShareFileSasPermission {
private boolean readPermission;
-
private boolean createPermission;
-
private boolean writePermission;
-
private boolean deletePermission;
/**
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareSasPermission.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareSasPermission.java
index 650b00768869a..7400a94ca4d1c 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareSasPermission.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareSasPermission.java
@@ -16,13 +16,9 @@
*/
public final class ShareSasPermission {
private boolean readPermission;
-
private boolean createPermission;
-
private boolean writePermission;
-
private boolean deletePermission;
-
private boolean listPermission;
/**
@@ -74,6 +70,8 @@ public static ShareSasPermission parse(String permissionString) {
}
/**
+ * Gets the read permission status.
+ *
* @return the read permission status
*/
public boolean hasReadPermission() {
@@ -92,6 +90,8 @@ public ShareSasPermission setReadPermission(boolean hasReadPermission) {
}
/**
+ * Gets the create permission status.
+ *
* @return the create permission status
*/
public boolean hasCreatePermission() {
@@ -110,6 +110,8 @@ public ShareSasPermission setCreatePermission(boolean hasCreatePermission) {
}
/**
+ * Gets the write permission status.
+ *
* @return the write permission status
*/
public boolean hasWritePermission() {
@@ -128,6 +130,8 @@ public ShareSasPermission setWritePermission(boolean hasWritePermission) {
}
/**
+ * Gets the delete permission status.
+ *
* @return the delete permission status
*/
public boolean hasDeletePermission() {
@@ -146,6 +150,8 @@ public ShareSasPermission setDeletePermission(boolean hasDeletePermission) {
}
/**
+ * Gets the list permission status.
+ *
* @return the list permission status
*/
public boolean hasListPermission() {
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareServiceSasQueryParameters.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareServiceSasQueryParameters.java
index 83d6e8bcb5526..24bf48d34cb62 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareServiceSasQueryParameters.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareServiceSasQueryParameters.java
@@ -24,19 +24,12 @@
*/
@Deprecated
public final class ShareServiceSasQueryParameters extends BaseSasQueryParameters {
-
private final String identifier;
-
private final String resource;
-
private final String cacheControl;
-
private final String contentDisposition;
-
private final String contentEncoding;
-
private final String contentLanguage;
-
private final String contentType;
/**
@@ -99,6 +92,8 @@ public ShareServiceSasQueryParameters(Map queryParamsMap, bool
}
/**
+ * Gets the signed identifier (only for {@link ShareServiceSasSignatureValues}) or {@code null}.
+ *
* @return The signed identifier (only for {@link ShareServiceSasSignatureValues}) or {@code null}. Please see
* here
* for more information.
@@ -110,6 +105,8 @@ public String getIdentifier() {
}
/**
+ * Gets the storage share or file (only for {@link ShareServiceSasSignatureValues}).
+ *
* @return The storage share or file (only for {@link ShareServiceSasSignatureValues}).
* @deprecated Please use {@link ShareServiceSasSignatureValues}
*/
@@ -119,6 +116,8 @@ public String getResource() {
}
/**
+ * Gets the Cache-Control header value when a client accesses the resource with this sas token.
+ *
* @return The Cache-Control header value when a client accesses the resource with this sas token.
* @deprecated Please use {@link ShareServiceSasSignatureValues}
*/
@@ -128,6 +127,8 @@ public String getCacheControl() {
}
/**
+ * Gets the Content-Disposition header value when a client accesses the resource with this sas token.
+ *
* @return The Content-Disposition header value when a client accesses the resource with this sas token.
* @deprecated Please use {@link ShareServiceSasSignatureValues}
*/
@@ -137,6 +138,8 @@ public String getContentDisposition() {
}
/**
+ * Gets the Content-Encoding header value when a client accesses the resource with this sas token.
+ *
* @return The Content-Encoding header value when a client accesses the resource with this sas token.
* @deprecated Please use {@link ShareServiceSasSignatureValues}
*/
@@ -146,6 +149,8 @@ public String getContentEncoding() {
}
/**
+ * Gets the Content-Language header value when a client accesses the resource with this sas token.
+ *
* @return The Content-Language header value when a client accesses the resource with this sas token.
* @deprecated Please use {@link ShareServiceSasSignatureValues}
*/
@@ -155,6 +160,8 @@ public String getContentLanguage() {
}
/**
+ * Gets the Content-Type header value when a client accesses the resource with this sas token.
+ *
* @return The Content-Type header value when a client accesses the resource with this sas token.
* @deprecated Please use {@link ShareServiceSasSignatureValues}
*/
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareServiceSasSignatureValues.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareServiceSasSignatureValues.java
index 30d3be044cb13..3272eb4fdcada 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareServiceSasSignatureValues.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/sas/ShareServiceSasSignatureValues.java
@@ -39,29 +39,17 @@ public final class ShareServiceSasSignatureValues {
.get(Constants.PROPERTY_AZURE_STORAGE_SAS_SERVICE_VERSION, ShareServiceVersion.getLatest().getVersion());
private SasProtocol protocol;
-
private OffsetDateTime startTime;
-
private OffsetDateTime expiryTime;
-
private String permissions;
-
private SasIpRange sasIpRange;
-
private String shareName;
-
private String filePath;
-
private String identifier;
-
private String cacheControl;
-
private String contentDisposition;
-
private String contentEncoding;
-
private String contentLanguage;
-
private String contentType;
/**
@@ -111,6 +99,9 @@ public ShareServiceSasSignatureValues(String identifier) {
}
/**
+ * Gets the version of the service this SAS will target. If not specified, it will default to the version targeted
+ * by the library.
+ *
* @return the version of the service this SAS will target. If not specified, it will default to the version
* targeted by the library.
*/
@@ -134,6 +125,8 @@ public ShareServiceSasSignatureValues setVersion(String version) {
}
/**
+ * Gets the {@link SasProtocol} which determines the protocols allowed by the SAS.
+ *
* @return the {@link SasProtocol} which determines the protocols allowed by the SAS.
*/
public SasProtocol getProtocol() {
@@ -152,6 +145,8 @@ public ShareServiceSasSignatureValues setProtocol(SasProtocol protocol) {
}
/**
+ * Gets when the SAS will take effect.
+ *
* @return when the SAS will take effect.
*/
public OffsetDateTime getStartTime() {
@@ -170,6 +165,8 @@ public ShareServiceSasSignatureValues setStartTime(OffsetDateTime startTime) {
}
/**
+ * Gets the time after which the SAS will no longer work.
+ *
* @return the time after which the SAS will no longer work.
*/
public OffsetDateTime getExpiryTime() {
@@ -188,6 +185,10 @@ public ShareServiceSasSignatureValues setExpiryTime(OffsetDateTime expiryTime) {
}
/**
+ *
+ * Gets the permissions string allowed by the SAS. Please refer to either {@link ShareSasPermission} or {@link
+ * ShareFileSasPermission} depending on the resource being accessed for help determining the permissions allowed.
+ *
* @return the permissions string allowed by the SAS. Please refer to either {@link ShareSasPermission} or {@link
* ShareFileSasPermission} depending on the resource being accessed for help determining the permissions allowed.
*/
@@ -222,6 +223,8 @@ public ShareServiceSasSignatureValues setPermissions(ShareFileSasPermission perm
}
/**
+ * Gets the {@link SasIpRange} which determines the IP ranges that are allowed to use the SAS.
+ *
* @return the {@link SasIpRange} which determines the IP ranges that are allowed to use the SAS.
*/
public SasIpRange getSasIpRange() {
@@ -294,6 +297,10 @@ public ShareServiceSasSignatureValues setFilePath(String filePath) {
}
/**
+ * Gets the name of the access policy on the share this SAS references if any. Please see
+ *
+ * Establishing a stored access policy for more information.
+ *
* @return the name of the access policy on the share this SAS references if any. Please see
*
* Establishing a stored access policy for more information.
@@ -316,6 +323,8 @@ public ShareServiceSasSignatureValues setIdentifier(String identifier) {
}
/**
+ * Gets the cache-control header for the SAS.
+ *
* @return the cache-control header for the SAS.
*/
public String getCacheControl() {
@@ -334,6 +343,8 @@ public ShareServiceSasSignatureValues setCacheControl(String cacheControl) {
}
/**
+ * Gets the content-disposition header for the SAS.
+ *
* @return the content-disposition header for the SAS.
*/
public String getContentDisposition() {
@@ -352,6 +363,8 @@ public ShareServiceSasSignatureValues setContentDisposition(String contentDispos
}
/**
+ * Gets the content-encoding header for the SAS.
+ *
* @return the content-encoding header for the SAS.
*/
public String getContentEncoding() {
@@ -370,6 +383,8 @@ public ShareServiceSasSignatureValues setContentEncoding(String contentEncoding)
}
/**
+ * Gets the content-language header for the SAS.
+ *
* @return the content-language header for the SAS.
*/
public String getContentLanguage() {
@@ -388,6 +403,8 @@ public ShareServiceSasSignatureValues setContentLanguage(String contentLanguage)
}
/**
+ * Gets the content-type header for the SAS.
+ *
* @return the content-type header for the SAS.
*/
public String getContentType() {
diff --git a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/specialized/ShareLeaseClientBuilder.java b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/specialized/ShareLeaseClientBuilder.java
index 383c28e82b634..7d7d799303608 100644
--- a/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/specialized/ShareLeaseClientBuilder.java
+++ b/sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/specialized/ShareLeaseClientBuilder.java
@@ -86,6 +86,12 @@ public final class ShareLeaseClientBuilder {
private boolean allowSourceTrailingDot;
private boolean allowTrailingDot;
+ /**
+ * Creates a new instance of {@link ShareLeaseClientBuilder}.
+ */
+ public ShareLeaseClientBuilder() {
+ }
+
/**
* Creates a {@link ShareLeaseClient} based on the configurations set in the builder.
*