Class StorageClient

public abstract class StorageClient : IDisposable

Abstract class providing operations for Google Cloud Storage.

Inheritance

Object > StorageClient

Implements

IDisposable

Derived Types

Namespace

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) and CreateAsync(GoogleCredential, EncryptionKey) to construct instances; alternatively, you can construct a StorageClientImpl directly from a StorageService.

All instance methods declared in this class are virtual, with an implementation which simply throws NotImplementedException. All these methods are overridden in StorageClientImpl.

This class implements IDisposable; however, the Dispose() method only requires calling if many short-lived instances of 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 is returned.

Property Value
TypeDescription
EncryptionKey

Service

public virtual StorageService Service { get; }

The underlying storage service object used by this client.

Property Value
TypeDescription
StorageService
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 virtual IDictionary<string, string> ClearBucketLabels(string bucket, ModifyBucketLabelsOptions options = null)

Clears all labels on a bucket.

Parameters
NameDescription
bucketString

The name of the bucket. Must not be null.

optionsModifyBucketLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.

Returns
TypeDescription
IDictionary<String, 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(CancellationToken))

Clears all labels on a bucket asynchronously.

Parameters
NameDescription
bucketString

The name of the bucket. Must not be null.

optionsModifyBucketLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<IDictionary<String, String>>

A dictionary with the labels on the bucket before they were cleared.

Example

See ClearBucketLabels 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
NameDescription
sourceBucketString

The name of the bucket containing the object to copy. Must not be null.

sourceObjectNameString

The name of the object to copy within the bucket. Must not be null.

destinationBucketString

The name of the bucket to copy the object to. Must not be null.

destinationObjectNameString

The name of the object within the destination bucket. Must not be null.

optionsCopyObjectOptions

Additional options for the copy operation. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
Object

The Object 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(CancellationToken))

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
NameDescription
sourceBucketString

The name of the bucket containing the object to copy. Must not be null.

sourceObjectNameString

The name of the object to copy within the bucket. Must not be null.

destinationBucketString

The name of the bucket to copy the object to. Must not be null.

destinationObjectNameString

The name of the object within the destination bucket. Must not be null.

optionsCopyObjectOptions

Additional options for the copy operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Object>

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

Example

See CopyObject for a synchronous example.

Create(GoogleCredential, EncryptionKey)

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

Synchronously creates a StorageClient, using application default credentials if no credentials are specified.

Parameters
NameDescription
credentialGoogleCredential

Optional GoogleCredential.

encryptionKeyEncryptionKey

Optional EncryptionKey to use for all relevant object-based operations by default. May be null.

Returns
TypeDescription
StorageClient

The created StorageClient.

Remarks

The credentials are scoped as necessary.

CreateAsync(GoogleCredential, EncryptionKey)

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

Asynchronously creates a StorageClient, using application default credentials if no credentials are specified.

Parameters
NameDescription
credentialGoogleCredential

Optional GoogleCredential.

encryptionKeyEncryptionKey

Optional EncryptionKey to use for all relevant object-based operations by default. May be null.

Returns
TypeDescription
Task<StorageClient>

The task representing the created StorageClient.

Remarks

The credentials are scoped as necessary.

CreateBucket(String, Bucket, CreateBucketOptions)

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

Creates a storage bucket synchronously.

Parameters
NameDescription
projectIdString

The ID of the project to create the buckets in. Must not be null.

bucketBucket

The resource representation of the bucket to create. Must not be null, and must have a name.

optionsCreateBucketOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
Bucket

The resource representation of the newly-created bucket.

Example

See CreateBucket 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
NameDescription
projectIdString

The ID of the project to create the buckets in. Must not be null.

bucketString

The name of the bucket to create. Must not be null.

optionsCreateBucketOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
Bucket

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(CancellationToken))

Creates a storage bucket asynchronously.

Parameters
NameDescription
projectIdString

The ID of the project to create the buckets in. Must not be null.

