5.0.0 (latest) 4.16.0 4.15.0 4.14.0 4.13.0 4.11.0 4.10.0 4.9.0 4.8.0 4.7.0 4.6.0 4.5.0 4.4.0 4.3.0 4.2.0 4.1.0 4.0.0 3.7.0 3.6.0 3.5.0 3.4.0

    public sealed class ListObjectsOptions

Reference documentation and code samples for the Google Cloud Storage v1 API class ListObjectsOptions.

Options for `ListObjects` operations.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> ListObjectsOptions

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.Storage.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1)

## Assembly

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** |
| `https://learn.microsoft.com/dotnet/api/system.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** |
| `https://learn.microsoft.com/dotnet/api/system.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** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Filter

    public string Filter { get; set; }

If set, filters results to include only objects to which the specified context is attached.
If delimiter is set, the returned prefixes are exempt from this filter.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### IncludeFoldersAsPrefixes

    public bool? IncludeFoldersAsPrefixes { get; set; }

If true, will also include folders and managed folders, besides objects, in the returned prefixes.
Only applicable if delimiter is set to '/'.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### 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** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### 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** |
| `https://learn.microsoft.com/dotnet/api/system.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** |
| `https://learn.microsoft.com/dotnet/api/system.int32` |   |

### 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\>](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Page-1.html) or a raw response from [AsRawResponses()](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.PagedEnumerable-2.html#Google_Api_Gax_PagedEnumerable_2_AsRawResponses).

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Projection

    public Projection? Projection { get; set; }

The projection to retrieve.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.Projection` |   |

### RetryOptions

    public RetryOptions RetryOptions { get; set; }

Options to pass custom retry configuration for each API request.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.RetryOptions` |   |

### SoftDeletedOnly

    public bool? SoftDeletedOnly { get; set; }

If true, only soft-deleted object versions will be listed. The default is false.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### 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** |
| `https://learn.microsoft.com/dotnet/api/system.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** |
| `https://learn.microsoft.com/dotnet/api/system.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** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |