DataLakeFileAppendOptions Class

Package:

com.azure.storage.file.datalake.options

Maven Artifact:

com.azure:azure-storage-file-datalake:12.21.0

• java.lang.Object
• • com.azure.storage.file.datalake.options.DataLakeFileAppendOptions

public class DataLakeFileAppendOptions

Optional parameters for appending data to a file.

Constructor Summary

Constructor	Description
DataLakeFileAppendOptions()

Method Summary

Modifier and Type	Method and Description
byte[]	getContentMd5() When this header is specified, the storage service compares the hash of the content that has arrived with this header value.
LeaseAction	getLeaseAction() Get lease action set on file.
Integer	getLeaseDuration()
String	getLeaseId() Gets the lease ID to access the file.
String	getProposedLeaseId() Gets proposed lease id.
Boolean	isFlush() Returns whether file will be flushed after the append.
DataLakeFileAppendOptions	setContentHash(byte[] contentMd5) This hash is used to verify the integrity of the request content during transport.
DataLakeFileAppendOptions	setFlush(Boolean flush) If true, the file will be flushed after the append.
DataLakeFileAppendOptions	setLeaseAction(LeaseAction leaseAction) Get lease action set on file.
DataLakeFileAppendOptions	setLeaseDuration(Integer leaseDurationInSeconds) Optional.
DataLakeFileAppendOptions	setLeaseId(String leaseId) Sets the lease ID.
DataLakeFileAppendOptions	setProposedLeaseId(String proposedLeaseId) Sets the proposed lease id.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DataLakeFileAppendOptions

public DataLakeFileAppendOptions()

Method Details

getContentMd5

public byte[] getContentMd5()

When this header is specified, the storage service compares the hash of the content that has arrived with this header value. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). Note that this MD5 hash is not stored with the file. This header is associated with the request content, and not with the stored content of the file itself.

Returns:

MD5 hash of the content of the data.

getLeaseAction

public LeaseAction getLeaseAction()

Get lease action set on file. ACQUIRE will attempt to acquire a new lease on the file, with DataLakeFileAppendOptions#proposedLeaseId as the lease ID. ACQUIRE_RELEASE will attempt to aquire a new lease on the file, with DataLakeFileAppendOptions#proposedLeaseId as the lease ID. The lease will be released once the Append operation is complete. AUTO_RENEW will attempt to renew the lease specified by getLeaseId(). RELEASE will attempt to release the least specified by getLeaseId().

Returns:

The LeaseAction set on the file.

getLeaseDuration

public Integer getLeaseDuration()

Returns:

the lease duration in seconds.

getLeaseId

public String getLeaseId()

Gets the lease ID to access the file.

Returns:

lease ID to access this file.

getProposedLeaseId

public String getProposedLeaseId()

Gets proposed lease id. Valid with ACQUIRE and ACQUIRE_RELEASE.

Returns:

the proposed lease id.

isFlush

public Boolean isFlush()

Returns whether file will be flushed after the append.

Returns:

the boolean flag for flush.

setContentHash

public DataLakeFileAppendOptions setContentHash(byte[] contentMd5)

This hash is used to verify the integrity of the request content during transport. When this header is specified, the storage service compares the hash of the content that has arrived with this header value. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). Note that this MD5 hash is not stored with the file. This header is associated with the request content, and not with the stored content of the file itself.

Parameters:

contentMd5 - contentMd5 An MD5 hash of the content of the data. If specified, the service will calculate the MD5 of the received data and fail the request if it does not match the provided MD5.

Returns:

the updated DataLakeFileAppendOptions object.

setFlush

public DataLakeFileAppendOptions setFlush(Boolean flush)

If true, the file will be flushed after the append.

Parameters:

flush - boolean flag to indicate whether file should be flushed.

Returns:

the updated DataLakeFileAppendOptions object.

setLeaseAction

public DataLakeFileAppendOptions setLeaseAction(LeaseAction leaseAction)

Get lease action set on file. ACQUIRE will attempt to acquire a new lease on the file, with DataLakeFileAppendOptions#proposedLeaseId as the lease ID. ACQUIRE_RELEASE will attempt to aquire a new lease on the file, with DataLakeFileAppendOptions#proposedLeaseId as the lease ID. The lease will be released once the Append operation is complete. AUTO_RENEW will attempt to renew the lease specified by getLeaseId(). RELEASE will attempt to release the least specified by getLeaseId().

Parameters:

leaseAction - the LeaseAction to set on the file.

Returns:

the updated DataLakeFileAppendOptions object.

setLeaseDuration

public DataLakeFileAppendOptions setLeaseDuration(Integer leaseDurationInSeconds)

Optional. Specifies the duration of the lease, in seconds, or specify -1 for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. Sets the lease duration.

Parameters:

leaseDurationInSeconds - the new lease duration.

Returns:

the updated DataLakeFileAppendOptions object.

setLeaseId

public DataLakeFileAppendOptions setLeaseId(String leaseId)

Sets the lease ID.

Parameters:

leaseId - The lease ID.

Returns:

the updated DataLakeFileAppendOptions object.

setProposedLeaseId

public DataLakeFileAppendOptions setProposedLeaseId(String proposedLeaseId)

Sets the proposed lease id. Valid with ACQUIRE and ACQUIRE_RELEASE.

Parameters:

proposedLeaseId - the proposed lease id to set.

Returns:

the updated DataLakeFileAppendOptions object.