bucketBucket

The resource representation of the bucket to create. Must not be null, and must have a name.

optionsCreateBucketOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Bucket>

A task representing the asynchronous operation, with a result returning the resource representation of the newly-created bucket.

Example

See CreateBucket for a synchronous example.

CreateBucketAsync(String, String, CreateBucketOptions, CancellationToken)

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

Creates a storage bucket asynchronously.

Parameters
NameDescription
projectIdString

The ID of the project to create the buckets in. Must not be null.

bucketString

The name of the bucket to create. Must not be null.

optionsCreateBucketOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Bucket>

A task representing the asynchronous operation, with a result returning the resource representation of the newly-created bucket.

Example

See CreateBucket 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
NameDescription
projectIdString

The project ID in which to create the HMAC key. Must not be null.

serviceAccountEmailString

The service account to associate with the HMAC key. Must not be null.

optionsCreateHmacKeyOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
HmacKey

The new HMAC key, including the secret information in 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(CancellationToken))

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

Parameters
NameDescription
projectIdString

The project ID in which to create the HMAC key. Must not be null.

serviceAccountEmailString

The service account to associate with the HMAC key. Must not be null.

optionsCreateHmacKeyOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<HmacKey>

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.

CreateNotification(String, Notification, CreateNotificationOptions)

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

Creates a notification configuration.

Parameters
NameDescription
bucketString

The bucket for which to create the notification configuration. Must not be null.

notificationNotification

The notification configuration to create. Must not be null.

optionsCreateNotificationOptions

The options for the operation. May be null, in which case defaults will be supplied.

Returns
TypeDescription
Notification

The Notification 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(CancellationToken))

Asynchronously creates a notification configuration.

Parameters
NameDescription
bucketString

The bucket for which to create the notification configuration. Must not be null.

notificationNotification

The notification configuration to create. Must not be null.

optionsCreateNotificationOptions

The options for the operation. May be null, in which case defaults will be supplied.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Notification>

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

Example

See CreateNotification 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
NameDescription
destinationObject

Object to create or update. Must not be null, and must have the name, bucket and content type populated.

sourceStream

The stream to read the data from. Must not be null.

optionsUploadObjectOptions

Additional options for the upload. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
ObjectsResource.InsertMediaUpload

The ObjectsResource.InsertMediaUpload which can be used to upload the object.

See Also

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
NameDescription
bucketString

The name of the bucket containing the object. Must not be null.

objectNameString

The name of the object within the bucket. Must not be null.

contentTypeString

The content type of the object. This should be a MIME type such as "text/html" or "application/octet-stream". May be null.

sourceStream

The stream to read the data from. Must not be null.

optionsUploadObjectOptions

Additional options for the upload. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
ObjectsResource.InsertMediaUpload

The ObjectsResource.InsertMediaUpload which can be used to upload the object.

See Also

CreateUnauthenticated()

public static StorageClient CreateUnauthenticated()

Creates a StorageClient with no credentials. This can only be used in limited situations (where authentication isn't required), primarily downloading public data.

Returns
TypeDescription
StorageClient

The created StorageClient.

DeleteBucket(Bucket, DeleteBucketOptions)

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

Deletes a bucket synchronously.

Parameters
NameDescription
bucketBucket

Bucket to delete. Must not be null, and must have the name populated.

optionsDeleteBucketOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

Example

See DeleteBucket for an example using an alternative overload.

DeleteBucket(String, DeleteBucketOptions)

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

Deletes a bucket synchronously.

Parameters
NameDescription
bucketString

The name of the bucket to delete. Must not be null.

optionsDeleteBucketOptions

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(CancellationToken))

Deletes bucket asynchronously.

Parameters
NameDescription
bucketBucket

Bucket to delete. Must not be null, and must have the name populated.

optionsDeleteBucketOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task

A task representing the asynchronous operation.

Example

See DeleteBucket for a synchronous example.

