Google Cloud Storage v1 API - Interface UrlSigner.IBlobSigner (4.8.0)

public interface UrlSigner.IBlobSigner

Reference documentation and code samples for the Google Cloud Storage v1 API interface UrlSigner.IBlobSigner.

Represents the capability of signing a blob in a suitable form for Google Cloud Storage signed URLs. This allows testing URL signing without credentials being available, as well as using Google Cloud IAM to sign blobs.

Namespace

Google.Cloud.Storage.V1

Assembly

Google.Cloud.Storage.V1.dll

Properties

Algorithm

string Algorithm { get; }

The signing algorithm used by this blob signer.

Property Value
Type	Description
`string`

Id

string Id { get; }

The identity of the signer, typically an email address.

Property Value
Type	Description
`string`

Methods

CreateSignature(byte[], BlobSignerParameters)

string CreateSignature(byte[] data, UrlSigner.BlobSignerParameters parameters)

Synchronously signs the given blob.

Parameters
Name	Description
`data`	`byte` The data to sign. Must not be null.
`parameters`	`UrlSignerBlobSignerParameters` Parameters to use when deriving the signing key. Concrete implementations may allow a null value if no parameters are required.

Returns
Type	Description
`string`	The blob signature as base64 text.

CreateSignatureAsync(byte[], BlobSignerParameters, CancellationToken)

Task<string> CreateSignatureAsync(byte[] data, UrlSigner.BlobSignerParameters parameters, CancellationToken cancellationToken)

Asynchronously signs the given blob.

Parameters
Name	Description
`data`	`byte` The data to sign. Must not be null.
`parameters`	`UrlSignerBlobSignerParameters` Parameters to use when deriving the signing key. Concrete implementations may allow a null value if no parameters are required.
`cancellationToken`	`CancellationToken` The token to monitor for cancellation requests.

Returns
Type	Description
`Taskstring`	A task representing the asynchronous operation, with a result returning the blob signature as base64 text.