BlobQueryOptions Class

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

public class BlobQueryOptions

Optional parameters for Blob Query.

Constructor Summary

Constructor Description
BlobQueryOptions(String expression)

Constructs a BlobQueryOptions.
BlobQueryOptions(String expression, OutputStream outputStream)

Constructs a BlobQueryOptions.

Method Summary

Modifier and Type Method and Description
Consumer<BlobQueryError> getErrorConsumer()

Gets the error consumer.
String getExpression()

Gets the query expression.
BlobQuerySerialization getInputSerialization()

Gets the input serialization.
BlobQuerySerialization getOutputSerialization()

Gets the output serialization.
OutputStream getOutputStream()

Gets the outputStream where the downloaded data will be written.
Consumer<BlobQueryProgress> getProgressConsumer()

Gets the progress consumer.
BlobRequestConditions getRequestConditions()

Gets the request conditions.
BlobQueryOptions setErrorConsumer(Consumer<BlobQueryError> errorConsumer)

Sets the error consumer.
BlobQueryOptions setInputSerialization(BlobQuerySerialization inputSerialization)

Sets the input serialization.
BlobQueryOptions setOutputSerialization(BlobQuerySerialization outputSerialization)

Sets the output serialization.
BlobQueryOptions setProgressConsumer(Consumer<BlobQueryProgress> progressConsumer)

Sets the progress consumer.
BlobQueryOptions setRequestConditions(BlobRequestConditions requestConditions)

Sets the request conditions.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BlobQueryOptions

public BlobQueryOptions(String expression)

Constructs a BlobQueryOptions.

Parameters:

expression - The query expression.

BlobQueryOptions

public BlobQueryOptions(String expression, OutputStream outputStream)

Constructs a BlobQueryOptions.

Parameters:

expression - The query expression.
outputStream - The OutputStream where the downloaded data will be written.

Method Details

getErrorConsumer

public Consumer getErrorConsumer()

Gets the error consumer.

Returns:

the error consumer.

getExpression

public String getExpression()

Gets the query expression.

Returns:

the query expression.

getInputSerialization

public BlobQuerySerialization getInputSerialization()

Gets the input serialization.

Returns:

the input serialization.

getOutputSerialization

public BlobQuerySerialization getOutputSerialization()

Gets the output serialization.

Returns:

the output serialization.

getOutputStream

public OutputStream getOutputStream()

Gets the outputStream where the downloaded data will be written.

Returns:

the outputStream.

getProgressConsumer

public Consumer getProgressConsumer()

Gets the progress consumer.

Returns:

the progress consumer.

getRequestConditions

public BlobRequestConditions getRequestConditions()

Gets the request conditions.

Returns:

the request conditions.

setErrorConsumer

public BlobQueryOptions setErrorConsumer(Consumer errorConsumer)

Sets the error consumer.

Parameters:

errorConsumer - The error consumer.

Returns:

the updated BlobQueryOptions object.

setInputSerialization

public BlobQueryOptions setInputSerialization(BlobQuerySerialization inputSerialization)

Sets the input serialization.

Parameters:

inputSerialization - The input serialization.

Returns:

the updated BlobQueryOptions object.

setOutputSerialization

public BlobQueryOptions setOutputSerialization(BlobQuerySerialization outputSerialization)

Sets the output serialization.

Parameters:

outputSerialization - The output serialization.

Returns:

the updated BlobQueryOptions object.

setProgressConsumer

public BlobQueryOptions setProgressConsumer(Consumer progressConsumer)

Sets the progress consumer.

Parameters:

progressConsumer - The progress consumer.

Returns:

the updated BlobQueryOptions object.

setRequestConditions

public BlobQueryOptions setRequestConditions(BlobRequestConditions requestConditions)

Sets the request conditions.

Parameters:

requestConditions - The request conditions.

Returns:

the updated BlobQueryOptions object.

Applies to