DeleteBucketAsync(String, DeleteBucketOptions, CancellationToken)

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

Deletes a bucket asynchronously.

Parameters
NameDescription
bucketString

The name of the bucket to delete. Must not be null.

optionsDeleteBucketOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task

A task representing the asynchronous operation.

Example

See DeleteBucket 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
NameDescription
projectIdString

The ID of the project containing the HMAC key to delete.

accessIdString

The ID of the HMAC key to delete. Must not be null.

optionsDeleteHmacKeyOptions

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(CancellationToken))

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

Parameters
NameDescription
projectIdString

The ID of the project containing the HMAC key to delete.

accessIdString

The ID of the HMAC key to delete. Must not be null.

optionsDeleteHmacKeyOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
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
NameDescription
bucketString

The bucket associated with the notification configuration. Must not be null.

notificationIdString

ID of the notification configuration to delete. Must not be null.

optionsDeleteNotificationOptions

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(CancellationToken))

Asynchronously deletes a notification configuration.

Parameters
NameDescription
bucketString

The bucket associated with the notification configuration. Must not be null.

notificationIdString

ID of the notification configuration to delete. Must not be null.

optionsDeleteNotificationOptions

The options for the operation. May be null, in which case defaults will be supplied.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task

A task representing the asynchronous operation.

Example

See DeleteNotification 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
NameDescription
objObject

Object to delete. Must not be null, and must have the name and bucket populated.

optionsDeleteObjectOptions

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

Example

See DeleteObject 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
NameDescription
bucketString

The name of the bucket containing the object. Must not be null.

objectNameString

The name of the object within the bucket. Must not be null.

optionsDeleteObjectOptions

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

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(CancellationToken))

Deletes a version of the specified object asynchronously.

Parameters
NameDescription
objObject

Object to delete. Must not be null, and must have the name and bucket populated.

optionsDeleteObjectOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
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. 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.

Example

See DeleteObject for a synchronous example.

DeleteObjectAsync(String, String, DeleteObjectOptions, CancellationToken)

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

Deletes a version of the specified object asynchronously.

Parameters
NameDescription
bucketString

The name of the bucket containing the object. Must not be null.

objectNameString

The name of the object within the bucket. Must not be null.

optionsDeleteObjectOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
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. 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.

Example

See DeleteObject for a synchronous example.

Dispose()

public virtual void Dispose()

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

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

public virtual void 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
NameDescription
sourceObject

Source object to download the data from. Must not be null.

destinationStream

The stream to write the data into. Must not be null.

optionsDownloadObjectOptions

Additional options for the download. May be null, in which case appropriate defaults will be used.

progressIProgress<IDownloadProgress>

Progress reporter for the download. May be null.

Remarks

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

Example

See DownloadObject for an example using an alternative overload.

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

public virtual void 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
NameDescription
bucketString

The name of the bucket containing the object. Must not be null.

objectNameString

The name of the object within the bucket. Must not be null.

destinationStream

The stream to write the data into. Must not be null.

optionsDownloadObjectOptions

Additional options for the download. May be null, in which case appropriate defaults will be used.

progressIProgress<IDownloadProgress>

Progress reporter for the download. May be null.

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 DownloadObjectAsync(Object source, Stream destination, DownloadObjectOptions options = null, CancellationToken cancellationToken = default(CancellationToken), IProgress<IDownloadProgress> progress = null)

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

Parameters
NameDescription
sourceObject

Source object to download the data from. Must not be null.

destinationStream

The stream to write the data into. Must not be null.

optionsDownloadObjectOptions

Additional options for the download. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

progressIProgress<IDownloadProgress>

Progress reporter for the download. May be null.

Returns
TypeDescription
Task

A task representing the asynchronous operation.

Remarks

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

Example

See DownloadObject for a synchronous example.

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

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

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

Parameters
NameDescription
bucketString

The name of the bucket containing the object. Must not be null.

objectNameString

The name of the object within the bucket. Must not be null.

