1. trait
  2. Google
  3. \
  4. Auth
  5. \
  6. UpdateMetadataTrait

UpdateMetadataTrait

trait UpdateMetadataTrait (View source)

internal  
 

Provides shared methods for updating request metadata (request headers).

Should implement {\Google\Auth\UpdateMetadataInterface} and {\Google\Auth\FetchAuthTokenInterface}.

Traits

MetricsTrait

Trait containing helper methods required for enabling observability metrics in the library.

Properties

static protected string $metricMetadataKey from  MetricsTrait

Methods

static string
getMetricsHeader(string $credType = '', string $authRequestType = '')

No description

from  MetricsTrait
array
applyServiceApiUsageMetrics(array $metadata)

No description

from  MetricsTrait
array
applyTokenEndpointMetrics(array $metadata, string $authRequestType)

No description

from  MetricsTrait
static string
getVersion()

No description

from  MetricsTrait
string
getCredType()

No description

from  MetricsTrait
callable
getUpdateMetadataFunc() deprecated

export a callback function which updates runtime metadata.

array
updateMetadata(array $metadata, string $authUri = null, callable|null $httpHandler = null)

Updates metadata with the authorization token.

Details

in MetricsTrait at line 47
static protected string getMetricsHeader(string $credType = '', string $authRequestType = '')

No description

Parameters

string $credType

[Optional] The credential type. Empty value will not add any credential type to the header. Should be one of 'sa', 'jwt', 'imp', 'mds', 'u'.
string $authRequestType

[Optional] The auth request type. Empty value will not add any auth request type to the header. Should be one of 'at', 'it', 'mds'.

Return Value

string

The header value for the observability metrics.

in MetricsTrait at line 72
protected array applyServiceApiUsageMetrics(array $metadata)

No description

Parameters

array $metadata

The metadata to update and return.

Return Value

array

The updated metadata.

in MetricsTrait at line 98
protected array applyTokenEndpointMetrics(array $metadata, string $authRequestType)

No description

Parameters

array $metadata

The metadata to update and return.
string $authRequestType

The auth request type. Possible values are 'at', 'it', 'mds'.

Return Value

array

The updated metadata.

in MetricsTrait at line 107
static protected string getVersion()

No description

Return Value

string

in MetricsTrait at line 116
protected string getCredType()

No description

Return Value

string

at line 37
callable getUpdateMetadataFunc() deprecated

deprecated

export a callback function which updates runtime metadata.

Return Value

callable

updateMetadata function

at line 50
array updateMetadata(array $metadata, string $authUri = null, callable|null $httpHandler = null)

Updates metadata with the authorization token.

Parameters

array $metadata

metadata hashmap
string $authUri

optional auth uri
callable|null $httpHandler

callback which delivers psr7 request

Return Value

array

updated metadata hashmap