Google Cloud Storage v1 API - Class UrlSigner.RequestTemplate (4.2.0)

public sealed class RequestTemplate

When either of the headers collections are specified, there are certain headers which will be included in the signed URL's signature, and therefore must be included in requests made with the created URL. These are the Content-MD5 and Content-Type content headers as well as any content or request header with a name starting with "x-goog-".

If the headers collections are null or empty, no headers are included in the signed URL's signature, so any requests made with the created URL must not contain Content-MD5, Content-Type, or any header starting with "x-goog-".

Note that when GET is specified as the HttpMethod (or it is null, in which case GET is used), both GET and HEAD requests can be made with the created signed URL.

public string Bucket { get; }

public IReadOnlyDictionary<string, IReadOnlyCollection<string>> ContentHeaders { get; }

When using V2, from all the headers supplied in ContentHeaders, only the ones starting with "x-goog-", the Content-MD5 and the Content-Type headers will be included in the signed URL's signature and therefor must be included in requests made with the created URL. All other headers supplied in ContentHeaders will be ignored when creating the signed URL so they shouldn't be included in requests made with the created URL.

When using V4 all headers supplied in ContentHeaders will be included in the signed URL's signature and therefor must be included in requests made with the created URL.

public HttpMethod HttpMethod { get; }

Note that when GET is specified as the HttpMethod, both GET and HEAD requests can be made with the created signed URL.

public string ObjectName { get; }

public IReadOnlyDictionary<string, IReadOnlyCollection<string>> QueryParameters { get; }

When using V2 custom query parameters are not supported by the signing process and Sign(UrlSigner.RequestTemplate, UrlSigner.Options) and SignAsync(UrlSigner.RequestTemplate, UrlSigner.Options, CancellationToken) will throw ArgumentException if QueryParameters is not an empty dictionary, that is, if one or more custom query parameters have been specified.

public IReadOnlyDictionary<string, IReadOnlyCollection<string>> RequestHeaders { get; }

When using V2, from all the headers supplied in RequestHeaders, only the ones starting with "x-goog-" will be included in the signed URL's signature and therefor must be included in requests made with the created URL. All other headers supplied in RequestHeaders will be ignored when creating the signed URL so they shouldn't be included in requests made with the created URL.

When using V4 all headers supplied in RequestHeaders will be included in the signed URL's signature and therefor must be included in requests made with the created URL.

Note that if the entity is encrypted with customer-supplied encryption keys (see https://cloud.google.com/storage/docs/encryption for more information), the x-goog-encryption-algorithm, x-goog-encryption-key, and x-goog-encryption-key-sha256 headers will be required when making the request. However, only the x-goog-encryption-algorithm header is included in the signature for the signed URL. So the RequestHeaders specified only need to have the x-goog-encryption-algorithm header.

public static UrlSigner.RequestTemplate FromBucket(string bucket)

public UrlSigner.RequestTemplate WithBucket(string bucket)

public UrlSigner.RequestTemplate WithContentHeaders(IEnumerable<KeyValuePair<string, IEnumerable<string>>> contentHeaders)

public UrlSigner.RequestTemplate WithHttpMethod(HttpMethod method)

public UrlSigner.RequestTemplate WithHttpRequestMessage(HttpRequestMessage requestMessage)

public UrlSigner.RequestTemplate WithObjectName(string objectName)

public UrlSigner.RequestTemplate WithQueryParameters(IEnumerable<KeyValuePair<string, IEnumerable<string>>> queryParameters)

public UrlSigner.RequestTemplate WithRequestHeaders(IEnumerable<KeyValuePair<string, IEnumerable<string>>> requestHeaders)