destinationStream

The stream to write the data into. Must not be null.

optionsDownloadObjectOptions

Additional options for the download. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

progressIProgress<IDownloadProgress>

Progress reporter for the download. May be null.

Returns
TypeDescription
Task

A task representing the asynchronous operation.

Example

See DownloadObject for a synchronous example.

GetBucket(String, GetBucketOptions)

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

Fetches the information about a bucket synchronously.

Parameters
NameDescription
bucketString

The name of the bucket. Must not be null.

optionsGetBucketOptions

Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
Bucket

The Bucket representation of the storage bucket.

Example
var client = StorageClient.Create();

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

GetBucketAsync(String, GetBucketOptions, CancellationToken)

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

Fetches the information about a bucket asynchronously.

Parameters
NameDescription
bucketString

The name of the bucket. Must not be null.

optionsGetBucketOptions

Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Bucket>

A task representing the asynchronous operation, with a result returning the Bucket representation of the storage bucket.

Example

See GetBucket 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
NameDescription
bucketString

The name of the bucket. Must not be null.

optionsGetBucketIamPolicyOptions

Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
Policy

The Policy 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(CancellationToken))

Fetches the IAM policy information about a bucket asynchronously.

Parameters
NameDescription
bucketString

The name of the bucket. Must not be null.

optionsGetBucketIamPolicyOptions

Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Policy>

A task representing the asynchronous operation, with a result returning the Policy representation of the storage bucket IAM policy.

Example

See GetBucketIamPolicy 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
NameDescription
projectIdString

The project containing the HMAC key. Must not be null.

accessIdString

The ID of the HMAC key. Must not be null.

optionsGetHmacKeyOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
HmacKeyMetadata

The HMAC key metadata

GetHmacKeyAsync(String, String, GetHmacKeyOptions, CancellationToken)

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

Asynchronously fetches metadata for the specified HMAC key.

Parameters
NameDescription
projectIdString

The project containing the HMAC key. Must not be null.

accessIdString

The ID of the HMAC key. Must not be null.

optionsGetHmacKeyOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<HmacKeyMetadata>

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
NameDescription
bucketString

The bucket associated with the notification configuration. Must not be null.

notificationIdString

ID of the notification configuration to fetch. Must not be null.

optionsGetNotificationOptions

The options for the operation. May be null, in which case defaults will be supplied.

Returns
TypeDescription
Notification

The Notification 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(CancellationToken))

Asynchronously fetches a notification configuration.

Parameters
NameDescription
bucketString

The bucket associated with the notification configuration. Must not be null.

notificationIdString

ID of the notification configuration to fetch. Must not be null.

optionsGetNotificationOptions

The options for the operation. May be null, in which case defaults will be supplied.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Notification>

A task representing the asynchronous operation, with a result returning the Notification representation of the notification configuration.

Example

See GetNotification 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
NameDescription
bucketString

The name of the bucket containing the object. Must not be null.

objectNameString

The name of the object within the bucket. Must not be null.

optionsGetObjectOptions

Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
Object

The Object representation of the storage object.

Remarks

This does not retrieve the content of the object itself. Use DownloadObject(String, String, Stream, DownloadObjectOptions, IProgress<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.TimeCreated}");

GetObjectAsync(String, String, GetObjectOptions, CancellationToken)

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

Fetches the information about an object asynchronously.

Parameters
NameDescription
bucketString

The name of the bucket containing the object. Must not be null.

objectNameString

The name of the object within the bucket. Must not be null.

optionsGetObjectOptions

Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Object>

A task representing the asynchronous operation, with a result returning the Object 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>) to download the content.

Example

See GetObject 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
NameDescription
projectIdString

ID of the project to retrieve the service account for. Must not be null.

optionsGetStorageServiceAccountEmailOptions

The options for the operation. May be null, in which case defaults will be supplied.

Returns
TypeDescription
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(CancellationToken))

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

Parameters
NameDescription
projectIdString

