public sealed class ListObjectsOptionsReference documentation and code samples for the Google Cloud Storage v1 API class ListObjectsOptions.
Options for ListObjects operations.
Namespace
Google.Cloud.Storage.V1Assembly
Google.Cloud.Storage.V1.dll
Properties
Delimiter
public string Delimiter { get; set; }Used to list in "directory mode". Only objects whose names (aside from the prefix) do not contain the delimiter will be returned.
| Property Value | |
|---|---|
| Type | Description |
string | |
EndOffset
public string EndOffset { get; set; }If set, filters results to objects whose names are lexicographically before this value. (Objects whose names are exactly the end offset are excluded.)
| Property Value | |
|---|---|
| Type | Description |
string | |
Fields
public string Fields { get; set; }If set, this specifies the fields to fetch in the result to obtain partial responses, usually to improve performance. For example, to fetch just the name and content type of each object, set this property to "items(name,contentType),nextPageToken". The "nextPageToken" field is required in order to fetch multiple pages; the library does not add this automatically. See https://cloud.google.com/storage/docs/json_api/v1/how-tos/performance#partial for more details on specifying fields for partial responses.
| Property Value | |
|---|---|
| Type | Description |
string | |
IncludeTrailingDelimiter
public bool? IncludeTrailingDelimiter { get; set; }If true, objects that end in exactly one instance of delimiter will have their metadata included in the returned.
| Property Value | |
|---|---|
| Type | Description |
bool | |
MatchGlob
public string MatchGlob { get; set; }A glob pattern used to filter results. See https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-object-glob for more details.
| Property Value | |
|---|---|
| Type | Description |
string | |
PageSize
public int? PageSize { get; set; }The number of results to return per page. (This modifies the per-request page size; it does not affect the total number of results returned.)
| Property Value | |
|---|---|
| Type | Description |
int | |
PageToken
public string PageToken { get; set; }If set, this token is used to indicate a continued list operation.
The value should be taken from the NextPageToken property of either
a Page<TResource> or a raw response from AsRawResponses().
| Property Value | |
|---|---|
| Type | Description |
string | |
Projection
public Projection? Projection { get; set; }The projection to retrieve.
| Property Value | |
|---|---|
| Type | Description |
Projection | |
RetryOptions
public RetryOptions RetryOptions { get; set; }Options to pass custom retry configuration for each API request.
| Property Value | |
|---|---|
| Type | Description |
RetryOptions | |
StartOffset
public string StartOffset { get; set; }If set, filters results to objects whose names are lexicographically equal to or after this value. (Objects whose names are exactly the start offset are included.)
| Property Value | |
|---|---|
| Type | Description |
string | |
UserProject
public string UserProject { get; set; }If set, this is the ID of the project which will be billed for the request. The caller must have suitable permissions for the project being billed.
| Property Value | |
|---|---|
| Type | Description |
string | |
Versions
public bool? Versions { get; set; }Controls whether or not multiple versions of an object are listed separately (true) or not (false). The default API behavior is equivalent to setting this to false, but it is still a nullable property to allow the intention of "definitely false" to be separate from "not set".
| Property Value | |
|---|---|
| Type | Description |
bool | |