Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PathFlushDataOptionalParams

Package version

Optional parameters.

Hierarchy

  • any
    • PathFlushDataOptionalParams

Index

Properties

Optional close

close: undefined | false | true

Azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are enabled. If the value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If "false" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed."

Optional contentLength

contentLength: undefined | number

Required for "Append Data" and "Flush Data". Must be 0 for "Flush Data". Must be the length of the request content in bytes for "Append Data".

Optional leaseAccessConditions

leaseAccessConditions: LeaseAccessConditions

Parameter group

Optional modifiedAccessConditions

modifiedAccessConditions: ModifiedAccessConditions

Parameter group

Optional pathHttpHeaders

pathHttpHeaders: PathHttpHeaders

Parameter group

Optional position

position: undefined | number

This parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request.

Optional requestId

requestId: undefined | string

Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled.

Optional retainUncommittedData

retainUncommittedData: undefined | false | true

Valid only for flush operations. 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 written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation.

Optional timeout

timeout: undefined | number

The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.

Generated using TypeDoc