ID of the project to retrieve the service account for. Must not be null.

optionsGetStorageServiceAccountEmailOptions

The options for the operation. May be null, in which case defaults will be supplied.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<String>

A task representing the asynchronous operation, with a result returning the email address of the service account.

Example

See GetStorageServiceAccountEmail for a synchronous example.

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
NameDescription
projectIdString

The ID of the project to list the buckets from. Must not be null.

optionsListBucketsOptions

The options for the operation. May be null, in which case defaults will be supplied.

Returns
TypeDescription
PagedEnumerable<Buckets, Bucket>

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
NameDescription
projectIdString

The ID of the project to list the buckets from. Must not be null.

optionsListBucketsOptions

The options for the operation. May be null, in which case defaults will be supplied.

Returns
TypeDescription
PagedAsyncEnumerable<Buckets, Bucket>

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 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
NameDescription
projectIdString

The project containing the HMAC keys. Must not be null.

serviceAccountEmailString

The service account email address to list keys for. May be null, in which case all HMAC keys associated with the project are returned.

optionsListHmacKeysOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
PagedEnumerable<HmacKeysMetadata, HmacKeyMetadata>

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
NameDescription
projectIdString

The project containing the HMAC keys. Must not be null.

serviceAccountEmailString

The service account email address to list keys for. May be null, in which case all HMAC keys associated with the project are returned.

optionsListHmacKeysOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
PagedAsyncEnumerable<HmacKeysMetadata, HmacKeyMetadata>

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
NameDescription
bucketString

The bucket for which to list associated notification configurations. Must not be null.

optionsListNotificationsOptions

The options for the operation. May be null, in which case defaults will be supplied.

Returns
TypeDescription
IReadOnlyList<Notification>

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(CancellationToken))

Asynchronously lists notification configurations associated with a bucket.

Parameters
NameDescription
bucketString

The bucket for which to list associated notification configurations. Must not be null.

optionsListNotificationsOptions

The options for the operation. May be null, in which case defaults will be supplied.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<IReadOnlyList<Notification>>

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 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
NameDescription
bucketString

The bucket to list the objects from. Must not be null.

prefixString

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.

optionsListObjectsOptions

The options for the operation. May be null, in which case defaults will be supplied.

Returns
TypeDescription
PagedEnumerable<Objects, Object>

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
NameDescription
bucketString

The bucket to list the objects from. Must not be null.

prefixString

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.

optionsListObjectsOptions

The options for the operation. May be null, in which case defaults will be supplied.

Returns
TypeDescription
PagedAsyncEnumerable<Objects, Object>

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 for a synchronous example.

LockBucketRetentionPolicy(String, Int64, 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
NameDescription
bucketString

The name of the bucket whose retention policy should be locked. Must not be null.

metagenerationInt64

The current metageneration of the bucket, used to validate that the bucket version to be locked is the intended one.

optionsLockBucketRetentionPolicyOptions

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, Int64, LockBucketRetentionPolicyOptions, CancellationToken)

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

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
NameDescription
bucketString

The name of the bucket whose retention policy should be locked. Must not be null.

metagenerationInt64

The current metageneration of the bucket, used to validate that the bucket version to be locked is the intended one.

optionsLockBucketRetentionPolicyOptions

The options for the operation. May be null, in which case defaults will be supplied.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task

A task representing the asynchronous operation.

Example

See LockBucketRetentionPolicy 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
NameDescription
bucketString

The name of the bucket. Must not be null.

labelsIDictionary<String, String>

The labels to set. Must contain at least one entry; keys must not be null, but values may be (indicating label removal).

optionsModifyBucketLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.

Returns
TypeDescription
IDictionary<String, 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(CancellationToken))

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

Parameters
NameDescription
bucketString

The name of the bucket. Must not be null.

labelsIDictionary<String, String>

The labels to set. Must contain at least one entry; keys must not be null, but values may be (indicating label removal).

optionsModifyBucketLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<IDictionary<String, 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 for a synchronous example.

PatchBucket(Bucket, PatchBucketOptions)

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

Patches the metadata for a storage bucket synchronously.

Parameters
NameDescription
bucketBucket

Bucket to update. Must not be null, and must have a populated Name property.

optionsPatchBucketOptions

Additional options for the update. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
Bucket

The Bucket 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(CancellationToken))

Patches the metadata for a storage bucket asynchronously.

Parameters
NameDescription
bucketBucket

Bucket to update. Must not be null, and must have a populated Name property.

optionsPatchBucketOptions

Additional options for the update. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Bucket>

A task representing the asynchronous operation, with a result returning the Bucket representation of the bucket storage bucket.

Example

See PatchBucket 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
NameDescription
objObject

Object to update. Must not be null, and must have populated Name and Bucket properties.

optionsPatchObjectOptions

Additional options for the update. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
Object

The Object 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(CancellationToken))

Patches the metadata for an object in storage asynchronously.

Parameters
NameDescription
objObject

Object to update. Must not be null, and must have populated Name and Bucket properties.

optionsPatchObjectOptions

Additional options for the update. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Object>

A task representing the asynchronous operation, with a result returning the Object representation of the updated storage object.

Example

See PatchObject 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
NameDescription
bucketString

The name of the bucket. Must not be null.

labelNameString

The name of the label to remove. Must not be null.

optionsModifyBucketLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.

Returns
TypeDescription
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).

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(CancellationToken))

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
NameDescription
bucketString

The name of the bucket. Must not be null.

labelNameString

The name of the label to remove. Must not be null.

optionsModifyBucketLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<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).

Example

See RemoveBucketLabel for a synchronous example.

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
NameDescription
bucketString

The name of the bucket. Must not be null.

policyPolicy

The new IAM policy for the bucket. Must not be null.

optionsSetBucketIamPolicyOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
Policy

The Policy 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(CancellationToken))

Updates the IAM policy information about a bucket asynchronously.

Parameters
NameDescription
bucketString

The name of the bucket. Must not be null.

policyPolicy

The new IAM policy for the bucket. Must not be null.

optionsSetBucketIamPolicyOptions

Additional options for the fetch operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Policy>

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

Example

See SetBucketIamPolicy 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
NameDescription
bucketString

The name of the bucket. Must not be null.

labelNameString

The name of the label to set. Must not be null.

labelValueString

The value of the label to set. Must not be null.

optionsModifyBucketLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.

Returns
TypeDescription
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).

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(CancellationToken))

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
NameDescription
bucketString

The name of the bucket. Must not be null.

labelNameString

The name of the label to set. Must not be null.

labelValueString

The value of the label to set. Must not be null.

optionsModifyBucketLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<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).

Example

See SetBucketLabel 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
NameDescription
bucketString

The name of the bucket. Must not be null.

permissionsIEnumerable<String>

The permissions to test. Must not be null or empty.

optionsTestBucketIamPermissionsOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
IList<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(CancellationToken))

Tests the IAM policy information about a bucket asynchronously.

Parameters
NameDescription
bucketString

The name of the bucket. Must not be null.

permissionsIEnumerable<String>

The permissions to test. Must not be null or empty.

optionsTestBucketIamPermissionsOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<IList<String>>

A task representing the asynchronous operation, with a result returning the permissions held by the caller.

Example

See TestBucketIamPermissions 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
NameDescription
bucketBucket

Bucket to update. Must not be null, and must have a populated Name.

optionsUpdateBucketOptions

Additional options for the update. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
Bucket

The Bucket 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 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(CancellationToken))

Updates the metadata for storage bucket asynchronously.

Parameters
NameDescription
bucketBucket

Bucket to update. Must not be null, and must have a populated Name.

optionsUpdateBucketOptions

Additional options for the update. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Bucket>

A task representing the asynchronous operation, with a result returning the Bucket 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 is set to true.

Example

