Prefix Property
A prefix used to restrict the results returned when listing blobs or containers.
Syntax
public String getPrefix(); public void setPrefix(String prefix);
Remarks
This property, if non-empty, is used to restrict the results returned by ListBlobs or ListContainers to only the items whose names begin with the given value.
Blob Namespace Traversal
By using the BlobDelimiter and Prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of blobs as if it were a filesystem. For example, assume that blobs with the following names exist within a container:
- MyCompany
- MyCompany/Department1
- MyCompany/Department2
- MyCompany/Department2/EmployeeA
- MyCompany/Department2/EmployeeB
With BlobDelimiter set to /, we can set Prefix to successively "deeper" values before calling ListBlobs for the following effect:
Prefix Value | Blobs Returned | Prefixes Returned |
(empty) | MyCompany | MyCompany/ |
MyCompany/ | MyCompany/Department1 MyCompany/Department2 | MyCompany/Department2/ |
MyCompany/Department2/ | MyCompany/Department2/EmployeeA MyCompany/Department2/EmployeeB | (none) |
This property is not available at design time.
Default Value
""