azure-docs-sdk-java/docs-ref-autogen/com.azure.storage.blob.opti...

196 строки
14 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.storage.blob.options.BlobQueryOptions"
fullName: "com.azure.storage.blob.options.BlobQueryOptions"
name: "BlobQueryOptions"
nameWithType: "BlobQueryOptions"
summary: "Optional parameters for Blob Query."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **BlobQueryOptions**"
constructors:
- uid: "com.azure.storage.blob.options.BlobQueryOptions.BlobQueryOptions(java.lang.String)"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.BlobQueryOptions(String expression)"
name: "BlobQueryOptions(String expression)"
nameWithType: "BlobQueryOptions.BlobQueryOptions(String expression)"
summary: "Constructs a <xref uid=\"com.azure.storage.blob.options.BlobQueryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobQueryOptions\"></xref>."
parameters:
- description: "The query expression."
name: "expression"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryOptions(String expression)"
desc: "Constructs a <xref uid=\"com.azure.storage.blob.options.BlobQueryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobQueryOptions\"></xref>."
- uid: "com.azure.storage.blob.options.BlobQueryOptions.BlobQueryOptions(java.lang.String,java.io.OutputStream)"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.BlobQueryOptions(String expression, OutputStream outputStream)"
name: "BlobQueryOptions(String expression, OutputStream outputStream)"
nameWithType: "BlobQueryOptions.BlobQueryOptions(String expression, OutputStream outputStream)"
summary: "Constructs a <xref uid=\"com.azure.storage.blob.options.BlobQueryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobQueryOptions\"></xref>."
parameters:
- description: "The query expression."
name: "expression"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The OutputStream where the downloaded data will be written."
name: "outputStream"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html\">OutputStream</a>"
syntax: "public BlobQueryOptions(String expression, OutputStream outputStream)"
desc: "Constructs a <xref uid=\"com.azure.storage.blob.options.BlobQueryOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobQueryOptions\"></xref>."
methods:
- uid: "com.azure.storage.blob.options.BlobQueryOptions.getErrorConsumer()"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.getErrorConsumer()"
name: "getErrorConsumer()"
nameWithType: "BlobQueryOptions.getErrorConsumer()"
summary: "Gets the error consumer."
syntax: "public Consumer<BlobQueryError> getErrorConsumer()"
desc: "Gets the error consumer."
returns:
description: "the error consumer."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.storage.blob.models.BlobQueryError?alt=com.azure.storage.blob.models.BlobQueryError&text=BlobQueryError\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.blob.options.BlobQueryOptions.getExpression()"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.getExpression()"
name: "getExpression()"
nameWithType: "BlobQueryOptions.getExpression()"
summary: "Gets the query expression."
syntax: "public String getExpression()"
desc: "Gets the query expression."
returns:
description: "the query expression."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.options.BlobQueryOptions.getInputSerialization()"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.getInputSerialization()"
name: "getInputSerialization()"
nameWithType: "BlobQueryOptions.getInputSerialization()"
summary: "Gets the input serialization."
syntax: "public BlobQuerySerialization getInputSerialization()"
desc: "Gets the input serialization."
returns:
description: "the input serialization."
type: "<xref href=\"com.azure.storage.blob.models.BlobQuerySerialization?alt=com.azure.storage.blob.models.BlobQuerySerialization&text=BlobQuerySerialization\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobQueryOptions.getOutputSerialization()"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.getOutputSerialization()"
name: "getOutputSerialization()"
nameWithType: "BlobQueryOptions.getOutputSerialization()"
summary: "Gets the output serialization."
syntax: "public BlobQuerySerialization getOutputSerialization()"
desc: "Gets the output serialization."
returns:
description: "the output serialization."
type: "<xref href=\"com.azure.storage.blob.models.BlobQuerySerialization?alt=com.azure.storage.blob.models.BlobQuerySerialization&text=BlobQuerySerialization\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobQueryOptions.getOutputStream()"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.getOutputStream()"
name: "getOutputStream()"
nameWithType: "BlobQueryOptions.getOutputStream()"
summary: "Gets the output<wbr>Stream where the downloaded data will be written."
syntax: "public OutputStream getOutputStream()"
desc: "Gets the outputStream where the downloaded data will be written."
returns:
description: "the outputStream."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/OutputStream.html\">OutputStream</a>"
- uid: "com.azure.storage.blob.options.BlobQueryOptions.getProgressConsumer()"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.getProgressConsumer()"
name: "getProgressConsumer()"
nameWithType: "BlobQueryOptions.getProgressConsumer()"
summary: "Gets the progress consumer."
syntax: "public Consumer<BlobQueryProgress> getProgressConsumer()"
desc: "Gets the progress consumer."
returns:
description: "the progress consumer."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.storage.blob.models.BlobQueryProgress?alt=com.azure.storage.blob.models.BlobQueryProgress&text=BlobQueryProgress\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.blob.options.BlobQueryOptions.getRequestConditions()"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.getRequestConditions()"
name: "getRequestConditions()"
nameWithType: "BlobQueryOptions.getRequestConditions()"
summary: "Gets the request conditions."
syntax: "public BlobRequestConditions getRequestConditions()"
desc: "Gets the request conditions."
returns:
description: "the request conditions."
type: "<xref href=\"com.azure.storage.blob.models.BlobRequestConditions?alt=com.azure.storage.blob.models.BlobRequestConditions&text=BlobRequestConditions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobQueryOptions.setErrorConsumer(java.util.function.Consumer<com.azure.storage.blob.models.BlobQueryError>)"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.setErrorConsumer(Consumer<BlobQueryError> errorConsumer)"
name: "setErrorConsumer(Consumer<BlobQueryError> errorConsumer)"
nameWithType: "BlobQueryOptions.setErrorConsumer(Consumer<BlobQueryError> errorConsumer)"
summary: "Sets the error consumer."
parameters:
- description: "The error consumer."
name: "errorConsumer"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.storage.blob.models.BlobQueryError?alt=com.azure.storage.blob.models.BlobQueryError&text=BlobQueryError\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public BlobQueryOptions setErrorConsumer(Consumer<BlobQueryError> errorConsumer)"
desc: "Sets the error consumer."
returns:
description: "the updated BlobQueryOptions object."
type: "<xref href=\"com.azure.storage.blob.options.BlobQueryOptions?alt=com.azure.storage.blob.options.BlobQueryOptions&text=BlobQueryOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobQueryOptions.setInputSerialization(com.azure.storage.blob.models.BlobQuerySerialization)"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.setInputSerialization(BlobQuerySerialization inputSerialization)"
name: "setInputSerialization(BlobQuerySerialization inputSerialization)"
nameWithType: "BlobQueryOptions.setInputSerialization(BlobQuerySerialization inputSerialization)"
summary: "Sets the input serialization."
parameters:
- description: "The input serialization."
name: "inputSerialization"
type: "<xref href=\"com.azure.storage.blob.models.BlobQuerySerialization?alt=com.azure.storage.blob.models.BlobQuerySerialization&text=BlobQuerySerialization\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobQueryOptions setInputSerialization(BlobQuerySerialization inputSerialization)"
desc: "Sets the input serialization."
returns:
description: "the updated BlobQueryOptions object."
type: "<xref href=\"com.azure.storage.blob.options.BlobQueryOptions?alt=com.azure.storage.blob.options.BlobQueryOptions&text=BlobQueryOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobQueryOptions.setOutputSerialization(com.azure.storage.blob.models.BlobQuerySerialization)"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.setOutputSerialization(BlobQuerySerialization outputSerialization)"
name: "setOutputSerialization(BlobQuerySerialization outputSerialization)"
nameWithType: "BlobQueryOptions.setOutputSerialization(BlobQuerySerialization outputSerialization)"
summary: "Sets the output serialization."
parameters:
- description: "The output serialization."
name: "outputSerialization"
type: "<xref href=\"com.azure.storage.blob.models.BlobQuerySerialization?alt=com.azure.storage.blob.models.BlobQuerySerialization&text=BlobQuerySerialization\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobQueryOptions setOutputSerialization(BlobQuerySerialization outputSerialization)"
desc: "Sets the output serialization."
returns:
description: "the updated BlobQueryOptions object."
type: "<xref href=\"com.azure.storage.blob.options.BlobQueryOptions?alt=com.azure.storage.blob.options.BlobQueryOptions&text=BlobQueryOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobQueryOptions.setProgressConsumer(java.util.function.Consumer<com.azure.storage.blob.models.BlobQueryProgress>)"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.setProgressConsumer(Consumer<BlobQueryProgress> progressConsumer)"
name: "setProgressConsumer(Consumer<BlobQueryProgress> progressConsumer)"
nameWithType: "BlobQueryOptions.setProgressConsumer(Consumer<BlobQueryProgress> progressConsumer)"
summary: "Sets the progress consumer."
parameters:
- description: "The progress consumer."
name: "progressConsumer"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.storage.blob.models.BlobQueryProgress?alt=com.azure.storage.blob.models.BlobQueryProgress&text=BlobQueryProgress\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public BlobQueryOptions setProgressConsumer(Consumer<BlobQueryProgress> progressConsumer)"
desc: "Sets the progress consumer."
returns:
description: "the updated BlobQueryOptions object."
type: "<xref href=\"com.azure.storage.blob.options.BlobQueryOptions?alt=com.azure.storage.blob.options.BlobQueryOptions&text=BlobQueryOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.options.BlobQueryOptions.setRequestConditions(com.azure.storage.blob.models.BlobRequestConditions)"
fullName: "com.azure.storage.blob.options.BlobQueryOptions.setRequestConditions(BlobRequestConditions requestConditions)"
name: "setRequestConditions(BlobRequestConditions requestConditions)"
nameWithType: "BlobQueryOptions.setRequestConditions(BlobRequestConditions requestConditions)"
summary: "Sets the request conditions."
parameters:
- description: "The request conditions."
name: "requestConditions"
type: "<xref href=\"com.azure.storage.blob.models.BlobRequestConditions?alt=com.azure.storage.blob.models.BlobRequestConditions&text=BlobRequestConditions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobQueryOptions setRequestConditions(BlobRequestConditions requestConditions)"
desc: "Sets the request conditions."
returns:
description: "the updated BlobQueryOptions object."
type: "<xref href=\"com.azure.storage.blob.options.BlobQueryOptions?alt=com.azure.storage.blob.options.BlobQueryOptions&text=BlobQueryOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Optional parameters for Blob Query."
metadata: {}
package: "com.azure.storage.blob.options"
artifact: com.azure:azure-storage-blob:12.28.1