106 строки
8.0 KiB
YAML
106 строки
8.0 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.blob.models.ListBlobsOptions"
|
|
fullName: "com.azure.storage.blob.models.ListBlobsOptions"
|
|
name: "ListBlobsOptions"
|
|
nameWithType: "ListBlobsOptions"
|
|
summary: "Defines options available to configure the behavior of a call to list<wbr>Blobs<wbr>Flat<wbr>Segment on a <xref uid=\"com.azure.storage.blob.BlobContainerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerClient\"></xref> object."
|
|
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 final class **ListBlobsOptions**"
|
|
constructors:
|
|
- uid: "com.azure.storage.blob.models.ListBlobsOptions.ListBlobsOptions()"
|
|
fullName: "com.azure.storage.blob.models.ListBlobsOptions.ListBlobsOptions()"
|
|
name: "ListBlobsOptions()"
|
|
nameWithType: "ListBlobsOptions.ListBlobsOptions()"
|
|
summary: "Constructs an unpopulated <xref uid=\"com.azure.storage.blob.models.ListBlobsOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ListBlobsOptions\"></xref>."
|
|
syntax: "public ListBlobsOptions()"
|
|
desc: "Constructs an unpopulated <xref uid=\"com.azure.storage.blob.models.ListBlobsOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ListBlobsOptions\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.storage.blob.models.ListBlobsOptions.getDetails()"
|
|
fullName: "com.azure.storage.blob.models.ListBlobsOptions.getDetails()"
|
|
name: "getDetails()"
|
|
nameWithType: "ListBlobsOptions.getDetails()"
|
|
syntax: "public BlobListDetails getDetails()"
|
|
returns:
|
|
description: "the details for listing specific blobs"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobListDetails?alt=com.azure.storage.blob.models.BlobListDetails&text=BlobListDetails\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.models.ListBlobsOptions.getMaxResultsPerPage()"
|
|
fullName: "com.azure.storage.blob.models.ListBlobsOptions.getMaxResultsPerPage()"
|
|
name: "getMaxResultsPerPage()"
|
|
nameWithType: "ListBlobsOptions.getMaxResultsPerPage()"
|
|
summary: "Specifies the maximum number of blobs to return, including all Blob<wbr>Prefix elements."
|
|
syntax: "public Integer getMaxResultsPerPage()"
|
|
desc: "Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items."
|
|
returns:
|
|
description: "the number of blobs that will be returned in a single response"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.storage.blob.models.ListBlobsOptions.getPrefix()"
|
|
fullName: "com.azure.storage.blob.models.ListBlobsOptions.getPrefix()"
|
|
name: "getPrefix()"
|
|
nameWithType: "ListBlobsOptions.getPrefix()"
|
|
summary: "Filters the results to return only blobs whose names begin with the specified prefix."
|
|
syntax: "public String getPrefix()"
|
|
desc: "Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs."
|
|
returns:
|
|
description: "the prefix that a blob must match to be returned in the listing"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.blob.models.ListBlobsOptions.setDetails(com.azure.storage.blob.models.BlobListDetails)"
|
|
fullName: "com.azure.storage.blob.models.ListBlobsOptions.setDetails(BlobListDetails details)"
|
|
name: "setDetails(BlobListDetails details)"
|
|
nameWithType: "ListBlobsOptions.setDetails(BlobListDetails details)"
|
|
parameters:
|
|
- description: "The details for listing specific blobs"
|
|
name: "details"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobListDetails?alt=com.azure.storage.blob.models.BlobListDetails&text=BlobListDetails\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ListBlobsOptions setDetails(BlobListDetails details)"
|
|
returns:
|
|
description: "the updated ListBlobsOptions object"
|
|
type: "<xref href=\"com.azure.storage.blob.models.ListBlobsOptions?alt=com.azure.storage.blob.models.ListBlobsOptions&text=ListBlobsOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.models.ListBlobsOptions.setMaxResultsPerPage(java.lang.Integer)"
|
|
fullName: "com.azure.storage.blob.models.ListBlobsOptions.setMaxResultsPerPage(Integer maxResultsPerPage)"
|
|
name: "setMaxResultsPerPage(Integer maxResultsPerPage)"
|
|
nameWithType: "ListBlobsOptions.setMaxResultsPerPage(Integer maxResultsPerPage)"
|
|
summary: "Specifies the maximum number of blobs to return, including all Blob<wbr>Prefix elements."
|
|
parameters:
|
|
- description: "The number of blobs to returned in a single response"
|
|
name: "maxResultsPerPage"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ListBlobsOptions setMaxResultsPerPage(Integer maxResultsPerPage)"
|
|
desc: "Specifies the maximum number of blobs to return, including all BlobPrefix elements. If the request does not specify maxResultsPerPage or specifies a value greater than 5,000, the server will return up to 5,000 items."
|
|
returns:
|
|
description: "the updated ListBlobsOptions object"
|
|
type: "<xref href=\"com.azure.storage.blob.models.ListBlobsOptions?alt=com.azure.storage.blob.models.ListBlobsOptions&text=ListBlobsOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.models.ListBlobsOptions.setPrefix(java.lang.String)"
|
|
fullName: "com.azure.storage.blob.models.ListBlobsOptions.setPrefix(String prefix)"
|
|
name: "setPrefix(String prefix)"
|
|
nameWithType: "ListBlobsOptions.setPrefix(String prefix)"
|
|
summary: "Filters the results to return only blobs whose names begin with the specified prefix."
|
|
parameters:
|
|
- description: "A prefix that a blob must match to be returned"
|
|
name: "prefix"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ListBlobsOptions setPrefix(String prefix)"
|
|
desc: "Filters the results to return only blobs whose names begin with the specified prefix. May be null to return all blobs."
|
|
returns:
|
|
description: "the updated ListBlobsOptions object"
|
|
type: "<xref href=\"com.azure.storage.blob.models.ListBlobsOptions?alt=com.azure.storage.blob.models.ListBlobsOptions&text=ListBlobsOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Defines options available to configure the behavior of a call to listBlobsFlatSegment on a <xref uid=\"com.azure.storage.blob.BlobContainerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerClient\"></xref> object. See the constructor for details on each of the options."
|
|
metadata: {}
|
|
package: "com.azure.storage.blob.models"
|
|
artifact: com.azure:azure-storage-blob:12.27.1
|