Class ApiKeyToken

A token constructed from an apiKey.

Inheritance

object

TokenBase

ApiKeyToken

Inherited Members

TokenBase.IsRateLimited

TokenBase.BeginRateLimit()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Pulumi.Esc.Sdk.Client

Assembly: Pulumi.Esc.Sdk.dll

Syntax

public class ApiKeyToken : TokenBase

Constructors

ApiKeyToken(string, ApiKeyHeader, string, TimeSpan?)

Constructs an ApiKeyToken object.

Declaration

public ApiKeyToken(string value, ClientUtils.ApiKeyHeader header, string prefix = "Bearer ", TimeSpan? timeout = null)

Parameters

Type	Name	Description
string	value
ClientUtils.ApiKeyHeader	header
string	prefix
TimeSpan?	timeout

Properties

Header

The header that this token will be used with.

Declaration

public ClientUtils.ApiKeyHeader Header { get; }

Property Value

Type	Description
ClientUtils.ApiKeyHeader

Methods

UseInHeader(HttpRequestMessage)

Places the token in the header.

Declaration

public virtual void UseInHeader(HttpRequestMessage request)

Parameters

Type	Name	Description
HttpRequestMessage	request

UseInQuery(HttpRequestMessage, UriBuilder, NameValueCollection)

Places the token in the query.

Declaration

public virtual void UseInQuery(HttpRequestMessage request, UriBuilder uriBuilder, NameValueCollection parseQueryString)

Parameters

Type	Name	Description
HttpRequestMessage	request
UriBuilder	uriBuilder
NameValueCollection	parseQueryString