See UpdateBucket for a synchronous example.

UpdateHmacKey(HmacKeyMetadata, UpdateHmacKeyOptions)

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

Synchronously updates an HMAC key's metadata.

Parameters
NameDescription
keyHmacKeyMetadata

The key to update. Must not be null, and the ProjectId and AccessId properties must be set.

optionsUpdateHmacKeyOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
HmacKeyMetadata

The updated key metadata.

UpdateHmacKeyAsync(HmacKeyMetadata, UpdateHmacKeyOptions, CancellationToken)

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

Asynchronously updates an HMAC key's metadata.

Parameters
NameDescription
keyHmacKeyMetadata

The key to update. Must not be null, and the ProjectId and AccessId properties must be set.

optionsUpdateHmacKeyOptions

Additional options for the operation. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<HmacKeyMetadata>

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
NameDescription
objObject

Object to update. Must not be null, and must have populated Name and Bucket properties.

optionsUpdateObjectOptions

Additional options for the update. May be null, in which case appropriate defaults will be used.

Returns
TypeDescription
Object

The Object 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 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(CancellationToken))

Updates the metadata for an object in storage asynchronously.

Parameters
NameDescription
objObject

Object to update. Must not be null, and must have populated Name and Bucket properties.

optionsUpdateObjectOptions

Additional options for the update. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Object>

A task representing the asynchronous operation, with a result returning the Object 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 is set to true.

Example

See UpdateObject 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
NameDescription
destinationObject

Object to create or update. Must not be null, and must have the name, bucket and content type populated.

sourceStream

The stream to read the data from. Must not be null.

optionsUploadObjectOptions

Additional options for the upload. May be null, in which case appropriate defaults will be used.

progressIProgress<IUploadProgress>

Progress reporter for the upload. May be null.

Returns
TypeDescription
Object

The Object representation of the uploaded object.

Example

See UploadObject 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
NameDescription
bucketString

The name of the bucket containing the object. Must not be null.

objectNameString

The name of the object within the bucket. Must not be null.

contentTypeString

The content type of the object. This should be a MIME type such as "text/html" or "application/octet-stream". May be null.

sourceStream

The stream to read the data from. Must not be null.

optionsUploadObjectOptions

Additional options for the upload. May be null, in which case appropriate defaults will be used.

progressIProgress<IUploadProgress>

Progress reporter for the upload. May be null.

Returns
TypeDescription
Object

The Object 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 acl = PredefinedAcl.PublicRead // public
    var acl = PredefinedObjectAcl.AuthenticatedRead; // private
    var options = new UploadObjectOptions { PredefinedAcl = acl };
    var obj = client.UploadObject(bucketName, destination, contentType, stream, options, progress);
}

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

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

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

Parameters
NameDescription
destinationObject

Object to create or update. Must not be null, and must have the name, bucket and content type populated.

sourceStream

The stream to read the data from. Must not be null.

optionsUploadObjectOptions

Additional options for the upload. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

progressIProgress<IUploadProgress>

Progress reporter for the upload. May be null.

Returns
TypeDescription
Task<Object>

A task representing the asynchronous operation, with a result returning the Object representation of the uploaded object.

Example

See UploadObject 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(CancellationToken), IProgress<IUploadProgress> progress = null)

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

Parameters
NameDescription
bucketString

The name of the bucket containing the object. Must not be null.

objectNameString

The name of the object within the bucket. Must not be null.

contentTypeString

The content type of the object. This should be a MIME type such as "text/html" or "application/octet-stream". May be null.

sourceStream

The stream to read the data from. Must not be null.

optionsUploadObjectOptions

Additional options for the upload. May be null, in which case appropriate defaults will be used.

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

progressIProgress<IUploadProgress>

Progress reporter for the upload. May be null.

Returns
TypeDescription
Task<Object>

A task representing the asynchronous operation, with a result returning the Object representation of the uploaded object.

Example

See UploadObject for a synchronous example.