Google Cloud Storage v1 API - Class StorageClientImpl (4.5.0)

public sealed class StorageClientImpl : StorageClient, IDisposable

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

Wrapper around StorageService to provide simpler operations.

Inheritance

object > StorageClient > StorageClientImpl

Implements

IDisposable

Inherited Members

StorageClient.CreateAsync()

StorageClient.Create()

StorageClient.CreateAsync(GoogleCredential, EncryptionKey)

StorageClient.Create(GoogleCredential, EncryptionKey)

StorageClient.CreateUnauthenticated()

StorageClient.SetBucketLabel(string, string, string, ModifyBucketLabelsOptions)

StorageClient.RemoveBucketLabel(string, string, ModifyBucketLabelsOptions)

StorageClient.SetBucketLabelAsync(string, string, string, ModifyBucketLabelsOptions, CancellationToken)

StorageClient.RemoveBucketLabelAsync(string, string, ModifyBucketLabelsOptions, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

GoogleGoogle.CloudGoogle.Cloud.StorageV1

Assembly

Google.Cloud.Storage.V1.dll

Remarks

This is the "default" implementation of StorageClient. Most client code should refer to StorageClient, creating instances with Create(GoogleCredential, EncryptionKey) and CreateAsync(GoogleCredential, EncryptionKey). The constructor of this class is public for the sake of constructor-based dependency injection.

Constructors

StorageClientImpl(StorageService, EncryptionKey)

public StorageClientImpl(StorageService service, EncryptionKey encryptionKey = null)

Constructs a new client wrapping the given StorageService.

Parameters
Name	Description
`service`	`StorageService` The service to wrap. Must not be null.
`encryptionKey`	`EncryptionKey` Optional EncryptionKey to use for object-based operations by default. May be null, in which case None will be used.

Properties

ApplicationName

public static string ApplicationName { get; set; }

The default application name used when creating a StorageService. Defaults to "google-cloud-dotnet"; must not be null.

Property Value
Type	Description
`string`

Remarks

Most applications will never want to set this, which is why it's in this class rather than StorageClient.

EncryptionKey

public override 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 is returned.

Property Value
Type	Description
`EncryptionKey`

Overrides

StorageClient.EncryptionKey

Service

public override StorageService Service { get; }

The underlying storage service object used by this client.

Property Value
Type	Description
`StorageService`

Overrides

StorageClient.Service

Remarks

The 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 override IDictionary<string, string> ClearBucketLabels(string bucket, ModifyBucketLabelsOptions options = null)

Clears all labels on a bucket.

Parameters
Name	Description
`bucket`	`string` The name of the bucket. Must not be null.
`options`	`ModifyBucketLabelsOptions` The options for the operation. May be null, in which case defaults will be supplied.

Returns
Type	Description
`IDictionarystringstring`	A dictionary with the labels on the bucket before they were cleared.

Overrides

StorageClient.ClearBucketLabels(string, ModifyBucketLabelsOptions)

ClearBucketLabelsAsync(string, ModifyBucketLabelsOptions, CancellationToken)

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

Clears all labels on a bucket asynchronously.

Parameters
Name	Description
`bucket`	`string` The name of the bucket. Must not be null.
`options`	`ModifyBucketLabelsOptions` The options for the operation. May be null, in which case defaults will be supplied.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskIDictionarystringstring`	A dictionary with the labels on the bucket before they were cleared.

Overrides

StorageClient.ClearBucketLabelsAsync(string, ModifyBucketLabelsOptions, CancellationToken)

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

public override 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`	`string` The name of the bucket containing the object to copy. Must not be null.
`sourceObjectName`	`string` The name of the object to copy within the bucket. Must not be null.
`destinationBucket`	`string` The name of the bucket to copy the object to. Must not be null.
`destinationObjectName`	`string` The name of the object within the destination bucket. Must not be null.
`options`	`CopyObjectOptions` Additional options for the copy operation. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`Object`	The Object representation of the new storage object resulting from the copy.

Overrides

StorageClient.CopyObject(string, string, string, string, CopyObjectOptions)

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

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

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`	`string` The name of the bucket containing the object to copy. Must not be null.
`sourceObjectName`	`string` The name of the object to copy within the bucket. Must not be null.
`destinationBucket`	`string` The name of the bucket to copy the object to. Must not be null.
`destinationObjectName`	`string` The name of the object within the destination bucket. Must not be null.
`options`	`CopyObjectOptions` Additional options for the copy operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskObject`	A task representing the asynchronous operation, with a result returning the Object representation of the new storage object resulting from the copy.

Overrides

StorageClient.CopyObjectAsync(string, string, string, string, CopyObjectOptions, CancellationToken)

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.

CreateBucket(string, Bucket, CreateBucketOptions)

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

Creates a storage bucket synchronously.

Parameters
Name	Description
`projectId`	`string` The ID of the project to create the buckets in. Must not be null.
`bucket`	`Bucket` The resource representation of the bucket to create. Must not be null, and must have a name.
`options`	`CreateBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`Bucket`	The resource representation of the newly-created bucket.

Overrides

StorageClient.CreateBucket(string, Bucket, CreateBucketOptions)

CreateBucket(string, string, CreateBucketOptions)

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

Creates a storage bucket synchronously.

Parameters
Name	Description
`projectId`	`string` The ID of the project to create the buckets in. Must not be null.
`bucket`	`string` The name of the bucket to create. Must not be null.
`options`	`CreateBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`Bucket`	The resource representation of the newly-created bucket.

Overrides

StorageClient.CreateBucket(string, string, CreateBucketOptions)

CreateBucketAsync(string, Bucket, CreateBucketOptions, CancellationToken)

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

Creates a storage bucket asynchronously.

Parameters
Name	Description
`projectId`	`string` The ID of the project to create the buckets in. Must not be null.
`bucket`	`Bucket` The resource representation of the bucket to create. Must not be null, and must have a name.
`options`	`CreateBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskBucket`	A task representing the asynchronous operation, with a result returning the resource representation of the newly-created bucket.

Overrides

StorageClient.CreateBucketAsync(string, Bucket, CreateBucketOptions, CancellationToken)

CreateBucketAsync(string, string, CreateBucketOptions, CancellationToken)

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

Creates a storage bucket asynchronously.

Parameters
Name	Description
`projectId`	`string` The ID of the project to create the buckets in. Must not be null.
`bucket`	`string` The name of the bucket to create. Must not be null.
`options`	`CreateBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskBucket`	A task representing the asynchronous operation, with a result returning the resource representation of the newly-created bucket.

Overrides

StorageClient.CreateBucketAsync(string, string, CreateBucketOptions, CancellationToken)

CreateHmacKey(string, string, CreateHmacKeyOptions)

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

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

Parameters
Name	Description
`projectId`	`string` The project ID in which to create the HMAC key. Must not be null.
`serviceAccountEmail`	`string` The service account to associate with the HMAC key. Must not be null.
`options`	`CreateHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`HmacKey`	The new HMAC key, including the secret information in Secret. This secret is only ever returned when creating a key.

Overrides

StorageClient.CreateHmacKey(string, string, CreateHmacKeyOptions)

CreateHmacKeyAsync(string, string, CreateHmacKeyOptions, CancellationToken)

public override 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`	`string` The project ID in which to create the HMAC key. Must not be null.
`serviceAccountEmail`	`string` The service account to associate with the HMAC key. Must not be null.
`options`	`CreateHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskHmacKey`	A task representing the asynchronous operation, with a result returning the the new HMAC key, including the secret information in Secret. This secret is only ever returned when creating a key.

Overrides

StorageClient.CreateHmacKeyAsync(string, string, CreateHmacKeyOptions, CancellationToken)

CreateNotification(string, Notification, CreateNotificationOptions)

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

Creates a notification configuration.

Parameters
Name	Description
`bucket`	`string` The bucket for which to create the notification configuration. Must not be null.
`notification`	`Notification` The notification configuration to create. Must not be null.
`options`	`CreateNotificationOptions` The options for the operation. May be null, in which case defaults will be supplied.

Returns
Type	Description
`Notification`	The Notification representation of the newly-created notification configuration.

Overrides

StorageClient.CreateNotification(string, Notification, CreateNotificationOptions)

CreateNotificationAsync(string, Notification, CreateNotificationOptions, CancellationToken)

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

Asynchronously creates a notification configuration.

Parameters
Name	Description
`bucket`	`string` The bucket for which to create the notification configuration. Must not be null.
`notification`	`Notification` The notification configuration to create. Must not be null.
`options`	`CreateNotificationOptions` The options for the operation. May be null, in which case defaults will be supplied.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskNotification`	A task representing the asynchronous operation, with a result returning the Notification representation of the newly-created notification configuration.

Overrides

StorageClient.CreateNotificationAsync(string, Notification, CreateNotificationOptions, CancellationToken)

CreateObjectUploader(Object, Stream, UploadObjectOptions)

public override 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`	`Object` Object to create or update. Must not be null, and must have the name, bucket and content type populated.
`source`	`Stream` The stream to read the data from. Must not be null.
`options`	`UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`ObjectsResourceInsertMediaUpload`	The ObjectsResource.InsertMediaUpload which can be used to upload the object.

Overrides

StorageClient.CreateObjectUploader(Object, Stream, UploadObjectOptions)

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

public override 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`	`string` The name of the bucket containing the object. Must not be null.
`objectName`	`string` The name of the object within the bucket. Must not be null.
`contentType`	`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`	`Stream` The stream to read the data from. Must not be null.
`options`	`UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`ObjectsResourceInsertMediaUpload`	The ObjectsResource.InsertMediaUpload which can be used to upload the object.

Overrides

StorageClient.CreateObjectUploader(string, string, string, Stream, UploadObjectOptions)

DeleteBucket(Bucket, DeleteBucketOptions)

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

Deletes a bucket synchronously.

Parameters
Name	Description
`bucket`	`Bucket` Bucket to delete. Must not be null, and must have the name populated.
`options`	`DeleteBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Overrides

StorageClient.DeleteBucket(Bucket, DeleteBucketOptions)

DeleteBucket(string, DeleteBucketOptions)

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

Deletes a bucket synchronously.

Parameters
Name	Description
`bucket`	`string` The name of the bucket to delete. Must not be null.
`options`	`DeleteBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Overrides

StorageClient.DeleteBucket(string, DeleteBucketOptions)

DeleteBucketAsync(Bucket, DeleteBucketOptions, CancellationToken)

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

Deletes bucket asynchronously.

Parameters
Name	Description
`bucket`	`Bucket` Bucket to delete. Must not be null, and must have the name populated.
`options`	`DeleteBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`Task`	A task representing the asynchronous operation.

Overrides

StorageClient.DeleteBucketAsync(Bucket, DeleteBucketOptions, CancellationToken)

DeleteBucketAsync(string, DeleteBucketOptions, CancellationToken)

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

Deletes a bucket asynchronously.

Parameters
Name	Description
`bucket`	`string` The name of the bucket to delete. Must not be null.
`options`	`DeleteBucketOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`Task`	A task representing the asynchronous operation.

Overrides

StorageClient.DeleteBucketAsync(string, DeleteBucketOptions, CancellationToken)

DeleteHmacKey(string, string, DeleteHmacKeyOptions)

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

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

Parameters
Name	Description
`projectId`	`string` The ID of the project containing the HMAC key to delete.
`accessId`	`string` The ID of the HMAC key to delete. Must not be null.
`options`	`DeleteHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Overrides

StorageClient.DeleteHmacKey(string, string, DeleteHmacKeyOptions)

DeleteHmacKeyAsync(string, string, DeleteHmacKeyOptions, CancellationToken)

public override 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`	`string` The ID of the project containing the HMAC key to delete.
`accessId`	`string` The ID of the HMAC key to delete. Must not be null.
`options`	`DeleteHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`Task`	A task representing the asynchronous operation.

Overrides

StorageClient.DeleteHmacKeyAsync(string, string, DeleteHmacKeyOptions, CancellationToken)

DeleteNotification(string, string, DeleteNotificationOptions)

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

Deletes a notification configuration.

Parameters
Name	Description
`bucket`	`string` The bucket associated with the notification configuration. Must not be null.
`notificationId`	`string` ID of the notification configuration to delete. Must not be null.
`options`	`DeleteNotificationOptions` The options for the operation. May be null, in which case defaults will be supplied.

Overrides

StorageClient.DeleteNotification(string, string, DeleteNotificationOptions)

DeleteNotificationAsync(string, string, DeleteNotificationOptions, CancellationToken)

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

Asynchronously deletes a notification configuration.

Parameters
Name	Description
`bucket`	`string` The bucket associated with the notification configuration. Must not be null.
`notificationId`	`string` ID of the notification configuration to delete. Must not be null.
`options`	`DeleteNotificationOptions` The options for the operation. May be null, in which case defaults will be supplied.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`Task`	A task representing the asynchronous operation.

Overrides

StorageClient.DeleteNotificationAsync(string, string, DeleteNotificationOptions, CancellationToken)

DeleteObject(Object, DeleteObjectOptions)

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

Deletes a version of the specified object synchronously.

Parameters
Name	Description
`obj`	`Object` Object to delete. Must not be null, and must have the name and bucket populated.
`options`	`DeleteObjectOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Overrides

StorageClient.DeleteObject(Object, DeleteObjectOptions)

Remarks

By default this will delete the latest version of the object, but this can be controlled using 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. 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.

DeleteObject(string, string, DeleteObjectOptions)

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

Deletes a version of the specified object synchronously.

Parameters
Name	Description
`bucket`	`string` The name of the bucket containing the object. Must not be null.
`objectName`	`string` The name of the object within the bucket. Must not be null.
`options`	`DeleteObjectOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Overrides

StorageClient.DeleteObject(string, string, DeleteObjectOptions)

Remarks

By default this will delete the latest version of the object, but this can be controlled using 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. If the version is explicitly specified, the object is permanently deleted.

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.

DeleteObjectAsync(Object, DeleteObjectOptions, CancellationToken)

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

Deletes a version of the specified object asynchronously.

Parameters
Name	Description
`obj`	`Object` Object to delete. Must not be null, and must have the name and bucket populated.
`options`	`DeleteObjectOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`Task`	A task representing the asynchronous operation.

Overrides

StorageClient.DeleteObjectAsync(Object, DeleteObjectOptions, CancellationToken)

Remarks

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.

DeleteObjectAsync(string, string, DeleteObjectOptions, CancellationToken)

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

Deletes a version of the specified object asynchronously.

Parameters
Name	Description
`bucket`	`string` The name of the bucket containing the object. Must not be null.
`objectName`	`string` The name of the object within the bucket. Must not be null.
`options`	`DeleteObjectOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`Task`	A task representing the asynchronous operation.

Overrides

StorageClient.DeleteObjectAsync(string, string, DeleteObjectOptions, CancellationToken)

Remarks

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.

Dispose()

public override void Dispose()

Dispose of this instance. See the StorageClient remarks on when this should be called.

Overrides

StorageClient.Dispose()

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

public override 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`	`Object` Source object to download the data from. Must not be null.
`destination`	`Stream` The stream to write the data into. Must not be null.
`options`	`DownloadObjectOptions` Additional options for the download. May be null, in which case appropriate defaults will be used.
`progress`	`IProgressIDownloadProgress` Progress reporter for the download. May be null.

Returns

Type Description

Object

An Object 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.

Overrides

StorageClient.DownloadObject(Object, Stream, DownloadObjectOptions, IProgress<IDownloadProgress>)

Remarks

The generation number within source is ignored by this method. To download a specific generation, use Generation.

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

public override 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`	`string` The name of the bucket containing the object. Must not be null.
`objectName`	`string` The name of the object within the bucket. Must not be null.
`destination`	`Stream` The stream to write the data into. Must not be null.
`options`	`DownloadObjectOptions` Additional options for the download. May be null, in which case appropriate defaults will be used.
`progress`	`IProgressIDownloadProgress` Progress reporter for the download. May be null.

Returns

Type Description

Object

Overrides

StorageClient.DownloadObject(string, string, Stream, DownloadObjectOptions, IProgress<IDownloadProgress>)

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

public override 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`	`Object` Source object to download the data from. Must not be null.
`destination`	`Stream` The stream to write the data into. Must not be null.
`options`	`DownloadObjectOptions` Additional options for the download. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.
`progress`	`IProgressIDownloadProgress` Progress reporter for the download. May be null.

Returns

Type Description

TaskObject

A task representing the asynchronous operation. The result of the task is an Object 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.

Overrides

StorageClient.DownloadObjectAsync(Object, Stream, DownloadObjectOptions, CancellationToken, IProgress<IDownloadProgress>)

Remarks

The generation number within source is ignored by this method. To download a specific generation, use Generation.

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

public override 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`	`string` The name of the bucket containing the object. Must not be null.
`objectName`	`string` The name of the object within the bucket. Must not be null.
`destination`	`Stream` The stream to write the data into. Must not be null.
`options`	`DownloadObjectOptions` Additional options for the download. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.
`progress`	`IProgressIDownloadProgress` Progress reporter for the download. May be null.

Returns

Type Description

TaskObject

Overrides

StorageClient.DownloadObjectAsync(string, string, Stream, DownloadObjectOptions, CancellationToken, IProgress<IDownloadProgress>)

GetBucket(string, GetBucketOptions)

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

Fetches the information about a bucket synchronously.

Parameters
Name	Description
`bucket`	`string` The name of the bucket. Must not be null.
`options`	`GetBucketOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`Bucket`	The Bucket representation of the storage bucket.

Overrides

StorageClient.GetBucket(string, GetBucketOptions)

GetBucketAsync(string, GetBucketOptions, CancellationToken)

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

Fetches the information about a bucket asynchronously.

Parameters
Name	Description
`bucket`	`string` The name of the bucket. Must not be null.
`options`	`GetBucketOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskBucket`	A task representing the asynchronous operation, with a result returning the Bucket representation of the storage bucket.

Overrides

StorageClient.GetBucketAsync(string, GetBucketOptions, CancellationToken)

GetBucketIamPolicy(string, GetBucketIamPolicyOptions)

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

Fetches the IAM policy information about a bucket synchronously.

Parameters
Name	Description
`bucket`	`string` The name of the bucket. Must not be null.
`options`	`GetBucketIamPolicyOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`Policy`	The Policy representation of the storage bucket IAM policy.

Overrides

StorageClient.GetBucketIamPolicy(string, GetBucketIamPolicyOptions)

GetBucketIamPolicyAsync(string, GetBucketIamPolicyOptions, CancellationToken)

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

Fetches the IAM policy information about a bucket asynchronously.

Parameters
Name	Description
`bucket`	`string` The name of the bucket. Must not be null.
`options`	`GetBucketIamPolicyOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskPolicy`	A task representing the asynchronous operation, with a result returning the Policy representation of the storage bucket IAM policy.

Overrides

StorageClient.GetBucketIamPolicyAsync(string, GetBucketIamPolicyOptions, CancellationToken)

GetHmacKey(string, string, GetHmacKeyOptions)

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

Synchronously fetches metadata for the specified HMAC key.

Parameters
Name	Description
`projectId`	`string` The project containing the HMAC key. Must not be null.
`accessId`	`string` The ID of the HMAC key. Must not be null.
`options`	`GetHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`HmacKeyMetadata`	The HMAC key metadata

Overrides

StorageClient.GetHmacKey(string, string, GetHmacKeyOptions)

GetHmacKeyAsync(string, string, GetHmacKeyOptions, CancellationToken)

public override 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`	`string` The project containing the HMAC key. Must not be null.
`accessId`	`string` The ID of the HMAC key. Must not be null.
`options`	`GetHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskHmacKeyMetadata`	A task representing the asynchronous operation, with a result returning the HMAC key metadata.

Overrides

StorageClient.GetHmacKeyAsync(string, string, GetHmacKeyOptions, CancellationToken)

GetNotification(string, string, GetNotificationOptions)

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

Fetches a notification configuration.

Parameters
Name	Description
`bucket`	`string` The bucket associated with the notification configuration. Must not be null.
`notificationId`	`string` ID of the notification configuration to fetch. Must not be null.
`options`	`GetNotificationOptions` The options for the operation. May be null, in which case defaults will be supplied.

Returns
Type	Description
`Notification`	The Notification representation of the notification configuration.

Overrides

StorageClient.GetNotification(string, string, GetNotificationOptions)

GetNotificationAsync(string, string, GetNotificationOptions, CancellationToken)

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

Asynchronously fetches a notification configuration.

Parameters
Name	Description
`bucket`	`string` The bucket associated with the notification configuration. Must not be null.
`notificationId`	`string` ID of the notification configuration to fetch. Must not be null.
`options`	`GetNotificationOptions` The options for the operation. May be null, in which case defaults will be supplied.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskNotification`	A task representing the asynchronous operation, with a result returning the Notification representation of the notification configuration.

Overrides

StorageClient.GetNotificationAsync(string, string, GetNotificationOptions, CancellationToken)

GetObject(string, string, GetObjectOptions)

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

Fetches the information about an object synchronously.

Parameters
Name	Description
`bucket`	`string` The name of the bucket containing the object. Must not be null.
`objectName`	`string` The name of the object within the bucket. Must not be null.
`options`	`GetObjectOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`Object`	The Object representation of the storage object.

Overrides

StorageClient.GetObject(string, string, GetObjectOptions)

Remarks

This does not retrieve the content of the object itself. Use DownloadObject(string, string, Stream, DownloadObjectOptions, IProgress<IDownloadProgress>) to download the content.

GetObjectAsync(string, string, GetObjectOptions, CancellationToken)

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

Fetches the information about an object asynchronously.

Parameters
Name	Description
`bucket`	`string` The name of the bucket containing the object. Must not be null.
`objectName`	`string` The name of the object within the bucket. Must not be null.
`options`	`GetObjectOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskObject`	A task representing the asynchronous operation, with a result returning the Object representation of the storage object.

Overrides

StorageClient.GetObjectAsync(string, string, GetObjectOptions, CancellationToken)

Remarks

This does not retrieve the content of the object itself. Use DownloadObjectAsync(string, string, Stream, DownloadObjectOptions, CancellationToken, IProgress<IDownloadProgress>) to download the content.

GetStorageServiceAccountEmail(string, GetStorageServiceAccountEmailOptions)

public override 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`	`string` ID of the project to retrieve the service account for. Must not be null.
`options`	`GetStorageServiceAccountEmailOptions` The options for the operation. May be null, in which case defaults will be supplied.

Returns
Type	Description
`string`	The email address of the service account.

Overrides

StorageClient.GetStorageServiceAccountEmail(string, GetStorageServiceAccountEmailOptions)

GetStorageServiceAccountEmailAsync(string, GetStorageServiceAccountEmailOptions, CancellationToken)

public override 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`	`string` ID of the project to retrieve the service account for. Must not be null.
`options`	`GetStorageServiceAccountEmailOptions` The options for the operation. May be null, in which case defaults will be supplied.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`Taskstring`	A task representing the asynchronous operation, with a result returning the email address of the service account.

Overrides

StorageClient.GetStorageServiceAccountEmailAsync(string, GetStorageServiceAccountEmailOptions, CancellationToken)

ListBuckets(string, ListBucketsOptions)

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

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

Parameters
Name	Description
`projectId`	`string` The ID of the project to list the buckets from. Must not be null.
`options`	`ListBucketsOptions` The options for the operation. May be null, in which case defaults will be supplied.

Returns
Type	Description
`PagedEnumerableBucketsBucket`	A sequence of buckets within the project.

Overrides

StorageClient.ListBuckets(string, ListBucketsOptions)

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.

ListBucketsAsync(string, ListBucketsOptions)

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

Asynchronously lists the buckets in a given project.

Parameters
Name	Description
`projectId`	`string` The ID of the project to list the buckets from. Must not be null.
`options`	`ListBucketsOptions` The options for the operation. May be null, in which case defaults will be supplied.

Returns
Type	Description
`PagedAsyncEnumerableBucketsBucket`	An asynchronous sequence of buckets.

Overrides

StorageClient.ListBucketsAsync(string, ListBucketsOptions)

Remarks

ListHmacKeys(string, string, ListHmacKeysOptions)

public override 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`	`string` The project containing the HMAC keys. Must not be null.
`serviceAccountEmail`	`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`	`ListHmacKeysOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`PagedEnumerableHmacKeysMetadataHmacKeyMetadata`	A sequence of HMAC keys within the project.

Overrides

StorageClient.ListHmacKeys(string, string, ListHmacKeysOptions)

Remarks

ListHmacKeysAsync(string, string, ListHmacKeysOptions)

public override 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`	`string` The project containing the HMAC keys. Must not be null.
`serviceAccountEmail`	`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`	`ListHmacKeysOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`PagedAsyncEnumerableHmacKeysMetadataHmacKeyMetadata`	An asynchronous sequence of HMAC keys within the project.

Overrides

StorageClient.ListHmacKeysAsync(string, string, ListHmacKeysOptions)

Remarks

ListNotifications(string, ListNotificationsOptions)

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

Lists notification configurations associated with a bucket.

Parameters
Name	Description
`bucket`	`string` The bucket for which to list associated notification configurations. Must not be null.
`options`	`ListNotificationsOptions` The options for the operation. May be null, in which case defaults will be supplied.

Returns
Type	Description
`IReadOnlyListNotification`	A list of notification configurations associated with the specified bucket. This method never returns null.

Overrides

StorageClient.ListNotifications(string, ListNotificationsOptions)

ListNotificationsAsync(string, ListNotificationsOptions, CancellationToken)

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

Asynchronously lists notification configurations associated with a bucket.

Parameters
Name	Description
`bucket`	`string` The bucket for which to list associated notification configurations. Must not be null.
`options`	`ListNotificationsOptions` The options for the operation. May be null, in which case defaults will be supplied.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskIReadOnlyListNotification`	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.

Overrides

StorageClient.ListNotificationsAsync(string, ListNotificationsOptions, CancellationToken)

ListObjects(string, string, ListObjectsOptions)

public override 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`	`string` The bucket to list the objects from. Must not be null.
`prefix`	`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`	`ListObjectsOptions` The options for the operation. May be null, in which case defaults will be supplied.

Returns
Type	Description
`PagedEnumerableObjectsObject`	A sequence of objects in the specified bucket.

Overrides

StorageClient.ListObjects(string, string, ListObjectsOptions)

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.

ListObjectsAsync(string, string, ListObjectsOptions)

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

Asynchronously lists the objects in a given bucket.

Parameters
Name	Description
`bucket`	`string` The bucket to list the objects from. Must not be null.
`prefix`	`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`	`ListObjectsOptions` The options for the operation. May be null, in which case defaults will be supplied.

Returns
Type	Description
`PagedAsyncEnumerableObjectsObject`	An asynchronous sequence of objects in the specified bucket.

Overrides

StorageClient.ListObjectsAsync(string, string, ListObjectsOptions)

Remarks

LockBucketRetentionPolicy(string, long, LockBucketRetentionPolicyOptions)

public override 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`	`string` The name of the bucket whose retention policy should be locked. Must not be null.
`metageneration`	`long` The current metageneration of the bucket, used to validate that the bucket version to be locked is the intended one.
`options`	`LockBucketRetentionPolicyOptions` The options for the operation. May be null, in which case defaults will be supplied.

Overrides

StorageClient.LockBucketRetentionPolicy(string, long, LockBucketRetentionPolicyOptions)

LockBucketRetentionPolicyAsync(string, long, LockBucketRetentionPolicyOptions, CancellationToken)

public override 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`	`string` The name of the bucket whose retention policy should be locked. Must not be null.
`metageneration`	`long` The current metageneration of the bucket, used to validate that the bucket version to be locked is the intended one.
`options`	`LockBucketRetentionPolicyOptions` The options for the operation. May be null, in which case defaults will be supplied.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`Task`	A task representing the asynchronous operation.

Overrides

StorageClient.LockBucketRetentionPolicyAsync(string, long, LockBucketRetentionPolicyOptions, CancellationToken)

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

public override 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`	`string` The name of the bucket. Must not be null.
`labels`	`IDictionarystringstring` The labels to set. Must contain at least one entry; keys must not be null, but values may be (indicating label removal).
`options`	`ModifyBucketLabelsOptions` The options for the operation. May be null, in which case defaults will be supplied.

Returns
Type	Description
`IDictionarystringstring`	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.

Overrides

StorageClient.ModifyBucketLabels(string, IDictionary<string, string>, ModifyBucketLabelsOptions)

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.

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

public override 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`	`string` The name of the bucket. Must not be null.
`labels`	`IDictionarystringstring` The labels to set. Must contain at least one entry; keys must not be null, but values may be (indicating label removal).
`options`	`ModifyBucketLabelsOptions` The options for the operation. May be null, in which case defaults will be supplied.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskIDictionarystringstring`	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.

Overrides

StorageClient.ModifyBucketLabelsAsync(string, IDictionary<string, string>, ModifyBucketLabelsOptions, CancellationToken)

Remarks

PatchBucket(Bucket, PatchBucketOptions)

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

Patches the metadata for a storage bucket synchronously.

Parameters
Name	Description
`bucket`	`Bucket` Bucket to update. Must not be null, and must have a populated `Name` property.
`options`	`PatchBucketOptions` Additional options for the update. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`Bucket`	The Bucket representation of the updated storage bucket.

Overrides

StorageClient.PatchBucket(Bucket, PatchBucketOptions)

PatchBucketAsync(Bucket, PatchBucketOptions, CancellationToken)

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

Patches the metadata for a storage bucket asynchronously.

Parameters
Name	Description
`bucket`	`Bucket` Bucket to update. Must not be null, and must have a populated `Name` property.
`options`	`PatchBucketOptions` Additional options for the update. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskBucket`	A task representing the asynchronous operation, with a result returning the Bucket representation of the bucket storage bucket.

Overrides

StorageClient.PatchBucketAsync(Bucket, PatchBucketOptions, CancellationToken)

PatchObject(Object, PatchObjectOptions)

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

Patches the metadata for an object in storage synchronously.

Parameters
Name	Description
`obj`	`Object` Object to update. Must not be null, and must have populated `Name` and `Bucket` properties.
`options`	`PatchObjectOptions` Additional options for the update. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`Object`	The Object representation of the updated storage object.

Overrides

StorageClient.PatchObject(Object, PatchObjectOptions)

PatchObjectAsync(Object, PatchObjectOptions, CancellationToken)

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

Patches the metadata for an object in storage asynchronously.

Parameters
Name	Description
`obj`	`Object` Object to update. Must not be null, and must have populated `Name` and `Bucket` properties.
`options`	`PatchObjectOptions` Additional options for the update. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskObject`	A task representing the asynchronous operation, with a result returning the Object representation of the updated storage object.

Overrides

StorageClient.PatchObjectAsync(Object, PatchObjectOptions, CancellationToken)

SetBucketIamPolicy(string, Policy, SetBucketIamPolicyOptions)

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

Updates the IAM policy information about a bucket synchronously.

Parameters
Name	Description
`bucket`	`string` The name of the bucket. Must not be null.
`policy`	`Policy` The new IAM policy for the bucket. Must not be null.
`options`	`SetBucketIamPolicyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`Policy`	The Policy representation of the resulting storage bucket IAM policy.

Overrides

StorageClient.SetBucketIamPolicy(string, Policy, SetBucketIamPolicyOptions)

SetBucketIamPolicyAsync(string, Policy, SetBucketIamPolicyOptions, CancellationToken)

public override 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`	`string` The name of the bucket. Must not be null.
`policy`	`Policy` The new IAM policy for the bucket. Must not be null.
`options`	`SetBucketIamPolicyOptions` Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskPolicy`	A task representing the asynchronous operation, with a result returning the Policy representation of the resulting storage bucket IAM policy.

Overrides

StorageClient.SetBucketIamPolicyAsync(string, Policy, SetBucketIamPolicyOptions, CancellationToken)

TestBucketIamPermissions(string, IEnumerable<string>, TestBucketIamPermissionsOptions)

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

Tests the IAM permissions for a bucket synchronously.

Parameters
Name	Description
`bucket`	`string` The name of the bucket. Must not be null.
`permissions`	`IEnumerablestring` The permissions to test. Must not be null or empty.
`options`	`TestBucketIamPermissionsOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`IListstring`	The permissions held by the caller.

Overrides

StorageClient.TestBucketIamPermissions(string, IEnumerable<string>, TestBucketIamPermissionsOptions)

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

public override 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`	`string` The name of the bucket. Must not be null.
`permissions`	`IEnumerablestring` The permissions to test. Must not be null or empty.
`options`	`TestBucketIamPermissionsOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskIListstring`	A task representing the asynchronous operation, with a result returning the permissions held by the caller.

Overrides

StorageClient.TestBucketIamPermissionsAsync(string, IEnumerable<string>, TestBucketIamPermissionsOptions, CancellationToken)

UpdateBucket(Bucket, UpdateBucketOptions)

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

Updates the metadata for a storage bucket synchronously.

Parameters
Name	Description
`bucket`	`Bucket` Bucket to update. Must not be null, and must have a populated `Name`.
`options`	`UpdateBucketOptions` Additional options for the update. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`Bucket`	The Bucket representation of the updated storage bucket.

Overrides

StorageClient.UpdateBucket(Bucket, UpdateBucketOptions)

Remarks

If no preconditions are explicitly set in options, the metageneration of bucket is used as a precondition for the update, unless ForceNoPreconditions is set to true.

UpdateBucketAsync(Bucket, UpdateBucketOptions, CancellationToken)

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

Updates the metadata for storage bucket asynchronously.

Parameters
Name	Description
`bucket`	`Bucket` Bucket to update. Must not be null, and must have a populated `Name`.
`options`	`UpdateBucketOptions` Additional options for the update. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskBucket`	A task representing the asynchronous operation, with a result returning the Bucket representation of the storage bucket.

Overrides

StorageClient.UpdateBucketAsync(Bucket, UpdateBucketOptions, CancellationToken)

Remarks

If no preconditions are explicitly set in options, the metageneration of bucket is used as a precondition for the update, unless ForceNoPreconditions is set to true.

UpdateHmacKey(HmacKeyMetadata, UpdateHmacKeyOptions)

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

Synchronously updates an HMAC key's metadata.

Parameters
Name	Description
`key`	`HmacKeyMetadata` The key to update. Must not be null, and the ProjectId and AccessId properties must be set.
`options`	`UpdateHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`HmacKeyMetadata`	The updated key metadata.

Overrides

StorageClient.UpdateHmacKey(HmacKeyMetadata, UpdateHmacKeyOptions)

UpdateHmacKeyAsync(HmacKeyMetadata, UpdateHmacKeyOptions, CancellationToken)

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

Asynchronously updates an HMAC key's metadata.

Parameters
Name	Description
`key`	`HmacKeyMetadata` The key to update. Must not be null, and the ProjectId and AccessId properties must be set.
`options`	`UpdateHmacKeyOptions` Additional options for the operation. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskHmacKeyMetadata`	A task representing the asynchronous operation, with a result returning the updated key metadata.

Overrides

StorageClient.UpdateHmacKeyAsync(HmacKeyMetadata, UpdateHmacKeyOptions, CancellationToken)

UpdateObject(Object, UpdateObjectOptions)

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

Updates the metadata for an object in storage synchronously.

Parameters
Name	Description
`obj`	`Object` Object to update. Must not be null, and must have populated `Name` and `Bucket` properties.
`options`	`UpdateObjectOptions` Additional options for the update. May be null, in which case appropriate defaults will be used.

Returns
Type	Description
`Object`	The Object representation of the updated storage object.

Overrides

StorageClient.UpdateObject(Object, UpdateObjectOptions)

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 is set to true.

UpdateObjectAsync(Object, UpdateObjectOptions, CancellationToken)

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

Updates the metadata for an object in storage asynchronously.

Parameters
Name	Description
`obj`	`Object` Object to update. Must not be null, and must have populated `Name` and `Bucket` properties.
`options`	`UpdateObjectOptions` Additional options for the update. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`TaskObject`	A task representing the asynchronous operation, with a result returning the Object representation of the storage object.

Overrides

StorageClient.UpdateObjectAsync(Object, UpdateObjectOptions, CancellationToken)

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 is set to true.

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

public override 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`	`Object` Object to create or update. Must not be null, and must have the name, bucket and content type populated.
`source`	`Stream` The stream to read the data from. Must not be null.
`options`	`UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used.
`progress`	`IProgressIUploadProgress` Progress reporter for the upload. May be null.

Returns
Type	Description
`Object`	The Object representation of the uploaded object.

Overrides

StorageClient.UploadObject(Object, Stream, UploadObjectOptions, IProgress<IUploadProgress>)

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

public override 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`	`string` The name of the bucket containing the object. Must not be null.
`objectName`	`string` The name of the object within the bucket. Must not be null.
`contentType`	`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`	`Stream` The stream to read the data from. Must not be null.
`options`	`UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used.
`progress`	`IProgressIUploadProgress` Progress reporter for the upload. May be null.

Returns
Type	Description
`Object`	The Object representation of the uploaded object.

Overrides

StorageClient.UploadObject(string, string, string, Stream, UploadObjectOptions, IProgress<IUploadProgress>)

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

public override 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`	`Object` Object to create or update. Must not be null, and must have the name, bucket and content type populated.
`source`	`Stream` The stream to read the data from. Must not be null.
`options`	`UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.
`progress`	`IProgressIUploadProgress` Progress reporter for the upload. May be null.

Returns
Type	Description
`TaskObject`	A task representing the asynchronous operation, with a result returning the Object representation of the uploaded object.

Overrides

StorageClient.UploadObjectAsync(Object, Stream, UploadObjectOptions, CancellationToken, IProgress<IUploadProgress>)

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

public override 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`	`string` The name of the bucket containing the object. Must not be null.
`objectName`	`string` The name of the object within the bucket. Must not be null.
`contentType`	`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`	`Stream` The stream to read the data from. Must not be null.
`options`	`UploadObjectOptions` Additional options for the upload. May be null, in which case appropriate defaults will be used.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.
`progress`	`IProgressIUploadProgress` Progress reporter for the upload. May be null.

Returns
Type	Description
`TaskObject`	A task representing the asynchronous operation, with a result returning the Object representation of the uploaded object.

Overrides

StorageClient.UploadObjectAsync(string, string, string, Stream, UploadObjectOptions, CancellationToken, IProgress<IUploadProgress>)