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 abstract class StorageClient : IDisposable

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

Abstract class providing operations for Google Cloud Storage.

## Inheritance

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

## Implements

[IDisposable](https://learn.microsoft.com/dotnet/api/system.idisposable)

## 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.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Derived Types

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

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

## Remarks


This abstract class is provided to enable testability while permitting
additional operations to be added in the future. See [Create(GoogleCredential, EncryptionKey)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_Create_Google_Apis_Auth_OAuth2_GoogleCredential_Google_Cloud_Storage_V1_EncryptionKey_)
and [CreateAsync(GoogleCredential, EncryptionKey)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_CreateAsync_Google_Apis_Auth_OAuth2_GoogleCredential_Google_Cloud_Storage_V1_EncryptionKey_) to construct instances; alternatively, you can
construct a [StorageClientImpl](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClientImpl) directly from a [StorageService](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.StorageService.html).


All instance methods declared in this class are virtual, with an implementation which simply
throws [NotImplementedException](https://learn.microsoft.com/dotnet/api/system.notimplementedexception). All these methods are overridden in [StorageClientImpl](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClientImpl).


This class implements [IDisposable](https://learn.microsoft.com/dotnet/api/system.idisposable); however, the [Dispose()](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_Dispose) method only requires calling
if many short-lived instances of [StorageClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient) are being created.
Most code would be expected to create a single `StorageClient` instance, and use this instance throughout
the lifetime of the application. In this case, `Dispose` need not be called.

## Properties

### EncryptionKey

    public virtual EncryptionKey EncryptionKey { get; }

The customer-supplied encryption key used by default for all relevant object-based operations. This can be overridden in call-specific options.
This will never return null in the built-in implementation; if no encryption key is specified,
[None](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.EncryptionKey#Google_Cloud_Storage_V1_EncryptionKey_None) is returned.

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

### Service

    public virtual StorageService Service { get; }

The underlying storage service object used by this client.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.StorageService.html` |   |

**Remarks** The [StorageClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient) class only provides convenience operations built on top of
an existing service object. Any more complex operations which are not supported by this wrapper may wish
to use the same service object as the wrapper, in order to take advantage of its configuration (for authentication,
application naming etc).

## Methods

### ClearBucketLabels(string, ModifyBucketLabelsOptions)

    public virtual IDictionary<string, string> ClearBucketLabels(string bucket, ModifyBucketLabelsOptions options = null)

Clears all labels on a bucket.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ModifyBucketLabelsOptions` The options for the operation. May be null, in which case defaults will be supplied. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.collections.generic.idictionary-2https://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` | A dictionary with the labels on the bucket before they were cleared. |

**Example**

    StorageClient client = StorageClient.Create();

    IDictionary<string, string> oldLabels = client.ClearBucketLabels(bucketName);
    Console.WriteLine($"Number of labels before clearing: {oldLabels.Count}");

### ClearBucketLabelsAsync(string, ModifyBucketLabelsOptions, CancellationToken)

    public virtual Task<IDictionary<string, string>> ClearBucketLabelsAsync(string bucket, ModifyBucketLabelsOptions options = null, CancellationToken cancellationToken = default)

Clears all labels on a bucket asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ModifyBucketLabelsOptions` The options for the operation. May be null, in which case defaults will be supplied. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://learn.microsoft.com/dotnet/api/system.collections.generic.idictionary-2https://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` | A dictionary with the labels on the bucket before they were cleared. |

**Example**

See [ClearBucketLabels](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_ClearBucketLabels_System_String_Google_Cloud_Storage_V1_ModifyBucketLabelsOptions_) for a synchronous example.

### CopyObject(string, string, string, string, CopyObjectOptions)

    public virtual Object CopyObject(string sourceBucket, string sourceObjectName, string destinationBucket, string destinationObjectName, CopyObjectOptions options = null)

Creates a copy of an object synchronously, potentially to a different bucket. This method uses the
`rewriteObject` underlying API operation for more flexibility and reliability.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `sourceBucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object to copy. Must not be null. |
| `sourceObjectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object to copy within the bucket. Must not be null. |
| `destinationBucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket to copy the object to. Must not be null. |
| `destinationObjectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object within the destination bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.CopyObjectOptions` Additional options for the copy operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | The [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the new storage object resulting from the copy. |

**Example**

    StorageClient client = StorageClient.Create();
    string sourceName = "greetings/hello.txt";
    string destinationName = "copy.txt";

    // This method actually uses the "rewrite" API operation, for added reliability
    // when copying large objects across locations, storage classes or encryption keys.
    client.CopyObject(sourceBucket, sourceName, destinationBucket, destinationName);

### CopyObjectAsync(string, string, string, string, CopyObjectOptions, CancellationToken)

    public virtual Task<Object> CopyObjectAsync(string sourceBucket, string sourceObjectName, string destinationBucket = null, string destinationObjectName = null, CopyObjectOptions options = null, CancellationToken cancellationToken = default)

Creates a copy of an object asynchronously, potentially to a different bucket. This method uses the
`rewriteObject` underlying API operation for more flexibility and reliability.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `sourceBucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object to copy. Must not be null. |
| `sourceObjectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object to copy within the bucket. Must not be null. |
| `destinationBucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket to copy the object to. Must not be null. |
| `destinationObjectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object within the destination bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.CopyObjectOptions` Additional options for the copy operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | A task representing the asynchronous operation, with a result returning the [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the new storage object resulting from the copy. |

**Remarks** The fact that `destinationBucket` and `destinationObjectName` are
optional is a mistake. The default value of null for these parameters is invalid for this method,
meaning that any call which doesn't specify the parameters explicitly will fail. Making these parameters
required would be a compile-time breaking change; this will be implemented in the next major version of this library.
**Example**

See [CopyObject](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_CopyObject_System_String_System_String_System_String_System_String_Google_Cloud_Storage_V1_CopyObjectOptions_) for a synchronous example.

### Create()

    public static StorageClient Create()

Synchronously creates a [StorageClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient) using application default credentials.
For any non-default values, please use [StorageClientBuilder](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClientBuilder).

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

### Create(GoogleCredential, EncryptionKey)

    public static StorageClient Create(GoogleCredential credential = null, EncryptionKey encryptionKey = null)

Synchronously creates a [StorageClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient), using application default credentials if
no credentials are specified.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `credential` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Auth.OAuth2.GoogleCredential.html` Optional [GoogleCredential](https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Auth.OAuth2.GoogleCredential.html). If this is non-null, default scopes are applied to it (for credential types that support scoping), overriding any existing scopes in the credentials. To use scoped credentials without any modifications, create a [StorageClientBuilder](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClientBuilder) and set the [Credential](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Rest.ClientBuilderBase-1.html#Google_Api_Gax_Rest_ClientBuilderBase_1_Credential) property. |
| `encryptionKey` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.EncryptionKey` Optional [EncryptionKey](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_EncryptionKey) to use for all relevant object-based operations by default. May be null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient` | The created [StorageClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient). |

**Remarks** If a credential is supplied, the default scopes are applied to it (for credential types that support scoping),
overriding any existing scopes in the credentials. To use scoped credentials without any modifications, create
a [StorageClientBuilder](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClientBuilder) and set the [Credential](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Rest.ClientBuilderBase-1.html#Google_Api_Gax_Rest_ClientBuilderBase_1_Credential) property.

### CreateAsync()

    public static Task<StorageClient> CreateAsync()

Asynchronously creates a [StorageClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient) using application default credentials.
For any non-default values, please use [StorageClientBuilder](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClientBuilder).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient` | The task representing the created [StorageClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient). |

### CreateAsync(GoogleCredential, EncryptionKey)

    public static Task<StorageClient> CreateAsync(GoogleCredential credential = null, EncryptionKey encryptionKey = null)

Asynchronously creates a [StorageClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient), using application default credentials if
no credentials are specified.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `credential` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Auth.OAuth2.GoogleCredential.html` Optional [GoogleCredential](https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Auth.OAuth2.GoogleCredential.html). If this is non-null, default scopes are applied to it (for credential types that support scoping), overriding any existing scopes in the credentials. To use scoped credentials without any modifications, create a [StorageClientBuilder](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClientBuilder) and set the [Credential](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Rest.ClientBuilderBase-1.html#Google_Api_Gax_Rest_ClientBuilderBase_1_Credential) property. |
| `encryptionKey` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.EncryptionKey` Optional [EncryptionKey](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_EncryptionKey) to use for all relevant object-based operations by default. May be null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient` | The task representing the created [StorageClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient). |

**Remarks** If a credential is supplied, the default scopes are applied to it (for credential types that support scoping),
overriding any existing scopes in the credentials. To use scoped credentials without any modifications, create
a [StorageClientBuilder](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClientBuilder) and set the [Credential](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.Rest.ClientBuilderBase-1.html#Google_Api_Gax_Rest_ClientBuilderBase_1_Credential) property.

### CreateBucket(string, Bucket, CreateBucketOptions)

    public virtual Bucket CreateBucket(string projectId, Bucket bucket, CreateBucketOptions options = null)

Creates a storage bucket synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The ID of the project to create the buckets in. Must not be null. |
| `bucket` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` The resource representation of the bucket to create. Must not be null, and must have a name. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.CreateBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | The resource representation of the newly-created bucket. |

**Example**

See [CreateBucket](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_CreateBucket_System_String_System_String_Google_Cloud_Storage_V1_CreateBucketOptions_) for an example using an alternative overload.

### CreateBucket(string, string, CreateBucketOptions)

    public virtual Bucket CreateBucket(string projectId, string bucket, CreateBucketOptions options = null)

Creates a storage bucket synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The ID of the project to create the buckets in. Must not be null. |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket to create. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.CreateBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | The resource representation of the newly-created bucket. |

**Example**

    var client = StorageClient.Create();

    // GCS bucket names must be globally unique
    var bucketName = Guid.NewGuid().ToString();

    // Bucket defined in Google.Apis.Storage.v1.Data namespace
    var bucket = client.CreateBucket(projectId, bucketName);

### CreateBucketAsync(string, Bucket, CreateBucketOptions, CancellationToken)

    public virtual Task<Bucket> CreateBucketAsync(string projectId, Bucket bucket, CreateBucketOptions options = null, CancellationToken cancellationToken = default)

Creates a storage bucket asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The ID of the project to create the buckets in. Must not be null. |
| `bucket` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` The resource representation of the bucket to create. Must not be null, and must have a name. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.CreateBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | A task representing the asynchronous operation, with a result returning the resource representation of the newly-created bucket. |

**Example**

See [CreateBucket](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_CreateBucket_System_String_System_String_Google_Cloud_Storage_V1_CreateBucketOptions_) for a synchronous example.

### CreateBucketAsync(string, string, CreateBucketOptions, CancellationToken)

    public virtual Task<Bucket> CreateBucketAsync(string projectId, string bucket, CreateBucketOptions options = null, CancellationToken cancellationToken = default)

Creates a storage bucket asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The ID of the project to create the buckets in. Must not be null. |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket to create. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.CreateBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | A task representing the asynchronous operation, with a result returning the resource representation of the newly-created bucket. |

**Example**

See [CreateBucket](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_CreateBucket_System_String_System_String_Google_Cloud_Storage_V1_CreateBucketOptions_) for a synchronous example.

### CreateHmacKey(string, string, CreateHmacKeyOptions)

    public virtual HmacKey CreateHmacKey(string projectId, string serviceAccountEmail, CreateHmacKeyOptions options = null)

Synchronously creates a new HMAC key associated with a service account.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The project ID in which to create the HMAC key. Must not be null. |
| `serviceAccountEmail` | `https://learn.microsoft.com/dotnet/api/system.string` The service account to associate with the HMAC key. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.CreateHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKey.html` | The new HMAC key, including the secret information in [Secret](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKey.html#Google_Apis_Storage_v1_Data_HmacKey_Secret). This secret is only ever returned when creating a key. |

### CreateHmacKeyAsync(string, string, CreateHmacKeyOptions, CancellationToken)

    public virtual Task<HmacKey> CreateHmacKeyAsync(string projectId, string serviceAccountEmail, CreateHmacKeyOptions options = null, CancellationToken cancellationToken = default)

Asynchronously creates a new HMAC key associated with a service account.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The project ID in which to create the HMAC key. Must not be null. |
| `serviceAccountEmail` | `https://learn.microsoft.com/dotnet/api/system.string` The service account to associate with the HMAC key. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.CreateHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKey.html` | A task representing the asynchronous operation, with a result returning the the new HMAC key, including the secret information in [Secret](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKey.html#Google_Apis_Storage_v1_Data_HmacKey_Secret). This secret is only ever returned when creating a key. |

### CreateNotification(string, Notification, CreateNotificationOptions)

    public virtual Notification CreateNotification(string bucket, Notification notification, CreateNotificationOptions options = null)

Creates a notification configuration.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The bucket for which to create the notification configuration. Must not be null. |
| `notification` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Notification.html` The notification configuration to create. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.CreateNotificationOptions` The options for the operation. May be null, in which case defaults will be supplied. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Notification.html` | The [Notification](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Notification.html) representation of the newly-created notification configuration. |

**Example**

    TopicName topicName = new TopicName(projectId, topicId);
    StorageClient client = StorageClient.Create();
    Notification notification = new Notification
    {
        Topic = $"//pubsub.googleapis.com/{topicName}",
        PayloadFormat = "JSON_API_V1"
    };
    notification = client.CreateNotification(bucket, notification);
    Console.WriteLine($"Created notification ID: {notification.Id}");

### CreateNotificationAsync(string, Notification, CreateNotificationOptions, CancellationToken)

    public virtual Task<Notification> CreateNotificationAsync(string bucket, Notification notification, CreateNotificationOptions options = null, CancellationToken cancellationToken = default)

Asynchronously creates a notification configuration.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The bucket for which to create the notification configuration. Must not be null. |
| `notification` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Notification.html` The notification configuration to create. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.CreateNotificationOptions` The options for the operation. May be null, in which case defaults will be supplied. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Notification.html` | A task representing the asynchronous operation, with a result returning the [Notification](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Notification.html) representation of the newly-created notification configuration. |

**Example**

See [CreateNotification](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_CreateNotification_System_String_Google_Apis_Storage_v1_Data_Notification_Google_Cloud_Storage_V1_CreateNotificationOptions_) for a synchronous example.

### CreateObjectUploader(Object, Stream, UploadObjectOptions)

    public virtual ObjectsResource.InsertMediaUpload CreateObjectUploader(Object destination, Stream source, UploadObjectOptions options = null)

Creates an instance which is capable of starting a resumable upload for an object.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `destination` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` Object to create or update. Must not be null, and must have the name and bucket populated. |
| `source` | `https://learn.microsoft.com/dotnet/api/system.io.stream` The stream to read the data from. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.ObjectsResource.htmlhttps://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.ObjectsResource.InsertMediaUpload.html` | The [ObjectsResource.InsertMediaUpload](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.ObjectsResource.InsertMediaUpload.html) which can be used to upload the object. |

**See Also** [UploadObject(Object, Stream, UploadObjectOptions, IProgress\<IUploadProgress\>)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_UploadObject_Google_Apis_Storage_v1_Data_Object_System_IO_Stream_Google_Cloud_Storage_V1_UploadObjectOptions_System_IProgress_Google_Apis_Upload_IUploadProgress__)

### CreateObjectUploader(string, string, string, Stream, UploadObjectOptions)

    public virtual ObjectsResource.InsertMediaUpload CreateObjectUploader(string bucket, string objectName, string contentType, Stream source, UploadObjectOptions options = null)

Creates an instance which is capable of starting a resumable upload for an object.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object. Must not be null. |
| `objectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object within the bucket. Must not be null. |
| `contentType` | `https://learn.microsoft.com/dotnet/api/system.string` The content type of the object. This should be a MIME type such as "text/html" or "application/octet-stream". May be null. |
| `source` | `https://learn.microsoft.com/dotnet/api/system.io.stream` The stream to read the data from. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.ObjectsResource.htmlhttps://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.ObjectsResource.InsertMediaUpload.html` | The [ObjectsResource.InsertMediaUpload](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.ObjectsResource.InsertMediaUpload.html) which can be used to upload the object. |

**See Also** [UploadObject(Object, Stream, UploadObjectOptions, IProgress\<IUploadProgress\>)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_UploadObject_Google_Apis_Storage_v1_Data_Object_System_IO_Stream_Google_Cloud_Storage_V1_UploadObjectOptions_System_IProgress_Google_Apis_Upload_IUploadProgress__)

### CreateUnauthenticated()

    public static StorageClient CreateUnauthenticated()

Creates a [StorageClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient) with no credentials. This can only be used in limited
situations (where authentication isn't required), primarily downloading public data.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient` | The created [StorageClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient). |

### CreateUrlSigner()

    public UrlSigner CreateUrlSigner()

Creates a URL signer based on this client, that uses the same credential as this client, as well
as defaulting to this client's URI scheme, host and port.

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

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.invalidoperationexception` | If the credential used by this client is not compatible with [UrlSigner](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UrlSigner). See [UrlSigner](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UrlSigner)'s documentation for more information on compatible credentials. |

### DeleteBucket(Bucket, DeleteBucketOptions)

    public virtual void DeleteBucket(Bucket bucket, DeleteBucketOptions options = null)

Deletes a bucket synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` Bucket to delete. Must not be null, and must have the name populated. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

**Example**

See [DeleteBucket](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_DeleteBucket_System_String_Google_Cloud_Storage_V1_DeleteBucketOptions_) for an example using an alternative overload.

### DeleteBucket(string, DeleteBucketOptions)

    public virtual void DeleteBucket(string bucket, DeleteBucketOptions options = null)

Deletes a bucket synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket to delete. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

**Example**

    var client = StorageClient.Create();

    client.DeleteBucket(bucketName);

### DeleteBucketAsync(Bucket, DeleteBucketOptions, CancellationToken)

    public virtual Task DeleteBucketAsync(Bucket bucket, DeleteBucketOptions options = null, CancellationToken cancellationToken = default)

Deletes bucket asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` Bucket to delete. Must not be null, and must have the name populated. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task` | A task representing the asynchronous operation. |

**Example**

See [DeleteBucket](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_DeleteBucket_System_String_Google_Cloud_Storage_V1_DeleteBucketOptions_) for a synchronous example.

### DeleteBucketAsync(string, DeleteBucketOptions, CancellationToken)

    public virtual Task DeleteBucketAsync(string bucket, DeleteBucketOptions options = null, CancellationToken cancellationToken = default)

Deletes a bucket asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket to delete. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task` | A task representing the asynchronous operation. |

**Example**

See [DeleteBucket](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_DeleteBucket_System_String_Google_Cloud_Storage_V1_DeleteBucketOptions_) for a synchronous example.

### DeleteHmacKey(string, string, DeleteHmacKeyOptions)

    public virtual void DeleteHmacKey(string projectId, string accessId, DeleteHmacKeyOptions options = null)

Synchronously deletes an HMAC key, which must already have been deactivated.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The ID of the project containing the HMAC key to delete. |
| `accessId` | `https://learn.microsoft.com/dotnet/api/system.string` The ID of the HMAC key to delete. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

### DeleteHmacKeyAsync(string, string, DeleteHmacKeyOptions, CancellationToken)

    public virtual Task DeleteHmacKeyAsync(string projectId, string accessId, DeleteHmacKeyOptions options = null, CancellationToken cancellationToken = default)

Asynchronously deletes an HMAC key, which must already have been deactivated.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The ID of the project containing the HMAC key to delete. |
| `accessId` | `https://learn.microsoft.com/dotnet/api/system.string` The ID of the HMAC key to delete. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task` | A task representing the asynchronous operation. |

### DeleteNotification(string, string, DeleteNotificationOptions)

    public virtual void DeleteNotification(string bucket, string notificationId, DeleteNotificationOptions options = null)

Deletes a notification configuration.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The bucket associated with the notification configuration. Must not be null. |
| `notificationId` | `https://learn.microsoft.com/dotnet/api/system.string` ID of the notification configuration to delete. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteNotificationOptions` The options for the operation. May be null, in which case defaults will be supplied. |

**Example**

    StorageClient client = StorageClient.Create();
    client.DeleteNotification(bucket, notificationId);

### DeleteNotificationAsync(string, string, DeleteNotificationOptions, CancellationToken)

    public virtual Task DeleteNotificationAsync(string bucket, string notificationId, DeleteNotificationOptions options = null, CancellationToken cancellationToken = default)

Asynchronously deletes a notification configuration.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The bucket associated with the notification configuration. Must not be null. |
| `notificationId` | `https://learn.microsoft.com/dotnet/api/system.string` ID of the notification configuration to delete. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteNotificationOptions` The options for the operation. May be null, in which case defaults will be supplied. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task` | A task representing the asynchronous operation. |

**Example**

See [DeleteNotification](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_DeleteNotification_System_String_System_String_Google_Cloud_Storage_V1_DeleteNotificationOptions_) for a synchronous example.

### DeleteObject(Object, DeleteObjectOptions)

    public virtual void DeleteObject(Object obj, DeleteObjectOptions options = null)

Deletes a version of the specified object synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `obj` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` Object to delete. Must not be null, and must have the name and bucket populated. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteObjectOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

**Remarks**
By default this will delete the latest version of the object, but this can be
controlled using [Generation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteObjectOptions#Google_Cloud_Storage_V1_DeleteObjectOptions_Generation). Note that any generation information
contained within `obj` is ignored; the generation to delete is only controlled
via `options`. For buckets that support
multiple versions, implicitly deleting the latest version only archives
it so the object is still available and can be listed by specifying [Versions](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ListObjectsOptions#Google_Cloud_Storage_V1_ListObjectsOptions_Versions).
If the version is explicitly specified, the object is permanently deleted.


If the bucket containing the object supports versioning, after this operation
completes successfully there may still be another version of the same object. In buckets which
do not support versioning, this operation will permanently delete the object.


If the request attempts to delete an object that does not exist or a specific version that does
not exist, this counts as a failure with an HTTP status code of 404.
**Example**

See [DeleteObject](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_DeleteObject_System_String_System_String_Google_Cloud_Storage_V1_DeleteObjectOptions_) for an example using an alternative overload.

### DeleteObject(string, string, DeleteObjectOptions)

    public virtual void DeleteObject(string bucket, string objectName, DeleteObjectOptions options = null)

Deletes a version of the specified object synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object. Must not be null. |
| `objectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object within the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteObjectOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

**Remarks**
By default this will delete the latest version of the object, but this can be
controlled using [Generation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteObjectOptions#Google_Cloud_Storage_V1_DeleteObjectOptions_Generation). For buckets that support
multiple versions, implicitly deleting the latest version only archives
it so the object is still available and can be listed by specifying [Versions](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ListObjectsOptions#Google_Cloud_Storage_V1_ListObjectsOptions_Versions).
If the version is explicitly specified, the object is permanently deleted.


If the bucket containing the object supports versioning, after this operation
completes successfully there may still be another version of the same object. In buckets which
do not support versioning, this operation will permanently delete the object.


If the request attempts to delete an object that does not exist or a specific version that does
not exist, this counts as a failure with an HTTP status code of 404.
**Example**

    var client = StorageClient.Create();
    var objectName = "places/deleteme.txt";

    client.DeleteObject(bucketName, objectName);

### DeleteObjectAsync(Object, DeleteObjectOptions, CancellationToken)

    public virtual Task DeleteObjectAsync(Object obj, DeleteObjectOptions options = null, CancellationToken cancellationToken = default)

Deletes a version of the specified object asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `obj` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` Object to delete. Must not be null, and must have the name and bucket populated. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteObjectOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task` | A task representing the asynchronous operation. |

**Remarks**
By default this will delete the latest version of the object, but this can be
controlled using [Generation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteObjectOptions#Google_Cloud_Storage_V1_DeleteObjectOptions_Generation). Note that any generation information
contained within `obj` is ignored; the generation to delete is only controlled
via `options`. For buckets that support
multiple versions, implicitly deleting the latest version only archives
it so the object is still available and can be listed by specifying [Versions](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ListObjectsOptions#Google_Cloud_Storage_V1_ListObjectsOptions_Versions).
If the version is explicitly specified, the object is permanently deleted.


If the bucket containing the object supports versioning, after this operation
completes successfully there may still be another version of the same object. In buckets which
do not support versioning, this operation will permanently delete the object.


If the request attempts to delete an object that does not exist or a specific version that does
not exist, this counts as a failure with an HTTP status code of 404.
**Example**

See [DeleteObject](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_DeleteObject_System_String_System_String_Google_Cloud_Storage_V1_DeleteObjectOptions_) for a synchronous example.

### DeleteObjectAsync(string, string, DeleteObjectOptions, CancellationToken)

    public virtual Task DeleteObjectAsync(string bucket, string objectName, DeleteObjectOptions options = null, CancellationToken cancellationToken = default)

Deletes a version of the specified object asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object. Must not be null. |
| `objectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object within the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteObjectOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task` | A task representing the asynchronous operation. |

**Remarks**
By default this will delete the latest version of the object, but this can be
controlled using [Generation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DeleteObjectOptions#Google_Cloud_Storage_V1_DeleteObjectOptions_Generation). For buckets that support
multiple versions, implicitly deleting the latest version only archives
it so the object is still available and can be listed by specifying [Versions](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ListObjectsOptions#Google_Cloud_Storage_V1_ListObjectsOptions_Versions).
If the version is explicitly specified, the object is permanently deleted.


If the bucket containing the object supports versioning, after this operation
completes successfully there may still be another version of the same object. In buckets which
do not support versioning, this operation will permanently delete the object.


If the request attempts to delete an object that does not exist or a specific version that does
not exist, this counts as a failure with an HTTP status code of 404.
**Example**

See [DeleteObject](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_DeleteObject_System_String_System_String_Google_Cloud_Storage_V1_DeleteObjectOptions_) for a synchronous example.

### Dispose()

    public virtual void Dispose()

Dispose of this instance. See the [StorageClient](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient) remarks on when this should be called.

### DownloadObject(Object, Stream, DownloadObjectOptions, IProgress\<IDownloadProgress\>)

    public virtual Object DownloadObject(Object source, Stream destination, DownloadObjectOptions options = null, IProgress<IDownloadProgress> progress = null)

Downloads the data for an object from storage synchronously, into a specified stream.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `source` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` Source object to download the data from. Must not be null. |
| `destination` | `https://learn.microsoft.com/dotnet/api/system.io.stream` The stream to write the data into. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DownloadObjectOptions` Additional options for the download. May be null, in which case appropriate defaults will be used. |
| `progress` | `https://learn.microsoft.com/dotnet/api/system.iprogress-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Download.IDownloadProgress.html` Progress reporter for the download. May be null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | An [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the metadata for the object that has been downloaded into the stream. This metadata is not the complete metadata for the object; it's just the information provided in headers while downloading. Additionally, the CRC32C hash is only the hash of the data downloaded; if the options specify a range which does not encompass the whole object, this will not be the same as the CRC32C hash of the complete object. |

**Remarks** The generation number within `source` is ignored by this method.
To download a specific generation, use [Generation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DownloadObjectOptions#Google_Cloud_Storage_V1_DownloadObjectOptions_Generation).
**Example**

See [DownloadObject](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_DownloadObject_System_String_System_String_System_IO_Stream_Google_Cloud_Storage_V1_DownloadObjectOptions_System_IProgress_Google_Apis_Download_IDownloadProgress__) for an example using an alternative overload.

### DownloadObject(string, string, Stream, DownloadObjectOptions, IProgress\<IDownloadProgress\>)

    public virtual Object DownloadObject(string bucket, string objectName, Stream destination, DownloadObjectOptions options = null, IProgress<IDownloadProgress> progress = null)

Downloads the data for an object from storage synchronously, into a specified stream.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object. Must not be null. |
| `objectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object within the bucket. Must not be null. |
| `destination` | `https://learn.microsoft.com/dotnet/api/system.io.stream` The stream to write the data into. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DownloadObjectOptions` Additional options for the download. May be null, in which case appropriate defaults will be used. |
| `progress` | `https://learn.microsoft.com/dotnet/api/system.iprogress-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Download.IDownloadProgress.html` Progress reporter for the download. May be null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | An [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the metadata for the object that has been downloaded into the stream. This metadata is not the complete metadata for the object; it's just the information provided in headers while downloading. Additionally, the CRC32C hash is only the hash of the data downloaded; if the options specify a range which does not encompass the whole object, this will not be the same as the CRC32C hash of the complete object. |

**Example**

    var client = StorageClient.Create();
    var source = "greetings/hello.txt";
    var destination = "hello.txt";

    using (var stream = File.Create(destination))
    {
        // IDownloadProgress defined in Google.Apis.Download namespace
        var progress = new Progress<IDownloadProgress>(
            p => Console.WriteLine($"bytes: {p.BytesDownloaded}, status: {p.Status}")
        );

        // Download source object from bucket to local file system
        client.DownloadObject(bucketName, source, stream, null, progress);
    }

### DownloadObjectAsync(Object, Stream, DownloadObjectOptions, CancellationToken, IProgress\<IDownloadProgress\>)

    public virtual Task<Object> DownloadObjectAsync(Object source, Stream destination, DownloadObjectOptions options = null, CancellationToken cancellationToken = default, IProgress<IDownloadProgress> progress = null)

Downloads the data for an object from storage asynchronously, into a specified stream.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `source` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` Source object to download the data from. Must not be null. |
| `destination` | `https://learn.microsoft.com/dotnet/api/system.io.stream` The stream to write the data into. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DownloadObjectOptions` Additional options for the download. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |
| `progress` | `https://learn.microsoft.com/dotnet/api/system.iprogress-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Download.IDownloadProgress.html` Progress reporter for the download. May be null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | A task representing the asynchronous operation. The result of the task is an [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the metadata for the object that has been downloaded into the stream. This metadata is not the complete metadata for the object; it's just the information provided in headers while downloading. Additionally, the CRC32C hash is only the hash of the data downloaded; if the options specify a range which does not encompass the whole object, this will not be the same as the CRC32C hash of the complete object. |

**Remarks** The generation number within `source` is ignored by this method.
To download a specific generation, use [Generation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DownloadObjectOptions#Google_Cloud_Storage_V1_DownloadObjectOptions_Generation).
**Example**

See [DownloadObject](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_DownloadObject_System_String_System_String_System_IO_Stream_Google_Cloud_Storage_V1_DownloadObjectOptions_System_IProgress_Google_Apis_Download_IDownloadProgress__) for a synchronous example.

### DownloadObjectAsync(string, string, Stream, DownloadObjectOptions, CancellationToken, IProgress\<IDownloadProgress\>)

    public virtual Task<Object> DownloadObjectAsync(string bucket, string objectName, Stream destination, DownloadObjectOptions options = null, CancellationToken cancellationToken = default, IProgress<IDownloadProgress> progress = null)

Downloads the data for an object from storage asynchronously, into a specified stream.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object. Must not be null. |
| `objectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object within the bucket. Must not be null. |
| `destination` | `https://learn.microsoft.com/dotnet/api/system.io.stream` The stream to write the data into. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.DownloadObjectOptions` Additional options for the download. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |
| `progress` | `https://learn.microsoft.com/dotnet/api/system.iprogress-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Download.IDownloadProgress.html` Progress reporter for the download. May be null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | A task representing the asynchronous operation. The result of the task is an [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the metadata for the object that has been downloaded into the stream. This metadata is not the complete metadata for the object; it's just the information provided in headers while downloading. Additionally, the CRC32C hash is only the hash of the data downloaded; if the options specify a range which does not encompass the whole object, this will not be the same as the CRC32C hash of the complete object. |

**Example**

See [DownloadObject](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_DownloadObject_System_String_System_String_System_IO_Stream_Google_Cloud_Storage_V1_DownloadObjectOptions_System_IProgress_Google_Apis_Download_IDownloadProgress__) for a synchronous example.

### GetBucket(string, GetBucketOptions)

    public virtual Bucket GetBucket(string bucket, GetBucketOptions options = null)

Fetches the information about a bucket synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.GetBucketOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | The [Bucket](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html) representation of the storage bucket. |

**Example**

    var client = StorageClient.Create();

    var bucket = client.GetBucket(bucketName);
    Console.WriteLine($"Name: {bucket.Name}");
    Console.WriteLine($"TimeCreated: {bucket.TimeCreatedDateTimeOffset}");

### GetBucketAsync(string, GetBucketOptions, CancellationToken)

    public virtual Task<Bucket> GetBucketAsync(string bucket, GetBucketOptions options = null, CancellationToken cancellationToken = default)

Fetches the information about a bucket asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.GetBucketOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | A task representing the asynchronous operation, with a result returning the [Bucket](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html) representation of the storage bucket. |

**Example**

See [GetBucket](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_GetBucket_System_String_Google_Cloud_Storage_V1_GetBucketOptions_) for a synchronous example.

### GetBucketIamPolicy(string, GetBucketIamPolicyOptions)

    public virtual Policy GetBucketIamPolicy(string bucket, GetBucketIamPolicyOptions options = null)

Fetches the IAM policy information about a bucket synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.GetBucketIamPolicyOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Policy.html` | The [Policy](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Policy.html) representation of the storage bucket IAM policy. |

**Example**

    StorageClient client = StorageClient.Create();

    Policy policy = client.GetBucketIamPolicy(bucketName);
    foreach (Policy.BindingsData binding in policy.Bindings)
    {
        Console.WriteLine($"Role: {binding.Role}");
        foreach (var permission in binding.Members)
        {
            Console.WriteLine($"  {permission}");
        }
    }

### GetBucketIamPolicyAsync(string, GetBucketIamPolicyOptions, CancellationToken)

    public virtual Task<Policy> GetBucketIamPolicyAsync(string bucket, GetBucketIamPolicyOptions options = null, CancellationToken cancellationToken = default)

Fetches the IAM policy information about a bucket asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.GetBucketIamPolicyOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Policy.html` | A task representing the asynchronous operation, with a result returning the [Policy](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Policy.html) representation of the storage bucket IAM policy. |

**Example**

See [GetBucketIamPolicy](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_GetBucketIamPolicy_System_String_Google_Cloud_Storage_V1_GetBucketIamPolicyOptions_) for a synchronous example.

### GetHmacKey(string, string, GetHmacKeyOptions)

    public virtual HmacKeyMetadata GetHmacKey(string projectId, string accessId, GetHmacKeyOptions options = null)

Synchronously fetches metadata for the specified HMAC key.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The project containing the HMAC key. Must not be null. |
| `accessId` | `https://learn.microsoft.com/dotnet/api/system.string` The ID of the HMAC key. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.GetHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeyMetadata.html` | The HMAC key metadata |

### GetHmacKeyAsync(string, string, GetHmacKeyOptions, CancellationToken)

    public virtual Task<HmacKeyMetadata> GetHmacKeyAsync(string projectId, string accessId, GetHmacKeyOptions options = null, CancellationToken cancellationToken = default)

Asynchronously fetches metadata for the specified HMAC key.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The project containing the HMAC key. Must not be null. |
| `accessId` | `https://learn.microsoft.com/dotnet/api/system.string` The ID of the HMAC key. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.GetHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeyMetadata.html` | A task representing the asynchronous operation, with a result returning the HMAC key metadata. |

### GetNotification(string, string, GetNotificationOptions)

    public virtual Notification GetNotification(string bucket, string notificationId, GetNotificationOptions options = null)

Fetches a notification configuration.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The bucket associated with the notification configuration. Must not be null. |
| `notificationId` | `https://learn.microsoft.com/dotnet/api/system.string` ID of the notification configuration to fetch. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.GetNotificationOptions` The options for the operation. May be null, in which case defaults will be supplied. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Notification.html` | The [Notification](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Notification.html) representation of the notification configuration. |

**Example**

    StorageClient client = StorageClient.Create();
    Notification notification = client.GetNotification(bucket, notificationId);
    Console.WriteLine($"ID: {notification.Id}");
    Console.WriteLine($"Payload format: {notification.PayloadFormat}");
    Console.WriteLine($"Topic: {notification.Topic}");
    Console.WriteLine($"Prefix: {notification.ObjectNamePrefix}");
    Console.WriteLine($"Event types: {string.Join(",", notification.EventTypes ?? new string[0])}");

### GetNotificationAsync(string, string, GetNotificationOptions, CancellationToken)

    public virtual Task<Notification> GetNotificationAsync(string bucket, string notificationId, GetNotificationOptions options = null, CancellationToken cancellationToken = default)

Asynchronously fetches a notification configuration.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The bucket associated with the notification configuration. Must not be null. |
| `notificationId` | `https://learn.microsoft.com/dotnet/api/system.string` ID of the notification configuration to fetch. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.GetNotificationOptions` The options for the operation. May be null, in which case defaults will be supplied. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Notification.html` | A task representing the asynchronous operation, with a result returning the [Notification](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Notification.html) representation of the notification configuration. |

**Example**

See [GetNotification](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_GetNotification_System_String_System_String_Google_Cloud_Storage_V1_GetNotificationOptions_) for a synchronous example.

### GetObject(string, string, GetObjectOptions)

    public virtual Object GetObject(string bucket, string objectName, GetObjectOptions options = null)

Fetches the information about an object synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object. Must not be null. |
| `objectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object within the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.GetObjectOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | The [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the storage object. |

**Remarks** This does not retrieve the content of the object itself. Use [DownloadObject(string, string, Stream, DownloadObjectOptions, IProgress\<IDownloadProgress\>)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_DownloadObject_System_String_System_String_System_IO_Stream_Google_Cloud_Storage_V1_DownloadObjectOptions_System_IProgress_Google_Apis_Download_IDownloadProgress__)
to download the content.
**Example**

    var client = StorageClient.Create();
    var name = "greetings/hello.txt";

    var obj = client.GetObject(bucketName, name);
    Console.WriteLine($"Name: {obj.Name}");
    Console.WriteLine($"Size: {obj.Size}");
    Console.WriteLine($"ContentType: {obj.ContentType}");
    Console.WriteLine($"TimeCreated: {obj.TimeCreatedDateTimeOffset}");

### GetObjectAsync(string, string, GetObjectOptions, CancellationToken)

    public virtual Task<Object> GetObjectAsync(string bucket, string objectName, GetObjectOptions options = null, CancellationToken cancellationToken = default)

Fetches the information about an object asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object. Must not be null. |
| `objectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object within the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.GetObjectOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | A task representing the asynchronous operation, with a result returning the [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the storage object. |

**Remarks** This does not retrieve the content of the object itself. Use [DownloadObjectAsync(string, string, Stream, DownloadObjectOptions, CancellationToken, IProgress\<IDownloadProgress\>)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_DownloadObjectAsync_System_String_System_String_System_IO_Stream_Google_Cloud_Storage_V1_DownloadObjectOptions_System_Threading_CancellationToken_System_IProgress_Google_Apis_Download_IDownloadProgress__)
to download the content.
**Example**

See [GetObject](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_GetObject_System_String_System_String_Google_Cloud_Storage_V1_GetObjectOptions_) for a synchronous example.

### GetStorageServiceAccountEmail(string, GetStorageServiceAccountEmailOptions)

    public virtual string GetStorageServiceAccountEmail(string projectId, GetStorageServiceAccountEmailOptions options = null)

Retrieves the service account email address that Google Cloud Storage uses for operations on
other services such as Google Cloud Pub/Sub.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` ID of the project to retrieve the service account for. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.GetStorageServiceAccountEmailOptions` The options for the operation. May be null, in which case defaults will be supplied. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The email address of the service account. |

**Example**

    StorageClient client = StorageClient.Create();
    string serviceAccountEmail = client.GetStorageServiceAccountEmail(projectId);
    Console.WriteLine(serviceAccountEmail);

### GetStorageServiceAccountEmailAsync(string, GetStorageServiceAccountEmailOptions, CancellationToken)

    public virtual Task<string> GetStorageServiceAccountEmailAsync(string projectId, GetStorageServiceAccountEmailOptions options = null, CancellationToken cancellationToken = default)

Asynchronously retrieves the service account email address that Google Cloud Storage uses for operations on
other services such as Google Cloud Pub/Sub.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` ID of the project to retrieve the service account for. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.GetStorageServiceAccountEmailOptions` The options for the operation. May be null, in which case defaults will be supplied. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://learn.microsoft.com/dotnet/api/system.string` | A task representing the asynchronous operation, with a result returning the email address of the service account. |

**Example**

See [GetStorageServiceAccountEmail](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_GetStorageServiceAccountEmail_System_String_Google_Cloud_Storage_V1_GetStorageServiceAccountEmailOptions_) for a synchronous example.

### InitiateUploadSessionAsync(Object, long?, UploadObjectOptions, CancellationToken)

    public virtual Task<Uri> InitiateUploadSessionAsync(Object destination, long? contentLength, UploadObjectOptions options = null, CancellationToken cancellationToken = default)

Initiates an upload session, optionally specifying the length of the content to be uploaded.
The resulting URI can be used with [CreateFromUploadUri(Uri, Stream, ResumableUploadOptions)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Upload.ResumableUpload.html#Google_Apis_Upload_ResumableUpload_CreateFromUploadUri_System_Uri_System_IO_Stream_Google_Apis_Upload_ResumableUploadOptions_).

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `destination` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` Object to create or update. Must not be null, and must have the name and bucket populated. |
| `contentLength` | `https://learn.microsoft.com/dotnet/api/system.int64` The length of the content to upload later. This may be null, in which case any length of content may be uploaded. If the value is non-null, it must be strictly positive (not zero), and the content uploaded later must be exactly this length. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://learn.microsoft.com/dotnet/api/system.uri` | A task representing the asynchronous operation, with a result returning the [Uri](https://learn.microsoft.com/dotnet/api/system.uri) to use in order to upload the content. |

### InitiateUploadSessionAsync(string, string, string, long?, UploadObjectOptions, CancellationToken)

    public virtual Task<Uri> InitiateUploadSessionAsync(string bucket, string objectName, string contentType, long? contentLength, UploadObjectOptions options = null, CancellationToken cancellationToken = default)

Initiates an upload session, optionally specifying the length of the content to be uploaded.
The resulting URI can be used with [CreateFromUploadUri(Uri, Stream, ResumableUploadOptions)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Upload.ResumableUpload.html#Google_Apis_Upload_ResumableUpload_CreateFromUploadUri_System_Uri_System_IO_Stream_Google_Apis_Upload_ResumableUploadOptions_).

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object. Must not be null. |
| `objectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object within the bucket. Must not be null. |
| `contentType` | `https://learn.microsoft.com/dotnet/api/system.string` The content type of the object. This should be a MIME type such as "text/html" or "application/octet-stream". May be null. |
| `contentLength` | `https://learn.microsoft.com/dotnet/api/system.int64` The length of the content to upload later. This may be null, in which case any length of content may be uploaded. If the value is non-null, it must be strictly positive (not zero), and the content uploaded later must be exactly this length. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://learn.microsoft.com/dotnet/api/system.uri` | A task representing the asynchronous operation, with a result returning the [Uri](https://learn.microsoft.com/dotnet/api/system.uri) to use in order to upload the content. |

### ListBuckets(string, ListBucketsOptions)

    public virtual PagedEnumerable<Buckets, Bucket> ListBuckets(string projectId, ListBucketsOptions options = null)

Lists the buckets for a given project, synchronously but lazily.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The ID of the project to list the buckets from. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ListBucketsOptions` The options for the operation. May be null, in which case defaults will be supplied. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.PagedEnumerable-2.htmlGoogle.Apis.Storage.v1.Data.Bucketshttps://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | A sequence of buckets within the project. |

**Remarks** This method fetches the buckets lazily, making requests to the underlying service
for a page of results at a time, as required. No network requests are made until the returned sequence is enumerated.
This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared
for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network
or service failures can cause exceptions even after the first results have been returned.
**Example**

    var client = StorageClient.Create();

    // List all buckets associated with a project
    var buckets = client.ListBuckets(projectId);

### ListBucketsAsync(string, ListBucketsOptions)

    public virtual PagedAsyncEnumerable<Buckets, Bucket> ListBucketsAsync(string projectId, ListBucketsOptions options = null)

Asynchronously lists the buckets in a given project.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The ID of the project to list the buckets from. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ListBucketsOptions` The options for the operation. May be null, in which case defaults will be supplied. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.PagedAsyncEnumerable-2.htmlGoogle.Apis.Storage.v1.Data.Bucketshttps://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | An asynchronous sequence of buckets. |

**Remarks** This method fetches the buckets lazily, making requests to the underlying service
for a page of results at a time, as required. No network requests are made until the returned sequence is enumerated.
This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared
for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network
or service failures can cause exceptions even after the first results have been returned.
**Example**

See [ListBuckets](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_ListBuckets_System_String_Google_Cloud_Storage_V1_ListBucketsOptions_) for a synchronous example.

### ListHmacKeys(string, string, ListHmacKeysOptions)

    public virtual PagedEnumerable<HmacKeysMetadata, HmacKeyMetadata> ListHmacKeys(string projectId, string serviceAccountEmail = null, ListHmacKeysOptions options = null)

Lists the HMAC keys in a given project, synchronously but lazily, optionally filtering by service account email address.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The project containing the HMAC keys. Must not be null. |
| `serviceAccountEmail` | `https://learn.microsoft.com/dotnet/api/system.string` The service account email address to list keys for. May be null, in which case all HMAC keys associated with the project are returned. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ListHmacKeysOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.PagedEnumerable-2.htmlhttps://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeysMetadata.htmlhttps://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeyMetadata.html` | A sequence of HMAC keys within the project. |

**Remarks** This method fetches the buckets lazily, making requests to the underlying service
for a page of results at a time, as required. No network requests are made until the returned sequence is enumerated.
This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared
for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network
or service failures can cause exceptions even after the first results have been returned.

### ListHmacKeysAsync(string, string, ListHmacKeysOptions)

    public virtual PagedAsyncEnumerable<HmacKeysMetadata, HmacKeyMetadata> ListHmacKeysAsync(string projectId, string serviceAccountEmail = null, ListHmacKeysOptions options = null)

Lists the HMAC keys in a given project, asynchronously and lazily, optionally filtering by service account email address.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://learn.microsoft.com/dotnet/api/system.string` The project containing the HMAC keys. Must not be null. |
| `serviceAccountEmail` | `https://learn.microsoft.com/dotnet/api/system.string` The service account email address to list keys for. May be null, in which case all HMAC keys associated with the project are returned. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ListHmacKeysOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.PagedAsyncEnumerable-2.htmlhttps://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeysMetadata.htmlhttps://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeyMetadata.html` | An asynchronous sequence of HMAC keys within the project. |

**Remarks** This method fetches the buckets lazily, making requests to the underlying service
for a page of results at a time, as required. No network requests are made until the returned sequence is enumerated.
This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared
for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network
or service failures can cause exceptions even after the first results have been returned.

### ListNotifications(string, ListNotificationsOptions)

    public virtual IReadOnlyList<Notification> ListNotifications(string bucket, ListNotificationsOptions options = null)

Lists notification configurations associated with a bucket.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The bucket for which to list associated notification configurations. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ListNotificationsOptions` The options for the operation. May be null, in which case defaults will be supplied. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Notification.html` | A list of notification configurations associated with the specified bucket. This method never returns null. |

**Example**

    StorageClient client = StorageClient.Create();
    IReadOnlyList<Notification> notifications = client.ListNotifications(bucket);
    foreach (Notification notification in notifications)
    {
        Console.WriteLine($"{notification.Id}: Topic={notification.Topic}; Prefix={notification.ObjectNamePrefix}");
    }

### ListNotificationsAsync(string, ListNotificationsOptions, CancellationToken)

    public virtual Task<IReadOnlyList<Notification>> ListNotificationsAsync(string bucket, ListNotificationsOptions options = null, CancellationToken cancellationToken = default)

Asynchronously lists notification configurations associated with a bucket.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The bucket for which to list associated notification configurations. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ListNotificationsOptions` The options for the operation. May be null, in which case defaults will be supplied. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Notification.html` | A task representing the asynchronous operation, with a result returning the list of notification configurations associated with the specified bucket. The result is never null. |

**Example**

See [ListNotifications](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_ListNotifications_System_String_Google_Cloud_Storage_V1_ListNotificationsOptions_) for a synchronous example.

### ListObjects(string, string, ListObjectsOptions)

    public virtual PagedEnumerable<Objects, Object> ListObjects(string bucket, string prefix = null, ListObjectsOptions options = null)

Lists the objects in a given bucket, synchronously but lazily.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The bucket to list the objects from. Must not be null. |
| `prefix` | `https://learn.microsoft.com/dotnet/api/system.string` The prefix to match. Only objects with names that start with this string will be returned. This parameter may be null or empty, in which case no filtering is performed. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ListObjectsOptions` The options for the operation. May be null, in which case defaults will be supplied. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.PagedEnumerable-2.htmlhttps://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Objects.htmlhttps://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | A sequence of objects in the specified bucket. |

**Remarks** This method fetches the objects lazily, making requests to the underlying service
for a page of results at a time, as required. No network requests are made until the returned sequence is enumerated.
This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared
for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network
or service failures can cause exceptions even after the first results have been returned.
**Example**

    var client = StorageClient.Create();

    // List only objects with a name starting with "greet"
    var objects = client.ListObjects(bucketName, "greet");

### ListObjectsAsync(string, string, ListObjectsOptions)

    public virtual PagedAsyncEnumerable<Objects, Object> ListObjectsAsync(string bucket, string prefix = null, ListObjectsOptions options = null)

Asynchronously lists the objects in a given bucket.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The bucket to list the objects from. Must not be null. |
| `prefix` | `https://learn.microsoft.com/dotnet/api/system.string` The prefix to match. Only objects with names that start with this string will be returned. This parameter may be null or empty, in which case no filtering is performed. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ListObjectsOptions` The options for the operation. May be null, in which case defaults will be supplied. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.PagedAsyncEnumerable-2.htmlhttps://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Objects.htmlhttps://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | An asynchronous sequence of objects in the specified bucket. |

**Remarks** This method fetches the objects lazily, making requests to the underlying service
for a page of results at a time, as required. No network requests are made until the returned sequence is enumerated.
This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared
for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network
or service failures can cause exceptions even after the first results have been returned.
**Example**

See [ListObjects](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_ListObjects_System_String_System_String_Google_Cloud_Storage_V1_ListObjectsOptions_) for a synchronous example.

### LockBucketRetentionPolicy(string, long, LockBucketRetentionPolicyOptions)

    public virtual void LockBucketRetentionPolicy(string bucket, long metageneration, LockBucketRetentionPolicyOptions options = null)

Locks the retention policy of a bucket. This is a one-way process:
once a retention policy is locked, it cannot be shortened, removed or unlocked,
although it can be increased in duration. The lock persists until the bucket is deleted.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket whose retention policy should be locked. Must not be null. |
| `metageneration` | `https://learn.microsoft.com/dotnet/api/system.int64` The current metageneration of the bucket, used to validate that the bucket version to be locked is the intended one. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.LockBucketRetentionPolicyOptions` The options for the operation. May be null, in which case defaults will be supplied. |

**Example**

    var client = StorageClient.Create();
    var bucketName = Guid.NewGuid().ToString();

    // Create a bucket and set its retention policy
    Bucket bucket = client.CreateBucket(projectId, bucketName);
    // Retention period is specified in seconds.
    bucket.RetentionPolicy = new Bucket.RetentionPolicyData { RetentionPeriod = 60 };
    bucket = client.UpdateBucket(bucket);

    // Once the retention policy is locked, it can't be shortened, removed or unlocked.
    // It will be locked until the bucket is deleted.
    client.LockBucketRetentionPolicy(bucketName, bucket.Metageneration.Value);

### LockBucketRetentionPolicyAsync(string, long, LockBucketRetentionPolicyOptions, CancellationToken)

    public virtual Task LockBucketRetentionPolicyAsync(string bucket, long metageneration, LockBucketRetentionPolicyOptions options = null, CancellationToken cancellationToken = default)

Asynchronously locks the retention policy of a bucket. This is a one-way process:
once a retention policy is locked, it cannot be shortened, removed or unlocked,
although it can be increased in duration. The lock persists until the bucket is deleted.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket whose retention policy should be locked. Must not be null. |
| `metageneration` | `https://learn.microsoft.com/dotnet/api/system.int64` The current metageneration of the bucket, used to validate that the bucket version to be locked is the intended one. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.LockBucketRetentionPolicyOptions` The options for the operation. May be null, in which case defaults will be supplied. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task` | A task representing the asynchronous operation. |

**Example**

See [LockBucketRetentionPolicy](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_LockBucketRetentionPolicy_System_String_System_Int64_Google_Cloud_Storage_V1_LockBucketRetentionPolicyOptions_) for a synchronous example.

### ModifyBucketLabels(string, IDictionary\<string, string\>, ModifyBucketLabelsOptions)

    public virtual IDictionary<string, string> ModifyBucketLabels(string bucket, IDictionary<string, string> labels, ModifyBucketLabelsOptions options = null)

Sets or removes one or more labels on a bucket.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `labels` | `https://learn.microsoft.com/dotnet/api/system.collections.generic.idictionary-2https://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` The labels to set. Must contain at least one entry; keys must not be null, but values may be (indicating label removal). |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ModifyBucketLabelsOptions` The options for the operation. May be null, in which case defaults will be supplied. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.collections.generic.idictionary-2https://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` | A dictionary with the same keys as `labels`, and values indicating the corresponding label value before this operation completed. Labels which weren't present on the bucket before the modification have corresponding null values in the returned dictionary. |

**Remarks** Each entry in `labels` is treated as a label to set or remove. If the value is null,
it will be removed from the bucket; otherwise, it will be set/added. Labels which do not have an entry
in the dictionary will be ignored.
**Example**

    StorageClient client = StorageClient.Create();

    string now = DateTime.UtcNow.ToString("yyyy-MM-dd_HH-mm-ss", CultureInfo.InvariantCulture);
    IDictionary<string, string> labelChanges = new Dictionary<string, string>
    {
        { "label1", "new_value_1_" + now },
        { "label2", "new_value_2_" + now },
    };

    IDictionary<string, string> oldValues = client.ModifyBucketLabels(bucketName, labelChanges);
    Console.WriteLine("Old values for changed labels:");
    foreach (KeyValuePair<string, string> entry in oldValues)
    {
        Console.WriteLine($"  {entry.Key}: {entry.Value}");
    }
    Console.WriteLine("All labels:");
    IDictionary<string, string> allLabels = client.GetBucket(bucketName).Labels ?? new Dictionary<string, string>();
    foreach (KeyValuePair<string, string> entry in allLabels)
    {
        Console.WriteLine($"  {entry.Key}: {entry.Value}");
    }

### ModifyBucketLabelsAsync(string, IDictionary\<string, string\>, ModifyBucketLabelsOptions, CancellationToken)

    public virtual Task<IDictionary<string, string>> ModifyBucketLabelsAsync(string bucket, IDictionary<string, string> labels, ModifyBucketLabelsOptions options = null, CancellationToken cancellationToken = default)

Sets or removes one or more labels on a bucket asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `labels` | `https://learn.microsoft.com/dotnet/api/system.collections.generic.idictionary-2https://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` The labels to set. Must contain at least one entry; keys must not be null, but values may be (indicating label removal). |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ModifyBucketLabelsOptions` The options for the operation. May be null, in which case defaults will be supplied. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://learn.microsoft.com/dotnet/api/system.collections.generic.idictionary-2https://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` | A dictionary with the same keys as `labels`, and values indicating the corresponding label value before this operation completed. Labels which weren't present on the bucket before the modification have corresponding null values in the returned dictionary. |

**Remarks** Each entry in `labels` is treated as a label to set or remove. If the value is null,
it will be removed from the bucket; otherwise, it will be set/added. Labels which do not have an entry
in the dictionary will be ignored.
**Example**

See [ModifyBucketLabels](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_ModifyBucketLabels_System_String_System_Collections_Generic_IDictionary_System_String_System_String__Google_Cloud_Storage_V1_ModifyBucketLabelsOptions_) for a synchronous example.

### MoveObject(string, string, string, MoveObjectOptions)

    public virtual Object MoveObject(string sourceBucket, string sourceObjectName, string destinationObjectName, MoveObjectOptions options = null)

Moves an object within a bucket. This method uses the
`moveObject` underlying API operation for more flexibility and reliability.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `sourceBucket` | `https://learn.microsoft.com/dotnet/api/system.string` Name of the bucket containing the object to move. Must not be null. |
| `sourceObjectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the source object to move within the bucket. Must not be null. |
| `destinationObjectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the new object to move to within the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.MoveObjectOptions` Additional options for the move operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | The [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the new storage object resulting from the move. |

### MoveObjectAsync(string, string, string, MoveObjectOptions, CancellationToken)

    public virtual Task<Object> MoveObjectAsync(string sourceBucket, string sourceObjectName, string destinationObjectName, MoveObjectOptions options = null, CancellationToken cancellationToken = default)

Moves an object within a bucket. This method uses the
`moveObject` underlying API operation for more flexibility and reliability.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `sourceBucket` | `https://learn.microsoft.com/dotnet/api/system.string` Name of the bucket containing the object to move. Must not be null. |
| `sourceObjectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the source object to move within the bucket. Must not be null. |
| `destinationObjectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the new object to move to within the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.MoveObjectOptions` Additional options for the move operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | A task representing the asynchronous operation, with a result returning the [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the new storage object resulting from the move. |

### PatchBucket(Bucket, PatchBucketOptions)

    public virtual Bucket PatchBucket(Bucket bucket, PatchBucketOptions options = null)

Patches the metadata for a storage bucket synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` Bucket to update. Must not be null, and must have a populated `Name` property. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.PatchBucketOptions` Additional options for the update. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | The [Bucket](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html) representation of the updated storage bucket. |

**Example**

    var client = StorageClient.Create();
    // Note: no fetching of the bucket beforehand. We only specify the values we want
    // to change.
    var bucket = new Bucket
    {
        Name = bucketName,
        Website = new Bucket.WebsiteData
        {
            MainPageSuffix = "index.html",
            NotFoundPage = "404.html"
        }
    };
    client.PatchBucket(bucket);

### PatchBucketAsync(Bucket, PatchBucketOptions, CancellationToken)

    public virtual Task<Bucket> PatchBucketAsync(Bucket bucket, PatchBucketOptions options = null, CancellationToken cancellationToken = default)

Patches the metadata for a storage bucket asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` Bucket to update. Must not be null, and must have a populated `Name` property. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.PatchBucketOptions` Additional options for the update. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | A task representing the asynchronous operation, with a result returning the [Bucket](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html) representation of the bucket storage bucket. |

**Example**

See [PatchBucket](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_PatchBucket_Google_Apis_Storage_v1_Data_Bucket_Google_Cloud_Storage_V1_PatchBucketOptions_) for a synchronous example.

### PatchObject(Object, PatchObjectOptions)

    public virtual Object PatchObject(Object obj, PatchObjectOptions options = null)

Patches the metadata for an object in storage synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `obj` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` Object to update. Must not be null, and must have populated `Name` and `Bucket` properties. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.PatchObjectOptions` Additional options for the update. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | The [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the updated storage object. |

**Example**

    var client = StorageClient.Create();
    var name = "patch-example.txt";
    var content = Encoding.UTF8.GetBytes("hello, world");
    var obj = new Apis.Storage.v1.Data.Object
    {
        Bucket = bucketName,
        Name = name,
        ContentType = "text/json", // Deliberately incorrect
        Metadata = new Dictionary<string, string>
        {
            { "key1", "value1" },
            { "key2", "value2" }
        }
    };
    client.UploadObject(obj, new MemoryStream(content));

    var patchObject = new Apis.Storage.v1.Data.Object
    {
        // The bucket and name are required; everything else is optional.
        // Only specified properties will be updated.
        Bucket = bucketName,
        Name = name,
        ContentType = "text/plain",
        Metadata = new Dictionary<string, string>
        {
            { "key2", "updated-value2" },
            { "key3", "value3" }
        }
    };
    client.PatchObject(patchObject);

### PatchObjectAsync(Object, PatchObjectOptions, CancellationToken)

    public virtual Task<Object> PatchObjectAsync(Object obj, PatchObjectOptions options = null, CancellationToken cancellationToken = default)

Patches the metadata for an object in storage asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `obj` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` Object to update. Must not be null, and must have populated `Name` and `Bucket` properties. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.PatchObjectOptions` Additional options for the update. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | A task representing the asynchronous operation, with a result returning the [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the updated storage object. |

**Example**

See [PatchObject](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_PatchObject_Google_Apis_Storage_v1_Data_Object_Google_Cloud_Storage_V1_PatchObjectOptions_) for a synchronous example.

### RemoveBucketLabel(string, string, ModifyBucketLabelsOptions)

    public virtual string RemoveBucketLabel(string bucket, string labelName, ModifyBucketLabelsOptions options = null)

Removes a label from a bucket, if it previously existed. It is not an error to
attempt to remove a label that doesn't already exist.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `labelName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the label to remove. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ModifyBucketLabelsOptions` The options for the operation. May be null, in which case defaults will be supplied. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The previous value of the label, or null if the label did not previously exist. |

**Remarks** This method is implemented by creating a single-element dictionary which is passed to
[ModifyBucketLabels(string, IDictionary\<string, string\>, ModifyBucketLabelsOptions)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_ModifyBucketLabels_System_String_System_Collections_Generic_IDictionary_System_String_System_String__Google_Cloud_Storage_V1_ModifyBucketLabelsOptions_).
**Example**

    StorageClient client = StorageClient.Create();

    string oldValue = client.RemoveBucketLabel(bucketName, "label");
    Console.WriteLine($"Old value: {oldValue}");
    // Verify the label is now gone...
    Bucket bucket = client.GetBucket(bucketName);
    string fetchedValue = null;
    bucket.Labels?.TryGetValue("label", out fetchedValue);
    Console.WriteLine($"Fetched value: {fetchedValue}");

### RemoveBucketLabelAsync(string, string, ModifyBucketLabelsOptions, CancellationToken)

    public virtual Task<string> RemoveBucketLabelAsync(string bucket, string labelName, ModifyBucketLabelsOptions options = null, CancellationToken cancellationToken = default)

Removes a label from a bucket, if it previously existed, asynchronously. It is not an error to
attempt to remove a label that doesn't already exist.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `labelName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the label to remove. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ModifyBucketLabelsOptions` The options for the operation. May be null, in which case defaults will be supplied. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://learn.microsoft.com/dotnet/api/system.string` | The previous value of the label, or null if the label did not previously exist. |

**Remarks** This method is implemented by creating a single-element dictionary which is passed to
[ModifyBucketLabelsAsync(string, IDictionary\<string, string\>, ModifyBucketLabelsOptions, CancellationToken)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_ModifyBucketLabelsAsync_System_String_System_Collections_Generic_IDictionary_System_String_System_String__Google_Cloud_Storage_V1_ModifyBucketLabelsOptions_System_Threading_CancellationToken_).
**Example**

See [RemoveBucketLabel](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_RemoveBucketLabel_System_String_System_String_Google_Cloud_Storage_V1_ModifyBucketLabelsOptions_) for a synchronous example.

### RestoreBucket(string, long, RestoreBucketOptions)

    public virtual Bucket RestoreBucket(string bucket, long generation, RestoreBucketOptions options = null)

Restores a soft-deleted bucket.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `generation` | `https://learn.microsoft.com/dotnet/api/system.int64` The specific revision of the bucket to restore. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.RestoreBucketOptions` Additional options for the restore operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | The [Bucket](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html) representation of the restored Storage bucket. |

### RestoreBucketAsync(string, long, RestoreBucketOptions, CancellationToken)

    public virtual Task<Bucket> RestoreBucketAsync(string bucket, long generation, RestoreBucketOptions options = null, CancellationToken cancellationToken = default)

Restores a soft-deleted bucket.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `generation` | `https://learn.microsoft.com/dotnet/api/system.int64` The specific revision of the bucket to restore. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.RestoreBucketOptions` Additional options for the restore operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | A task representing the asynchronous operation, with a result returning the [Bucket](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html) representation of the restored Storage bucket. |

### RestoreObject(string, string, long, RestoreObjectOptions)

    public virtual Object RestoreObject(string bucket, string objectName, long generation, RestoreObjectOptions options = null)

Restores a soft-deleted object.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object. Must not be null. |
| `objectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object to restore. Must not be null. |
| `generation` | `https://learn.microsoft.com/dotnet/api/system.int64` The specific revision of the object to restore. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.RestoreObjectOptions` Additional options for the restore operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | The [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the restored Storage object. |

### RestoreObjectAsync(string, string, long, RestoreObjectOptions, CancellationToken)

    public virtual Task<Object> RestoreObjectAsync(string bucket, string objectName, long generation, RestoreObjectOptions options = null, CancellationToken cancellationToken = default)

Restores a soft-deleted object.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object. Must not be null. |
| `objectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object within the bucket. Must not be null. |
| `generation` | `https://learn.microsoft.com/dotnet/api/system.int64` The specific revision of the object to restore. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.RestoreObjectOptions` Additional options for the restore operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | A task representing the asynchronous operation, with a result returning the [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the restored Storage object. |

### SetBucketIamPolicy(string, Policy, SetBucketIamPolicyOptions)

    public virtual Policy SetBucketIamPolicy(string bucket, Policy policy, SetBucketIamPolicyOptions options = null)

Updates the IAM policy information about a bucket synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `policy` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Policy.html` The new IAM policy for the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.SetBucketIamPolicyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Policy.html` | The [Policy](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Policy.html) representation of the resulting storage bucket IAM policy. |

**Example**

    // Create a new bucket and an empty file within it
    StorageClient client = StorageClient.Create();
    Bucket bucket = client.CreateBucket(projectId, bucketName);
    var obj = client.UploadObject(bucketName, "empty.txt", "text/plain", new MemoryStream());

    // Demonstrate that without authentication, we can't download the object
    HttpClient httpClient = new HttpClient();
    HttpResponseMessage response1 = await httpClient.GetAsync(obj.MediaLink);
    Console.WriteLine($"Response code before setting policy: {response1.StatusCode}");

    // Fetch the current IAM policy, and modify it in memory to allow all users
    // to view objects.
    Policy policy = client.GetBucketIamPolicy(bucketName);
    string role = "roles/storage.objectViewer";
    Policy.BindingsData binding = policy.Bindings
        .Where(b => b.Role == role)
        .FirstOrDefault();
    if (binding == null)
    {
        binding = new Policy.BindingsData { Role = role, Members = new List<string>() };
        policy.Bindings.Add(binding);
    }
    binding.Members.Add("allUsers");

    // Update the IAM policy on the bucket.
    client.SetBucketIamPolicy(bucketName, policy);

    // Wait 10 seconds to allow the policy to be applied.
    // (Normally the policy change is visible pretty much immediately, but
    // 10 seconds makes this very reliable.)
    await Task.Delay(TimeSpan.FromSeconds(10));

    // Download the object again: this time the response should be OK
    HttpResponseMessage response2 = await httpClient.GetAsync(obj.MediaLink);
    Console.WriteLine($"Response code after setting policy: {response2.StatusCode}");

### SetBucketIamPolicyAsync(string, Policy, SetBucketIamPolicyOptions, CancellationToken)

    public virtual Task<Policy> SetBucketIamPolicyAsync(string bucket, Policy policy, SetBucketIamPolicyOptions options = null, CancellationToken cancellationToken = default)

Updates the IAM policy information about a bucket asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `policy` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Policy.html` The new IAM policy for the bucket. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.SetBucketIamPolicyOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Policy.html` | A task representing the asynchronous operation, with a result returning the [Policy](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Policy.html) representation of the resulting storage bucket IAM policy. |

**Example**

See [SetBucketIamPolicy](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_SetBucketIamPolicy_System_String_Google_Apis_Storage_v1_Data_Policy_Google_Cloud_Storage_V1_SetBucketIamPolicyOptions_) for a synchronous example.

### SetBucketLabel(string, string, string, ModifyBucketLabelsOptions)

    public virtual string SetBucketLabel(string bucket, string labelName, string labelValue, ModifyBucketLabelsOptions options = null)

Sets the value for a single label on a bucket. The label will be added if it does
not exist, or updated if it already exists.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `labelName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the label to set. Must not be null. |
| `labelValue` | `https://learn.microsoft.com/dotnet/api/system.string` The value of the label to set. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ModifyBucketLabelsOptions` The options for the operation. May be null, in which case defaults will be supplied. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` | The previous value of the label, or null if the label did not previously exist. |

**Remarks** This method is implemented by creating a single-element dictionary which is passed to
[ModifyBucketLabels(string, IDictionary\<string, string\>, ModifyBucketLabelsOptions)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_ModifyBucketLabels_System_String_System_Collections_Generic_IDictionary_System_String_System_String__Google_Cloud_Storage_V1_ModifyBucketLabelsOptions_).
**Example**

    StorageClient client = StorageClient.Create();

    string now = DateTime.UtcNow.ToString("yyyy-MM-dd_HH-mm-ss", CultureInfo.InvariantCulture);
    string newValue = "new_value_" + now;
    string oldValue = client.SetBucketLabel(bucketName, "label", newValue);
    Console.WriteLine($"Old value: {oldValue}");
    // Verify the label is now correct...
    Bucket bucket = client.GetBucket(bucketName);
    string fetchedValue = bucket.Labels?["label"];
    Console.WriteLine($"Fetched value: {fetchedValue}");

### SetBucketLabelAsync(string, string, string, ModifyBucketLabelsOptions, CancellationToken)

    public virtual Task<string> SetBucketLabelAsync(string bucket, string labelName, string labelValue, ModifyBucketLabelsOptions options = null, CancellationToken cancellationToken = default)

Sets the value for a single label on a bucket asynchronously. The label will be added if it does
not exist, or updated if it already exists.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `labelName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the label to set. Must not be null. |
| `labelValue` | `https://learn.microsoft.com/dotnet/api/system.string` The value of the label to set. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.ModifyBucketLabelsOptions` The options for the operation. May be null, in which case defaults will be supplied. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://learn.microsoft.com/dotnet/api/system.string` | The previous value of the label, or null if the label did not previously exist. |

**Remarks** This method is implemented by creating a single-element dictionary which is passed to
[ModifyBucketLabelsAsync(string, IDictionary\<string, string\>, ModifyBucketLabelsOptions, CancellationToken)](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_ModifyBucketLabelsAsync_System_String_System_Collections_Generic_IDictionary_System_String_System_String__Google_Cloud_Storage_V1_ModifyBucketLabelsOptions_System_Threading_CancellationToken_).
**Example**

See [SetBucketLabel](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_SetBucketLabel_System_String_System_String_System_String_Google_Cloud_Storage_V1_ModifyBucketLabelsOptions_) for a synchronous example.

### TestBucketIamPermissions(string, IEnumerable\<string\>, TestBucketIamPermissionsOptions)

    public virtual IList<string> TestBucketIamPermissions(string bucket, IEnumerable<string> permissions, TestBucketIamPermissionsOptions options = null)

Tests the IAM permissions for a bucket synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `permissions` | `https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1https://learn.microsoft.com/dotnet/api/system.string` The permissions to test. Must not be null or empty. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.TestBucketIamPermissionsOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1https://learn.microsoft.com/dotnet/api/system.string` | The permissions held by the caller. |

**Example**

    StorageClient client = StorageClient.Create();

    IList<string> permissions = client.TestBucketIamPermissions(bucketName,
        new[] { "storage.buckets.get", "storage.objects.list" });
    Console.WriteLine("Permissions held:");
    foreach (string permission in permissions)
    {
        Console.WriteLine($"  {permission}");
    }

### TestBucketIamPermissionsAsync(string, IEnumerable\<string\>, TestBucketIamPermissionsOptions, CancellationToken)

    public virtual Task<IList<string>> TestBucketIamPermissionsAsync(string bucket, IEnumerable<string> permissions, TestBucketIamPermissionsOptions options = null, CancellationToken cancellationToken = default)

Tests the IAM policy information about a bucket asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket. Must not be null. |
| `permissions` | `https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1https://learn.microsoft.com/dotnet/api/system.string` The permissions to test. Must not be null or empty. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.TestBucketIamPermissionsOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://learn.microsoft.com/dotnet/api/system.collections.generic.ilist-1https://learn.microsoft.com/dotnet/api/system.string` | A task representing the asynchronous operation, with a result returning the permissions held by the caller. |

**Example**

See [TestBucketIamPermissions](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_TestBucketIamPermissions_System_String_System_Collections_Generic_IEnumerable_System_String__Google_Cloud_Storage_V1_TestBucketIamPermissionsOptions_) for a synchronous example.

### UpdateBucket(Bucket, UpdateBucketOptions)

    public virtual Bucket UpdateBucket(Bucket bucket, UpdateBucketOptions options = null)

Updates the metadata for a storage bucket synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` Bucket to update. Must not be null, and must have a populated `Name`. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UpdateBucketOptions` Additional options for the update. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | The [Bucket](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html) representation of the updated storage bucket. |

**Remarks**
If no preconditions are explicitly set in `options`, the metageneration of `bucket`
is used as a precondition for the update, unless [ForceNoPreconditions](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UpdateBucketOptions#Google_Cloud_Storage_V1_UpdateBucketOptions_ForceNoPreconditions) is
set to `true`.
**Example**

    var client = StorageClient.Create();
    var bucket = client.GetBucket(bucketName);
    bucket.Website = new Bucket.WebsiteData
    {
        MainPageSuffix = "index.html",
        NotFoundPage = "404.html"
    };
    client.UpdateBucket(bucket);

### UpdateBucketAsync(Bucket, UpdateBucketOptions, CancellationToken)

    public virtual Task<Bucket> UpdateBucketAsync(Bucket bucket, UpdateBucketOptions options = null, CancellationToken cancellationToken = default)

Updates the metadata for storage bucket asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` Bucket to update. Must not be null, and must have a populated `Name`. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UpdateBucketOptions` Additional options for the update. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html` | A task representing the asynchronous operation, with a result returning the [Bucket](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Bucket.html) representation of the storage bucket. |

**Remarks**
If no preconditions are explicitly set in `options`, the metageneration of `bucket`
is used as a precondition for the update, unless [ForceNoPreconditions](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UpdateBucketOptions#Google_Cloud_Storage_V1_UpdateBucketOptions_ForceNoPreconditions) is
set to `true`.
**Example**

See [UpdateBucket](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_UpdateBucket_Google_Apis_Storage_v1_Data_Bucket_Google_Cloud_Storage_V1_UpdateBucketOptions_) for a synchronous example.

### UpdateHmacKey(HmacKeyMetadata, UpdateHmacKeyOptions)

    public virtual HmacKeyMetadata UpdateHmacKey(HmacKeyMetadata key, UpdateHmacKeyOptions options = null)

Synchronously updates an HMAC key's metadata.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `key` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeyMetadata.html` The key to update. Must not be null, and the [ProjectId](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeyMetadata.html#Google_Apis_Storage_v1_Data_HmacKeyMetadata_ProjectId) and [AccessId](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeyMetadata.html#Google_Apis_Storage_v1_Data_HmacKeyMetadata_AccessId) properties must be set. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UpdateHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeyMetadata.html` | The updated key metadata. |

### UpdateHmacKeyAsync(HmacKeyMetadata, UpdateHmacKeyOptions, CancellationToken)

    public virtual Task<HmacKeyMetadata> UpdateHmacKeyAsync(HmacKeyMetadata key, UpdateHmacKeyOptions options = null, CancellationToken cancellationToken = default)

Asynchronously updates an HMAC key's metadata.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `key` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeyMetadata.html` The key to update. Must not be null, and the [ProjectId](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeyMetadata.html#Google_Apis_Storage_v1_Data_HmacKeyMetadata_ProjectId) and [AccessId](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeyMetadata.html#Google_Apis_Storage_v1_Data_HmacKeyMetadata_AccessId) properties must be set. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UpdateHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.HmacKeyMetadata.html` | A task representing the asynchronous operation, with a result returning the updated key metadata. |

### UpdateObject(Object, UpdateObjectOptions)

    public virtual Object UpdateObject(Object obj, UpdateObjectOptions options = null)

Updates the metadata for an object in storage synchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `obj` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` Object to update. Must not be null, and must have populated `Name` and `Bucket` properties. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UpdateObjectOptions` Additional options for the update. May be null, in which case appropriate defaults will be used. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | The [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the updated storage object. |

**Remarks**
If no preconditions are explicitly set in `options`, the generation and
metageneration of `obj` are used as a precondition for the update,
unless [ForceNoPreconditions](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UpdateObjectOptions#Google_Cloud_Storage_V1_UpdateObjectOptions_ForceNoPreconditions) is
set to `true`.
**Example**

    var client = StorageClient.Create();
    var name = "update-example.txt";
    var content = Encoding.UTF8.GetBytes("hello, world");
    var obj = new Apis.Storage.v1.Data.Object
    {
        Bucket = bucketName,
        Name = name,
        ContentType = "text/json",
        Metadata = new Dictionary<string, string>
        {
            { "key1", "value1" },
            { "key2", "value2" }
        }
    };
    obj = client.UploadObject(obj, new MemoryStream(content));
    obj.Metadata.Remove("key1");
    obj.Metadata["key2"] = "updated-value2";
    obj.Metadata["key3"] = "value3";
    obj.ContentType = "text/plain";
    client.UpdateObject(obj);

### UpdateObjectAsync(Object, UpdateObjectOptions, CancellationToken)

    public virtual Task<Object> UpdateObjectAsync(Object obj, UpdateObjectOptions options = null, CancellationToken cancellationToken = default)

Updates the metadata for an object in storage asynchronously.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `obj` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` Object to update. Must not be null, and must have populated `Name` and `Bucket` properties. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UpdateObjectOptions` Additional options for the update. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | A task representing the asynchronous operation, with a result returning the [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the storage object. |

**Remarks**
If no preconditions are explicitly set in `options`, the generation and
metageneration of `obj` are used as a precondition for the update,
unless [ForceNoPreconditions](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UpdateObjectOptions#Google_Cloud_Storage_V1_UpdateObjectOptions_ForceNoPreconditions) is
set to `true`.
**Example**

See [UpdateObject](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_UpdateObject_Google_Apis_Storage_v1_Data_Object_Google_Cloud_Storage_V1_UpdateObjectOptions_) for a synchronous example.

### UploadObject(Object, Stream, UploadObjectOptions, IProgress\<IUploadProgress\>)

    public virtual Object UploadObject(Object destination, Stream source, UploadObjectOptions options = null, IProgress<IUploadProgress> progress = null)

Uploads the data for an object in storage synchronously, from a specified stream.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `destination` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` Object to create or update. Must not be null, and must have the name and bucket populated. |
| `source` | `https://learn.microsoft.com/dotnet/api/system.io.stream` The stream to read the data from. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used. |
| `progress` | `https://learn.microsoft.com/dotnet/api/system.iprogress-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Upload.IUploadProgress.html` Progress reporter for the upload. May be null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | The [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the uploaded object. |

**Example**

See [UploadObject](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_UploadObject_System_String_System_String_System_String_System_IO_Stream_Google_Cloud_Storage_V1_UploadObjectOptions_System_IProgress_Google_Apis_Upload_IUploadProgress__) for an example using an alternative overload.

### UploadObject(string, string, string, Stream, UploadObjectOptions, IProgress\<IUploadProgress\>)

    public virtual Object UploadObject(string bucket, string objectName, string contentType, Stream source, UploadObjectOptions options = null, IProgress<IUploadProgress> progress = null)

Uploads the data for an object in storage synchronously, from a specified stream.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object. Must not be null. |
| `objectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object within the bucket. Must not be null. |
| `contentType` | `https://learn.microsoft.com/dotnet/api/system.string` The content type of the object. This should be a MIME type such as "text/html" or "application/octet-stream". May be null. |
| `source` | `https://learn.microsoft.com/dotnet/api/system.io.stream` The stream to read the data from. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used. |
| `progress` | `https://learn.microsoft.com/dotnet/api/system.iprogress-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Upload.IUploadProgress.html` Progress reporter for the upload. May be null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | The [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the uploaded object. |

**Example**

    var client = StorageClient.Create();
    var source = "world.txt";
    var destination = "places/world.txt";
    var contentType = "text/plain";

    using (var stream = File.OpenRead(source))
    {
        // IUploadProgress defined in Google.Apis.Upload namespace
        var progress = new Progress<IUploadProgress>(
          p => Console.WriteLine($"bytes: {p.BytesSent}, status: {p.Status}")
        );

        var obj = client.UploadObject(bucketName, destination, contentType, stream, progress: progress);
    }

### UploadObjectAsync(Object, Stream, UploadObjectOptions, CancellationToken, IProgress\<IUploadProgress\>)

    public virtual Task<Object> UploadObjectAsync(Object destination, Stream source, UploadObjectOptions options = null, CancellationToken cancellationToken = default, IProgress<IUploadProgress> progress = null)

Uploads the data for an object in storage asynchronously, from a specified stream.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `destination` | `https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` Object to create or update. Must not be null, and must have the name and bucket populated. |
| `source` | `https://learn.microsoft.com/dotnet/api/system.io.stream` The stream to read the data from. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |
| `progress` | `https://learn.microsoft.com/dotnet/api/system.iprogress-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Upload.IUploadProgress.html` Progress reporter for the upload. May be null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | A task representing the asynchronous operation, with a result returning the [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the uploaded object. |

**Example**

See [UploadObject](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_UploadObject_System_String_System_String_System_String_System_IO_Stream_Google_Cloud_Storage_V1_UploadObjectOptions_System_IProgress_Google_Apis_Upload_IUploadProgress__) for a synchronous example.

### UploadObjectAsync(string, string, string, Stream, UploadObjectOptions, CancellationToken, IProgress\<IUploadProgress\>)

    public virtual Task<Object> UploadObjectAsync(string bucket, string objectName, string contentType, Stream source, UploadObjectOptions options = null, CancellationToken cancellationToken = default, IProgress<IUploadProgress> progress = null)

Uploads the data for an object in storage asynchronously, from a specified stream.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `bucket` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the bucket containing the object. Must not be null. |
| `objectName` | `https://learn.microsoft.com/dotnet/api/system.string` The name of the object within the bucket. Must not be null. |
| `contentType` | `https://learn.microsoft.com/dotnet/api/system.string` The content type of the object. This should be a MIME type such as "text/html" or "application/octet-stream". May be null. |
| `source` | `https://learn.microsoft.com/dotnet/api/system.io.stream` The stream to read the data from. Must not be null. |
| `options` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used. |
| `cancellationToken` | `https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken` The token to monitor for cancellation requests. |
| `progress` | `https://learn.microsoft.com/dotnet/api/system.iprogress-1https://docs.cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Upload.IUploadProgress.html` Progress reporter for the upload. May be null. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html` | A task representing the asynchronous operation, with a result returning the [Object](https://googleapis.dev/dotnet/Google.Apis.Storage.v1/1.76.0.4250/api/Google.Apis.Storage.v1.Data.Object.html) representation of the uploaded object. |

**Example**

See [UploadObject](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.Storage.V1/latest/Google.Cloud.Storage.V1.StorageClient#Google_Cloud_Storage_V1_StorageClient_UploadObject_System_String_System_String_System_String_System_IO_Stream_Google_Cloud_Storage_V1_UploadObjectOptions_System_IProgress_Google_Apis_Upload_IUploadProgress__) for a synchronous example.