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 ListBucketsOptions

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

Options for `ListBuckets` operations.

## Inheritance

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

## 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

### 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 location of each bucket, set this property to
"items(name,location),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` |   |

### 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` |   |

### Prefix

    public string Prefix { get; set; }

The prefix to match. Only buckets with names that start with this string will be returned.

| **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` |   |

### ReturnPartialSuccess

    public bool? ReturnPartialSuccess { get; set; }

If true, buckets from reachable locations are returned. The resource names of buckets from unreachable locations will be available on the `Unreachable`
property of 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). The default is false.

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

### SoftDeletedOnly

    public bool? SoftDeletedOnly { get; set; }

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

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