From c7cb93c8d6e27fed1e371f2aa6adf0365eedb4aa Mon Sep 17 00:00:00 2001 From: bshaffer Date: Tue, 28 Nov 2023 15:48:22 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=2035781?= =?UTF-8?q?ed573aa9d831d38452eefbac790559dfb97=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- main/Google/Auth.html | 9 + main/Google/Auth/Credentials.html | 10 - .../Credentials/AppIdentityCredentials.html | 64 +- .../Auth/Credentials/GCECredentials.html | 64 +- ...ImpersonatedServiceAccountCredentials.html | 64 +- .../ServiceAccountCredentials.html | 1295 ----------------- .../ServiceAccountJwtAccessCredentials.html | 64 +- .../Credentials/UserRefreshCredentials.html | 64 +- main/Google/Auth/CredentialsLoader.html | 66 +- main/Google/Auth/FetchAuthTokenCache.html | 66 +- .../Auth/GetUniverseDomainInterface.html | 231 +++ main/classes.html | 19 +- main/doc-index.html | 48 +- main/interfaces.html | 9 + main/renderer.index | 2 +- main/sami.js | 22 +- 16 files changed, 661 insertions(+), 1436 deletions(-) delete mode 100644 main/Google/Auth/Credentials/ServiceAccountCredentials.html create mode 100644 main/Google/Auth/GetUniverseDomainInterface.html diff --git a/main/Google/Auth.html b/main/Google/Auth.html index 7936b9200..7442fefd7 100644 --- a/main/Google/Auth.html +++ b/main/Google/Auth.html @@ -268,6 +268,15 @@

Interfaces

An interface implemented by objects that can get quota projects.
+ +
+
+ GetUniverseDomainInterface + +
+
+ An interface implemented by objects that can get universe domain for Google Cloud APIs. +
diff --git a/main/Google/Auth/Credentials.html b/main/Google/Auth/Credentials.html index 22564526c..7343b474f 100644 --- a/main/Google/Auth/Credentials.html +++ b/main/Google/Auth/Credentials.html @@ -183,16 +183,6 @@

Classes

Provides a set of credentials that will always return an empty access token.
-
-
-
- ServiceAccountCredentials - -
-
- ServiceAccountCredentials supports authorization using a Google service -account. -
diff --git a/main/Google/Auth/Credentials/AppIdentityCredentials.html b/main/Google/Auth/Credentials/AppIdentityCredentials.html index 5bff8a367..8a5f2c771 100644 --- a/main/Google/Auth/Credentials/AppIdentityCredentials.html +++ b/main/Google/Auth/Credentials/AppIdentityCredentials.html @@ -307,7 +307,7 @@

Methods

- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials + static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials
makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null) @@ -369,6 +369,17 @@

Methods

+ string +
+
+ getUniverseDomain() + +

Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain.

+
from CredentialsLoader
+
+
+
@@ -547,7 +558,7 @@

Return Value

-
in CredentialsLoader at line 76
+
in CredentialsLoader at line 77
static array|null fromEnv() @@ -579,7 +590,7 @@

Return Value

-
in CredentialsLoader at line 102
+
in CredentialsLoader at line 103
static array|null fromWellKnownFile() @@ -616,8 +627,8 @@

Return Value

-
in CredentialsLoader at line 130
- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials +
in CredentialsLoader at line 131
+ static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null)

@@ -656,7 +667,7 @@

Return Value

- +
ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentialsServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials
@@ -669,7 +680,7 @@

Return Value

-
in CredentialsLoader at line 171
+
in CredentialsLoader at line 172
static Client makeHttpClient(FetchAuthTokenInterface $fetcher, array $httpClientOptions = [], callable $httpHandler = null, callable $tokenCallback = null) @@ -724,7 +735,7 @@

Return Value

-
in CredentialsLoader at line 196
+
in CredentialsLoader at line 197
static InsecureCredentials makeInsecureCredentials() @@ -754,7 +765,7 @@

Return Value

-
in CredentialsLoader at line 208
+
in CredentialsLoader at line 209
static string|null quotaProjectFromEnv() @@ -786,7 +797,7 @@

Return Value

-
in CredentialsLoader at line 219
+
in CredentialsLoader at line 220
static callable|null getDefaultClientCertSource() @@ -825,7 +836,7 @@

Exceptions

-
in CredentialsLoader at line 244
+
in CredentialsLoader at line 245
static bool shouldLoadClientCertSource() @@ -849,6 +860,37 @@

Return Value

+
+
+ +
+
+

+
in CredentialsLoader at line 284
+ string + getUniverseDomain() + +

+
+ + + +
+

Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain.

+
+ +

Return Value

+ + + + + + +
string
+ + +
diff --git a/main/Google/Auth/Credentials/GCECredentials.html b/main/Google/Auth/Credentials/GCECredentials.html index f36fbc0a7..f4fd6b54c 100644 --- a/main/Google/Auth/Credentials/GCECredentials.html +++ b/main/Google/Auth/Credentials/GCECredentials.html @@ -383,7 +383,7 @@

Methods

- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials + static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials
makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null) @@ -442,6 +442,17 @@

Methods

Determines whether or not the default device certificate should be loaded.

from CredentialsLoader
+
+
+
+ string +
+
+ getUniverseDomain() + +

Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain.

+
from CredentialsLoader
@@ -673,7 +684,7 @@

Return Value

-
in CredentialsLoader at line 76
+
in CredentialsLoader at line 77
static array|null fromEnv() @@ -705,7 +716,7 @@

Return Value

-
in CredentialsLoader at line 102
+
in CredentialsLoader at line 103
static array|null fromWellKnownFile() @@ -742,8 +753,8 @@

Return Value

-
in CredentialsLoader at line 130
- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials +
in CredentialsLoader at line 131
+ static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null)

@@ -782,7 +793,7 @@

Return Value

- +
ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentialsServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials
@@ -795,7 +806,7 @@

Return Value

-
in CredentialsLoader at line 171
+
in CredentialsLoader at line 172
static Client makeHttpClient(FetchAuthTokenInterface $fetcher, array $httpClientOptions = [], callable $httpHandler = null, callable $tokenCallback = null) @@ -850,7 +861,7 @@

Return Value

-
in CredentialsLoader at line 196
+
in CredentialsLoader at line 197
static InsecureCredentials makeInsecureCredentials() @@ -880,7 +891,7 @@

Return Value

-
in CredentialsLoader at line 208
+
in CredentialsLoader at line 209
static string|null quotaProjectFromEnv() @@ -912,7 +923,7 @@

Return Value

-
in CredentialsLoader at line 219
+
in CredentialsLoader at line 220
static callable|null getDefaultClientCertSource() @@ -951,7 +962,7 @@

Exceptions

-
in CredentialsLoader at line 244
+
in CredentialsLoader at line 245
static bool shouldLoadClientCertSource() @@ -975,6 +986,37 @@

Return Value

+
+
+ +
+
+

+
in CredentialsLoader at line 284
+ string + getUniverseDomain() + +

+
+ + + +
+

Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain.

+
+ +

Return Value

+ + + + + + +
string
+ + +
diff --git a/main/Google/Auth/Credentials/ImpersonatedServiceAccountCredentials.html b/main/Google/Auth/Credentials/ImpersonatedServiceAccountCredentials.html index 10c992c72..f54af8af0 100644 --- a/main/Google/Auth/Credentials/ImpersonatedServiceAccountCredentials.html +++ b/main/Google/Auth/Credentials/ImpersonatedServiceAccountCredentials.html @@ -293,7 +293,7 @@

Methods

- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials + static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials
makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null) @@ -352,6 +352,17 @@

Methods

Determines whether or not the default device certificate should be loaded.

from CredentialsLoader
+
+
+
+ string +
+
+ getUniverseDomain() + +

Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain.

+
from CredentialsLoader
@@ -512,7 +523,7 @@

Return Value

-
in CredentialsLoader at line 76
+
in CredentialsLoader at line 77
static array|null fromEnv() @@ -544,7 +555,7 @@

Return Value

-
in CredentialsLoader at line 102
+
in CredentialsLoader at line 103
static array|null fromWellKnownFile() @@ -581,8 +592,8 @@

Return Value

-
in CredentialsLoader at line 130
- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials +
in CredentialsLoader at line 131
+ static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null)

@@ -621,7 +632,7 @@

Return Value

- +
ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentialsServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials
@@ -634,7 +645,7 @@

Return Value

-
in CredentialsLoader at line 171
+
in CredentialsLoader at line 172
static Client makeHttpClient(FetchAuthTokenInterface $fetcher, array $httpClientOptions = [], callable $httpHandler = null, callable $tokenCallback = null) @@ -689,7 +700,7 @@

Return Value

-
in CredentialsLoader at line 196
+
in CredentialsLoader at line 197
static InsecureCredentials makeInsecureCredentials() @@ -719,7 +730,7 @@

Return Value

-
in CredentialsLoader at line 208
+
in CredentialsLoader at line 209
static string|null quotaProjectFromEnv() @@ -751,7 +762,7 @@

Return Value

-
in CredentialsLoader at line 219
+
in CredentialsLoader at line 220
static callable|null getDefaultClientCertSource() @@ -790,7 +801,7 @@

Exceptions

-
in CredentialsLoader at line 244
+
in CredentialsLoader at line 245
static bool shouldLoadClientCertSource() @@ -814,6 +825,37 @@

Return Value

+
+
+ +
+
+

+
in CredentialsLoader at line 284
+ string + getUniverseDomain() + +

+
+ + + +
+

Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain.

+
+ +

Return Value

+ + + + + + +
string
+ + +
diff --git a/main/Google/Auth/Credentials/ServiceAccountCredentials.html b/main/Google/Auth/Credentials/ServiceAccountCredentials.html deleted file mode 100644 index 24132cccc..000000000 --- a/main/Google/Auth/Credentials/ServiceAccountCredentials.html +++ /dev/null @@ -1,1295 +0,0 @@ - - - - - - Google\Auth\Credentials\ServiceAccountCredentials | Google Auth Library for PHP API Reference - - - - - - - - - - - - - - - - -
-
-
-
- -
- -
- - -
-
- -
- -
-
- - -
-
    -
  1. class
    2. -
  2. Google
  3. \
  4. Auth
  5. \
  6. Credentials
  7. \
  8. ServiceAccountCredentials
    9. -
-
-
- -
-

- ServiceAccountCredentials - -

-
- -

class - ServiceAccountCredentials extends CredentialsLoader implements - GetQuotaProjectInterface, SignBlobInterface, ProjectIdProviderInterface (View source) -

- - - - -
-

ServiceAccountCredentials supports authorization using a Google service -account.

(cf https://developers.google.com/accounts/docs/OAuth2ServiceAccount)

- -

It's initialized using the json key file that's downloadable from developer -console, which should contain a private_key and client_email fields that it -uses.

- -

Use it with AuthTokenMiddleware to authorize http requests:

- -

use Google\Auth\Credentials\ServiceAccountCredentials; - use Google\Auth\Middleware\AuthTokenMiddleware; - use GuzzleHttp\Client; - use GuzzleHttp\HandlerStack;

- -

$sa = new ServiceAccountCredentials( - 'https://www.googleapis.com/auth/taskqueue', - '/path/to/your/json/key_file.json' - ); - $middleware = new AuthTokenMiddleware($sa); - $stack = HandlerStack::create(); - $stack->push($middleware);

- -

$client = new Client([ - 'handler' => $stack, - 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/', - 'auth' => 'google_auth' // authorize all requests - ]);

- -

$res = $client->get('myproject/taskqueues/myqueue');

- -

Traits

- - -
-
-
- ServiceAccountSignerTrait - -
-
- Sign a string using a Service Account private key. -
-
-
-
- UpdateMetadataTrait - -
-
- Provides shared methods for updating request metadata (request headers). -
-
-
- -

Constants

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
TOKEN_CREDENTIAL_URI -

-

-
ENV_VAR -

-

-
QUOTA_PROJECT_ENV_VAR -

-

-
WELL_KNOWN_PATH -

-

-
NON_WINDOWS_WELL_KNOWN_PATH_BASE -

-

-
MTLS_WELL_KNOWN_PATH -

-

-
MTLS_CERT_ENV_VAR -

-

-
- - -

Properties

- - - - - - - - - - - - - - - - - - - - -
- protected OAuth2 - $authThe OAuth2 instance used to conduct authorization.
- protected string - $quotaProjectThe quota project associated with the JSON credentials
- protected string|null - $projectId
- - -

Methods

- -
-
-
- callable -
-
- getUpdateMetadataFunc() - deprecated -

export a callback function which updates runtime metadata.

-
from UpdateMetadataTrait
-
-
-
- array -
-
- updateMetadata(array $metadata, string $authUri = null, callable $httpHandler = null) - -

Updates metadata with the authorization token.

-
-
-
-
- static array|null -
-
- fromEnv() - -

Load a JSON key from the path specified in the environment.

-
from CredentialsLoader
-
-
-
- static array|null -
-
- fromWellKnownFile() - -

Load a JSON key from a well known path.

-
from CredentialsLoader
-
-
-
- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials -
-
- makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null) - -

Create a new Credentials instance.

-
from CredentialsLoader
-
-
-
- static Client -
-
- makeHttpClient(FetchAuthTokenInterface $fetcher, array $httpClientOptions = [], callable $httpHandler = null, callable $tokenCallback = null) - -

Create an authorized HTTP Client from an instance of FetchAuthTokenInterface.

-
from CredentialsLoader
-
-
-
- static InsecureCredentials -
-
- makeInsecureCredentials() - -

Create a new instance of InsecureCredentials.

-
from CredentialsLoader
-
-
-
- static string|null -
-
- quotaProjectFromEnv() - -

Fetch a quota project from the environment variable -GOOGLE_CLOUD_QUOTA_PROJECT. Return null if -GOOGLE_CLOUD_QUOTA_PROJECT is not specified.

-
from CredentialsLoader
-
-
-
- static callable|null -
-
- getDefaultClientCertSource() - -

Gets a callable which returns the default device certification.

-
from CredentialsLoader
-
-
-
- static bool -
-
- shouldLoadClientCertSource() - -

Determines whether or not the default device certificate should be loaded.

-
from CredentialsLoader
-
-
-
- string -
-
- signBlob(string $stringToSign, bool $forceOpenssl = false) - -

Sign a string using the service account private key.

-
from ServiceAccountSignerTrait
-
-
-
- -
-
- __construct(string|string[]|null $scope, string|array $jsonKey, string $sub = null, string $targetAudience = null) - -

Create a new ServiceAccountCredentials.

-
-
-
-
- void -
-
- useJwtAccessWithScope() - -

When called, the ServiceAccountCredentials will use an instance of -ServiceAccountJwtAccessCredentials to fetch (self-sign) an access token -even when only scopes are supplied. Otherwise, -ServiceAccountJwtAccessCredentials is only called when no scopes and an -authUrl (audience) is suppled.

-
-
-
-
- array -
-
- fetchAuthToken(callable $httpHandler = null) - -

No description

-
-
-
-
-
- string -
-
- getCacheKey() - -

No description

-
-
-
-
-
- null|array -
-
- getLastReceivedToken() - -

No description

-
-
-
-
-
- string|null -
-
- getProjectId(callable $httpHandler = null) - -

Get the project ID from the service account keyfile.

-
-
-
-
- void -
-
- setSub(string $sub) - -

No description

-
-
-
-
-
- string -
-
- getClientName(callable $httpHandler = null) - -

Get the client name from the keyfile.

-
-
-
-
- string|null -
-
- getQuotaProject() - -

Get the quota project used for this API request

-
-
-
- - -

Details

- -
-
-

-
in UpdateMetadataTrait at line 35
- callable - getUpdateMetadataFunc() - deprecated -

-
- -

- deprecated - - - - -

- - -
-

export a callback function which updates runtime metadata.

-
- -

Return Value

- - - - - - -
callableupdateMetadata function
- - - -
-
- -
-
-

-
at line 252
- array - updateMetadata(array $metadata, string $authUri = null, callable $httpHandler = null) - -

-
- - - -
-

Updates metadata with the authorization token.

-
-

Parameters

- - - - - - - - - - - - - - - - - -
array$metadatametadata hashmap
string$authUrioptional auth uri
callable$httpHandlercallback which delivers psr7 request
- - -

Return Value

- - - - - - -
arrayupdated metadata hashmap
- - - -
-
- -
-
-

-
in CredentialsLoader at line 76
- static array|null - fromEnv() - -

-
- - - -
-

Load a JSON key from the path specified in the environment.

Load a JSON key from the path specified in the environment -variable GOOGLE_APPLICATION_CREDENTIALS. Return null if -GOOGLE_APPLICATION_CREDENTIALS is not specified.

-
- -

Return Value

- - - - - - -
array|nullJSON key | null
- - - -
-
- -
-
-

-
in CredentialsLoader at line 102
- static array|null - fromWellKnownFile() - -

-
- - - -
-

Load a JSON key from a well known path.

The well known path is OS dependent:

- -
    -
  • windows: %APPDATA%/gcloud/application_default_credentials.json
    • -
  • others: $HOME/.config/gcloud/application_default_credentials.json
    • -
- -

If the file does not exist, this returns null.

-
- -

Return Value

- - - - - - -
array|nullJSON key | null
- - - -
-
- -
-
-

-
in CredentialsLoader at line 130
- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials - makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null) - -

-
- - - -
-

Create a new Credentials instance.

-
-

Parameters

- - - - - - - - - - - - - - - - - -
string|string[]$scopethe scope of the access request, expressed - either as an Array or as a space-delimited String.
array$jsonKeythe JSON credentials.
string|string[]$defaultScopeThe default scope to use if no - user-defined scopes exist, expressed either as an Array or as a - space-delimited string.
- - -

Return Value

- - - - - - -
ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials
- - - -
-
- -
-
-

-
in CredentialsLoader at line 171
- static Client - makeHttpClient(FetchAuthTokenInterface $fetcher, array $httpClientOptions = [], callable $httpHandler = null, callable $tokenCallback = null) - -

-
- - - -
-

Create an authorized HTTP Client from an instance of FetchAuthTokenInterface.

-
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - -
FetchAuthTokenInterface$fetcheris used to fetch the auth token
array$httpClientOptions(optional) Array of request options to apply.
callable$httpHandler(optional) http client to fetch the token.
callable$tokenCallback(optional) function to be called when a new token is fetched.
- - -

Return Value

- - - - - - -
Client
- - - -
-
- -
-
-

-
in CredentialsLoader at line 196
- static InsecureCredentials - makeInsecureCredentials() - -

-
- - - -
-

Create a new instance of InsecureCredentials.

-
- -

Return Value

- - - - - - -
InsecureCredentials
- - - -
-
- -
-
-

-
in CredentialsLoader at line 208
- static string|null - quotaProjectFromEnv() - -

-
- - - -
-

Fetch a quota project from the environment variable -GOOGLE_CLOUD_QUOTA_PROJECT. Return null if -GOOGLE_CLOUD_QUOTA_PROJECT is not specified.

-
- -

Return Value

- - - - - - -
string|null
- - - -
-
- -
-
-

-
in CredentialsLoader at line 219
- static callable|null - getDefaultClientCertSource() - -

-
- - - -
-

Gets a callable which returns the default device certification.

-
- -

Return Value

- - - - - - -
callable|null
- - -

Exceptions

- - - - - - -
UnexpectedValueException
- - -
-
- -
-
-

-
in CredentialsLoader at line 244
- static bool - shouldLoadClientCertSource() - -

-
- - - -
-

Determines whether or not the default device certificate should be loaded.

-
- -

Return Value

- - - - - - -
bool
- - - -
-
- -
-
-

-
in ServiceAccountSignerTrait at line 35
- string - signBlob(string $stringToSign, bool $forceOpenssl = false) - -

-
- - - -
-

Sign a string using the service account private key.

-
-

Parameters

- - - - - - - - - - - - -
string$stringToSign
bool$forceOpensslWhether to use OpenSSL regardless of - whether phpseclib is installed. Defaults to false.
- - -

Return Value

- - - - - - -
string
- - - -
-
- -
-
-

-
at line 113
- - __construct(string|string[]|null $scope, string|array $jsonKey, string $sub = null, string $targetAudience = null) - -

-
- - - -
-

Create a new ServiceAccountCredentials.

-
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - -
string|string[]|null$scopethe scope of the access request, expressed - either as an Array or as a space-delimited String.
string|array$jsonKeyJSON credential file path or JSON credentials - as an associative array
string$suban email address account to impersonate, in situations when - the service account has been delegated domain wide access.
string$targetAudienceThe audience for the ID token.
- - - - -
-
- -
-
-

-
at line 173
- void - useJwtAccessWithScope() - -

-
- - - -
-

When called, the ServiceAccountCredentials will use an instance of -ServiceAccountJwtAccessCredentials to fetch (self-sign) an access token -even when only scopes are supplied. Otherwise, -ServiceAccountJwtAccessCredentials is only called when no scopes and an -authUrl (audience) is suppled.

-
- -

Return Value

- - - - - - -
void
- - - -
-
- -
-
-

-
at line 189
- array - fetchAuthToken(callable $httpHandler = null) - -

-
- - - -
-

Parameters

- - - - - - - -
callable$httpHandlercallback which delivers psr7 request
- - -

Return Value

- - - - - - -
arraya hash of auth tokens
- - - -
-
- -
-
-

-
at line 209
- string - getCacheKey() - -

-
- - - -
- -

Return Value

- - - - - - -
stringa key that may be used to cache the auth token.
- - - -
-
- -
-
-

-
at line 222
- null|array - getLastReceivedToken() - -

-
- - - -
- -

Return Value

- - - - - - -
null|array{ - The last received access token.

- -
@type string $access_token The access token string.
-@type int $expires_at The time the token expires as a UNIX timestamp.
-
- -

}

- - - -
-
- -
-
-

-
at line 239
- string|null - getProjectId(callable $httpHandler = null) - -

-
- - - -
-

Get the project ID from the service account keyfile.

Returns null if the project ID does not exist in the keyfile.

-
-

Parameters

- - - - - - - -
callable$httpHandlerCallback which delivers psr7 request
- - -

Return Value

- - - - - - -
string|null
- - - -
-
- -
-
-

-
at line 303
- void - setSub(string $sub) - -

-
- - - -
-

Parameters

- - - - - - - -
string$suban email address account to impersonate, in situations when - the service account has been delegated domain wide access.
- - -

Return Value

- - - - - - -
void
- - - -
-
- -
-
-

-
at line 316
- string - getClientName(callable $httpHandler = null) - -

-
- - - -
-

Get the client name from the keyfile.

In this case, it returns the keyfile's client_email key.

-
-

Parameters

- - - - - - - -
callable$httpHandlercallback which delivers psr7 request, if - one is required to obtain a client name.
- - -

Return Value

- - - - - - -
string
- - - -
-
- -
-
-

-
at line 326
- string|null - getQuotaProject() - -

-
- - - -
-

Get the quota project used for this API request

-
- -

Return Value

- - - - - - -
string|null
- - - -
-
- -
-
- - -
- - -
-
- - - diff --git a/main/Google/Auth/Credentials/ServiceAccountJwtAccessCredentials.html b/main/Google/Auth/Credentials/ServiceAccountJwtAccessCredentials.html index 5243eb541..d2fcf5e7e 100644 --- a/main/Google/Auth/Credentials/ServiceAccountJwtAccessCredentials.html +++ b/main/Google/Auth/Credentials/ServiceAccountJwtAccessCredentials.html @@ -307,7 +307,7 @@

Methods

- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials + static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials
makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null) @@ -366,6 +366,17 @@

Methods

Determines whether or not the default device certificate should be loaded.

from CredentialsLoader
+
+
+
+ string +
+
+ getUniverseDomain() + +

Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain.

+
from CredentialsLoader
@@ -544,7 +555,7 @@

Return Value

-
in CredentialsLoader at line 76
+
in CredentialsLoader at line 77
static array|null fromEnv() @@ -576,7 +587,7 @@

Return Value

-
in CredentialsLoader at line 102
+
in CredentialsLoader at line 103
static array|null fromWellKnownFile() @@ -613,8 +624,8 @@

Return Value

-
in CredentialsLoader at line 130
- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials +
in CredentialsLoader at line 131
+ static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null)

@@ -653,7 +664,7 @@

Return Value

- +
ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentialsServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials
@@ -666,7 +677,7 @@

Return Value

-
in CredentialsLoader at line 171
+
in CredentialsLoader at line 172
static Client makeHttpClient(FetchAuthTokenInterface $fetcher, array $httpClientOptions = [], callable $httpHandler = null, callable $tokenCallback = null) @@ -721,7 +732,7 @@

Return Value

-
in CredentialsLoader at line 196
+
in CredentialsLoader at line 197
static InsecureCredentials makeInsecureCredentials() @@ -751,7 +762,7 @@

Return Value

-
in CredentialsLoader at line 208
+
in CredentialsLoader at line 209
static string|null quotaProjectFromEnv() @@ -783,7 +794,7 @@

Return Value

-
in CredentialsLoader at line 219
+
in CredentialsLoader at line 220
static callable|null getDefaultClientCertSource() @@ -822,7 +833,7 @@

Exceptions

-
in CredentialsLoader at line 244
+
in CredentialsLoader at line 245
static bool shouldLoadClientCertSource() @@ -846,6 +857,37 @@

Return Value

+
+
+ + +
+

+
in CredentialsLoader at line 284
+ string + getUniverseDomain() + +

+
+ + + +
+

Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain.

+
+ +

Return Value

+ + + + + + +
string
+ + +
diff --git a/main/Google/Auth/Credentials/UserRefreshCredentials.html b/main/Google/Auth/Credentials/UserRefreshCredentials.html index 8455e2baf..a36144baf 100644 --- a/main/Google/Auth/Credentials/UserRefreshCredentials.html +++ b/main/Google/Auth/Credentials/UserRefreshCredentials.html @@ -290,7 +290,7 @@

Methods

- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials + static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials
makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null) @@ -352,6 +352,17 @@

Methods

+ string +
+
+ getUniverseDomain() + +

Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain.

+
from CredentialsLoader
+
+
+
@@ -508,7 +519,7 @@

Return Value

-
in CredentialsLoader at line 76
+
in CredentialsLoader at line 77
static array|null fromEnv() @@ -540,7 +551,7 @@

Return Value

-
in CredentialsLoader at line 102
+
in CredentialsLoader at line 103
static array|null fromWellKnownFile() @@ -577,8 +588,8 @@

Return Value

-
in CredentialsLoader at line 130
- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials +
in CredentialsLoader at line 131
+ static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null)

@@ -617,7 +628,7 @@

Return Value

- +
ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentialsServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials
@@ -630,7 +641,7 @@

Return Value

-
in CredentialsLoader at line 171
+
in CredentialsLoader at line 172
static Client makeHttpClient(FetchAuthTokenInterface $fetcher, array $httpClientOptions = [], callable $httpHandler = null, callable $tokenCallback = null) @@ -685,7 +696,7 @@

Return Value

-
in CredentialsLoader at line 196
+
in CredentialsLoader at line 197
static InsecureCredentials makeInsecureCredentials() @@ -715,7 +726,7 @@

Return Value

-
in CredentialsLoader at line 208
+
in CredentialsLoader at line 209
static string|null quotaProjectFromEnv() @@ -747,7 +758,7 @@

Return Value

-
in CredentialsLoader at line 219
+
in CredentialsLoader at line 220
static callable|null getDefaultClientCertSource() @@ -786,7 +797,7 @@

Exceptions

-
in CredentialsLoader at line 244
+
in CredentialsLoader at line 245
static bool shouldLoadClientCertSource() @@ -810,6 +821,37 @@

Return Value

+
+
+ +
+
+

+
in CredentialsLoader at line 284
+ string + getUniverseDomain() + +

+
+ + + +
+

Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain.

+
+ +

Return Value

+ + + + + + +
string
+ + +
diff --git a/main/Google/Auth/CredentialsLoader.html b/main/Google/Auth/CredentialsLoader.html index 4a8e316ce..ab1195102 100644 --- a/main/Google/Auth/CredentialsLoader.html +++ b/main/Google/Auth/CredentialsLoader.html @@ -140,7 +140,7 @@

abstract class CredentialsLoader implements - FetchAuthTokenInterface, UpdateMetadataInterface (View source) + GetUniverseDomainInterface, FetchAuthTokenInterface, UpdateMetadataInterface (View source)

@@ -266,7 +266,7 @@

Methods

- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials + static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials
makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null) @@ -325,6 +325,17 @@

Methods

Determines whether or not the default device certificate should be loaded.

+
+
+
+ string +
+
+ getUniverseDomain() + +

Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain.

+
@@ -421,7 +432,7 @@

Return Value

-
at line 76
+
at line 77
static array|null fromEnv() @@ -453,7 +464,7 @@

Return Value

-
at line 102
+
at line 103
static array|null fromWellKnownFile() @@ -490,8 +501,8 @@

Return Value

-
at line 130
- static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials +
at line 131
+ static ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials makeCredentials(string|string[] $scope, array $jsonKey, string|string[] $defaultScope = null)

@@ -530,7 +541,7 @@

Return Value

- +
ServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentialsServiceAccountCredentials|UserRefreshCredentials|ImpersonatedServiceAccountCredentials|ExternalAccountCredentials
@@ -543,7 +554,7 @@

Return Value

-
at line 171
+
at line 172
static Client makeHttpClient(FetchAuthTokenInterface $fetcher, array $httpClientOptions = [], callable $httpHandler = null, callable $tokenCallback = null) @@ -598,7 +609,7 @@

Return Value

-
at line 196
+
at line 197
static InsecureCredentials makeInsecureCredentials() @@ -628,7 +639,7 @@

Return Value

-
at line 208
+
at line 209
static string|null quotaProjectFromEnv() @@ -660,7 +671,7 @@

Return Value

-
at line 219
+
at line 220
static callable|null getDefaultClientCertSource() @@ -699,7 +710,7 @@

Exceptions

-
at line 244
+
at line 245
static bool shouldLoadClientCertSource() @@ -723,6 +734,37 @@

Return Value

+
+ + + +
+

+
at line 284
+ string + getUniverseDomain() + +

+
+ + + +
+

Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain.

+
+ +

Return Value

+ + + + + + +
string
+ + +
diff --git a/main/Google/Auth/FetchAuthTokenCache.html b/main/Google/Auth/FetchAuthTokenCache.html index 928e64623..827df36f9 100644 --- a/main/Google/Auth/FetchAuthTokenCache.html +++ b/main/Google/Auth/FetchAuthTokenCache.html @@ -140,7 +140,7 @@

class FetchAuthTokenCache implements - FetchAuthTokenInterface, GetQuotaProjectInterface, SignBlobInterface, ProjectIdProviderInterface, UpdateMetadataInterface (View source) + FetchAuthTokenInterface, GetQuotaProjectInterface, GetUniverseDomainInterface, SignBlobInterface, ProjectIdProviderInterface, UpdateMetadataInterface (View source)

@@ -264,6 +264,18 @@

Methods

Get the project ID.

+ +
+
+ string +
+
+ getUniverseDomain() + +

Get the universe domain from the credential. This should always return +a string, and default to "googleapis.com" if no universe domain is +configured.

+
@@ -283,7 +295,7 @@

Details

-
at line 50
+
at line 51
__construct(FetchAuthTokenInterface $fetcher, array $cacheConfig = null, CacheItemPoolInterface $cache) @@ -322,7 +334,7 @@

Parameters

-
at line 66
+
at line 67
FetchAuthTokenInterface getFetcher() @@ -350,7 +362,7 @@

Return Value

-
at line 81
+
at line 82
array fetchAuthToken(callable $httpHandler = null) @@ -400,7 +412,7 @@

Exceptions

-
at line 97
+
at line 98
string getCacheKey() @@ -428,7 +440,7 @@

Return Value

-
at line 105
+
at line 106
null|array getLastReceivedToken() @@ -463,7 +475,7 @@

Return Value

-
at line 116
+
at line 117
string getClientName(callable $httpHandler = null) @@ -504,7 +516,7 @@

Return Value

-
at line 139
+
at line 140
string signBlob(string $stringToSign, bool $forceOpenSsl = false) @@ -561,7 +573,7 @@

Exceptions

-
at line 165
+
at line 166
string|null getQuotaProject() @@ -592,7 +604,7 @@

Return Value

-
at line 182
+
at line 183
string|null getProjectId(callable $httpHandler = null) @@ -626,13 +638,45 @@

Return Value

+
+
+ +
+
+

+
at line 200
+ string + getUniverseDomain() + +

+
+ + + +
+

Get the universe domain from the credential. This should always return +a string, and default to "googleapis.com" if no universe domain is +configured.

+
+ +

Return Value

+ + + + + + +
string
+ + +

-
at line 204
+
at line 219
array updateMetadata(array $metadata, string $authUri = null, callable $httpHandler = null) diff --git a/main/Google/Auth/GetUniverseDomainInterface.html b/main/Google/Auth/GetUniverseDomainInterface.html new file mode 100644 index 000000000..1d6a34058 --- /dev/null +++ b/main/Google/Auth/GetUniverseDomainInterface.html @@ -0,0 +1,231 @@ + + + + + + Google\Auth\GetUniverseDomainInterface | Google Auth Library for PHP API Reference + + + + + + + + + + + + + + + + +
+
+
+
+ +
+ +
+ + +
+
+ +
+ +
+
+ + +
+
    +
  1. interface
    2. +
  2. Google
  3. \
  4. Auth
  5. \
  6. GetUniverseDomainInterface
    7. +
+
+
+ +
+

+ GetUniverseDomainInterface + +

+
+ +

interface + GetUniverseDomainInterface (View source) +

+ + + + +
+

An interface implemented by objects that can get universe domain for Google Cloud APIs.

+ + +

Constants

+ + + + + + +
DEFAULT_UNIVERSE_DOMAIN +

+

+
+ + + +

Methods

+ +
+
+
+ string +
+
+ getUniverseDomain() + +

Get the universe domain from the credential. This should always return +a string, and default to "googleapis.com" if no universe domain is +configured.

+
+
+
+ + +

Details

+ +
+
+

+
at line 34
+ string + getUniverseDomain() + +

+
+ + + +
+

Get the universe domain from the credential. This should always return +a string, and default to "googleapis.com" if no universe domain is +configured.

+
+ +

Return Value

+ + + + + + +
string
+ + + +
+
+ +
+
+ + +
+ + +
+
+ + + diff --git a/main/classes.html b/main/classes.html index cd24fe3df..1a469ab9a 100644 --- a/main/classes.html +++ b/main/classes.html @@ -248,16 +248,6 @@

Classes

Provides a set of credentials that will always return an empty access token.
-
-
-
- ServiceAccountCredentials - -
-
- ServiceAccountCredentials supports authorization using a Google service -account. -
@@ -325,6 +315,15 @@

Classes

An interface implemented by objects that can get quota projects.
+
+
+
+ GetUniverseDomainInterface + +
+
+ An interface implemented by objects that can get universe domain for Google Cloud APIs. +
diff --git a/main/doc-index.html b/main/doc-index.html index 08a9a2a08..e0bb316df 100644 --- a/main/doc-index.html +++ b/main/doc-index.html @@ -163,8 +163,7 @@

A

Wrapper around Google Access Tokens which provides convenience functions.
ApplicationDefaultCredentials — Class in namespace Google\Auth
ApplicationDefaultCredentials obtains the default credentials for authorizing a request to a Google service.
AppIdentityCredentials — Class in namespace Google\Auth\Credentials
-
$ServiceAccountCredentials#auth — Property in class ServiceAccountCredentials
-
The OAuth2 instance used to conduct authorization.
$ServiceAccountJwtAccessCredentials#auth — Property in class ServiceAccountJwtAccessCredentials
+
$ServiceAccountJwtAccessCredentials#auth — Property in class ServiceAccountJwtAccessCredentials
The OAuth2 instance used to conduct authorization.
$UserRefreshCredentials#auth — Property in class UserRefreshCredentials
The OAuth2 instance used to conduct authorization.
Guzzle6HttpHandler::async() — Method in class Guzzle6HttpHandler
Accepts a PSR-7 request and an array of options and returns a PromiseInterface
AuthTokenMiddleware — Class in namespace Google\Auth\Middleware
@@ -198,8 +197,7 @@

A

Implements FetchAuthTokenInterface#fetchAuthToken.
GCECredentials::fetchAuthToken() — Method in class GCECredentials
Implements FetchAuthTokenInterface#fetchAuthToken.
ImpersonatedServiceAccountCredentials::fetchAuthToken() — Method in class ImpersonatedServiceAccountCredentials
InsecureCredentials::fetchAuthToken() — Method in class InsecureCredentials
-
Fetches the auth token. In this case it returns an empty string.
ServiceAccountCredentials::fetchAuthToken() — Method in class ServiceAccountCredentials
-
ServiceAccountJwtAccessCredentials::fetchAuthToken() — Method in class ServiceAccountJwtAccessCredentials
+
Fetches the auth token. In this case it returns an empty string.
ServiceAccountJwtAccessCredentials::fetchAuthToken() — Method in class ServiceAccountJwtAccessCredentials
Implements FetchAuthTokenInterface#fetchAuthToken.
UserRefreshCredentials::fetchAuthToken() — Method in class UserRefreshCredentials
ExternalAccountCredentialSourceInterface::fetchSubjectToken() — Method in class ExternalAccountCredentialSourceInterface
FetchAuthTokenCache — Class in namespace Google\Auth
@@ -229,7 +227,9 @@

A

Returns a traversable set of cache items.
SysVCacheItemPool::getItem() — Method in class SysVCacheItemPool
SysVCacheItemPool::getItems() — Method in class SysVCacheItemPool
CredentialsLoader::getDefaultClientCertSource() — Method in class CredentialsLoader
-
Gets a callable which returns the default device certification.
AppIdentityCredentials::getProjectId() — Method in class AppIdentityCredentials
+
Gets a callable which returns the default device certification.
CredentialsLoader::getUniverseDomain() — Method in class CredentialsLoader
+
Get the universe domain from the credential. Defaults to "googleapis.com" +for all credential types which do not support universe domain.
AppIdentityCredentials::getProjectId() — Method in class AppIdentityCredentials
Get the project ID from AppIdentityService.
AppIdentityCredentials::getClientName() — Method in class AppIdentityCredentials
Get the client name from AppIdentityService.
AppIdentityCredentials::getLastReceivedToken() — Method in class AppIdentityCredentials
AppIdentityCredentials::getCacheKey() — Method in class AppIdentityCredentials
@@ -250,12 +250,7 @@

A

Returns the cache key. In this case it returns a null value, disabling caching.
InsecureCredentials::getLastReceivedToken() — Method in class InsecureCredentials
Fetches the last received token. In this case, it returns the same empty string -auth token.
ServiceAccountCredentials::getCacheKey() — Method in class ServiceAccountCredentials
-
ServiceAccountCredentials::getLastReceivedToken() — Method in class ServiceAccountCredentials
-
ServiceAccountCredentials::getProjectId() — Method in class ServiceAccountCredentials
-
Get the project ID from the service account keyfile.
ServiceAccountCredentials::getClientName() — Method in class ServiceAccountCredentials
-
Get the client name from the keyfile.
ServiceAccountCredentials::getQuotaProject() — Method in class ServiceAccountCredentials
-
Get the quota project used for this API request
ServiceAccountJwtAccessCredentials::getCacheKey() — Method in class ServiceAccountJwtAccessCredentials
+auth token.
ServiceAccountJwtAccessCredentials::getCacheKey() — Method in class ServiceAccountJwtAccessCredentials
ServiceAccountJwtAccessCredentials::getLastReceivedToken() — Method in class ServiceAccountJwtAccessCredentials
ServiceAccountJwtAccessCredentials::getProjectId() — Method in class ServiceAccountJwtAccessCredentials
Get the project ID from the service account keyfile.
ServiceAccountJwtAccessCredentials::getClientName() — Method in class ServiceAccountJwtAccessCredentials
@@ -271,7 +266,10 @@

A

Get the client name from the fetcher.
FetchAuthTokenCache::getQuotaProject() — Method in class FetchAuthTokenCache
Get the quota project used for this API request from the credentials fetcher.
FetchAuthTokenCache::getProjectId() — Method in class FetchAuthTokenCache
-
Get the project ID.
FetchAuthTokenInterface::getCacheKey() — Method in class FetchAuthTokenInterface
+
Get the project ID.
FetchAuthTokenCache::getUniverseDomain() — Method in class FetchAuthTokenCache
+
Get the universe domain from the credential. This should always return +a string, and default to "googleapis.com" if no universe domain is +configured.
FetchAuthTokenInterface::getCacheKey() — Method in class FetchAuthTokenInterface
Obtains a key that can used to cache the results of #fetchAuthToken.
FetchAuthTokenInterface::getLastReceivedToken() — Method in class FetchAuthTokenInterface
Returns an associative array with the token and expiration time.
GCECache — Class in namespace Google\Auth
@@ -279,7 +277,11 @@

A

is used automatically when you pass a Psr\Cache\CacheItemPoolInterface cache object to ApplicationDefaultCredentials::getCredentials.
GetQuotaProjectInterface — Class in namespace Google\Auth
An interface implemented by objects that can get quota projects.
GetQuotaProjectInterface::getQuotaProject() — Method in class GetQuotaProjectInterface
-
Get the quota project used for this API request
Guzzle6HttpHandler — Class in namespace Google\Auth\HttpHandler
+
Get the quota project used for this API request
GetUniverseDomainInterface — Class in namespace Google\Auth
+
An interface implemented by objects that can get universe domain for Google Cloud APIs.
GetUniverseDomainInterface::getUniverseDomain() — Method in class GetUniverseDomainInterface
+
Get the universe domain from the credential. This should always return +a string, and default to "googleapis.com" if no universe domain is +configured.
Guzzle6HttpHandler — Class in namespace Google\Auth\HttpHandler
Guzzle7HttpHandler — Class in namespace Google\Auth\HttpHandler
HttpClientCache::getHttpClient() — Method in class HttpClientCache
Get the stored HTTP Client, or null.
ProjectIdProviderInterface::getProjectId() — Method in class ProjectIdProviderInterface
@@ -319,8 +321,7 @@

A

host.
GCECache::onGce() — Method in class GCECache
Caches the result of onGce so the metadata server is not called multiple times.

P

-
$ServiceAccountCredentials#projectId — Property in class ServiceAccountCredentials
-
$ServiceAccountJwtAccessCredentials#projectId — Property in class ServiceAccountJwtAccessCredentials
+
$ServiceAccountJwtAccessCredentials#projectId — Property in class ServiceAccountJwtAccessCredentials
ProxyAuthTokenMiddleware — Class in namespace Google\Auth\Middleware
ProxyAuthTokenMiddleware is a Guzzle Middleware that adds an Authorization header provided by an object implementing FetchAuthTokenInterface.
ProjectIdProviderInterface — Class in namespace Google\Auth
@@ -328,8 +329,7 @@

A

CredentialsLoader::quotaProjectFromEnv() — Method in class CredentialsLoader
Fetch a quota project from the environment variable GOOGLE_CLOUD_QUOTA_PROJECT. Return null if -GOOGLE_CLOUD_QUOTA_PROJECT is not specified.
$ServiceAccountCredentials#quotaProject — Property in class ServiceAccountCredentials
-
The quota project associated with the JSON credentials
$ServiceAccountJwtAccessCredentials#quotaProject — Property in class ServiceAccountJwtAccessCredentials
+GOOGLE_CLOUD_QUOTA_PROJECT is not specified.
$ServiceAccountJwtAccessCredentials#quotaProject — Property in class ServiceAccountJwtAccessCredentials
The quota project associated with the JSON credentials
$UserRefreshCredentials#quotaProject — Property in class UserRefreshCredentials
The quota project associated with the JSON credentials

R

AccessToken::revoke() — Method in class AccessToken
@@ -345,9 +345,6 @@

A

Determines whether or not the default device certificate should be loaded.
AppIdentityCredentials::signBlob() — Method in class AppIdentityCredentials
Sign a string using AppIdentityService.
GCECredentials::setIsOnGce() — Method in class GCECredentials
Set whether or not we've already checked the GCE environment.
$ImpersonatedServiceAccountCredentials#sourceCredentials — Property in class ImpersonatedServiceAccountCredentials
-
ServiceAccountCredentials — Class in namespace Google\Auth\Credentials
-
ServiceAccountCredentials supports authorization using a Google service -account.
ServiceAccountCredentials::setSub() — Method in class ServiceAccountCredentials
ServiceAccountJwtAccessCredentials — Class in namespace Google\Auth\Credentials
Authenticates requests using Google's Service Account credentials via JWT Access.
FetchAuthTokenCache::signBlob() — Method in class FetchAuthTokenCache
@@ -364,13 +361,7 @@

A

Describes a class which supports signing arbitrary strings.
SignBlobInterface::signBlob() — Method in class SignBlobInterface
Sign a string using the method which is best for a given credentials type.

U

IAMCredentials::updateMetadata() — Method in class IAMCredentials
-
Updates metadata with the appropriate header metadata.
ServiceAccountCredentials::useJwtAccessWithScope() — Method in class ServiceAccountCredentials
-
When called, the ServiceAccountCredentials will use an instance of -ServiceAccountJwtAccessCredentials to fetch (self-sign) an access token -even when only scopes are supplied. Otherwise, -ServiceAccountJwtAccessCredentials is only called when no scopes and an -authUrl (audience) is suppled.
ServiceAccountCredentials::updateMetadata() — Method in class ServiceAccountCredentials
-
Updates metadata with the authorization token.
ServiceAccountJwtAccessCredentials::updateMetadata() — Method in class ServiceAccountJwtAccessCredentials
+
Updates metadata with the appropriate header metadata.
ServiceAccountJwtAccessCredentials::updateMetadata() — Method in class ServiceAccountJwtAccessCredentials
Updates metadata with the authorization token.
UserRefreshCredentials — Class in namespace Google\Auth\Credentials
Authenticates requests using User Refresh credentials.
FetchAuthTokenCache::updateMetadata() — Method in class FetchAuthTokenCache
Updates metadata with the authorization token.
UpdateMetadataInterface — Class in namespace Google\Auth
@@ -389,8 +380,7 @@

A

IAMCredentials::__construct() — Method in class IAMCredentials
ImpersonatedServiceAccountCredentials::__construct() — Method in class ImpersonatedServiceAccountCredentials
Instantiate an instance of ImpersonatedServiceAccountCredentials from a credentials file that -has be created with the --impersonated-service-account flag.
ServiceAccountCredentials::__construct() — Method in class ServiceAccountCredentials
-
Create a new ServiceAccountCredentials.
ServiceAccountJwtAccessCredentials::__construct() — Method in class ServiceAccountJwtAccessCredentials
+has be created with the --impersonated-service-account flag.
ServiceAccountJwtAccessCredentials::__construct() — Method in class ServiceAccountJwtAccessCredentials
Create a new ServiceAccountJwtAccessCredentials.
UserRefreshCredentials::__construct() — Method in class UserRefreshCredentials
Create a new UserRefreshCredentials.
FetchAuthTokenCache::__construct() — Method in class FetchAuthTokenCache
GCECache::__construct() — Method in class GCECache
diff --git a/main/interfaces.html b/main/interfaces.html index 54c5e2409..92051b8bc 100644 --- a/main/interfaces.html +++ b/main/interfaces.html @@ -156,6 +156,15 @@

Interfaces

An interface implemented by objects that can get quota projects.
+
+
+
+ GetUniverseDomainInterface + +
+
+ An interface implemented by objects that can get universe domain for Google Cloud APIs. +
diff --git a/main/renderer.index b/main/renderer.index index 59693aad4..849abbc12 100644 --- a/main/renderer.index +++ b/main/renderer.index @@ -1 +1 @@ -C:19:"Sami\Renderer\Index":4615:{a:3:{i:0;a:36:{s:23:"Google\Auth\AccessToken";s:40:"e5db46d207cd5092c225b3340fdbce4cd2392c99";s:41:"Google\Auth\ApplicationDefaultCredentials";s:40:"2a6ce321a49f9b7a18a949f88967e3d6f9acaa0e";s:22:"Google\Auth\CacheTrait";s:40:"db4d1e565000de7d9a6fbd10bff36ba912d6d293";s:42:"Google\Auth\Cache\InvalidArgumentException";s:40:"8f2b4c6ae70bb114979a9b7db0f91f3deabf424f";s:22:"Google\Auth\Cache\Item";s:40:"1feb63ac653d62b87450c761ebcb04d4eb1f7464";s:37:"Google\Auth\Cache\MemoryCacheItemPool";s:40:"e45d7f64f7b749c769e61781e831b9b8d6f1b9fb";s:35:"Google\Auth\Cache\SysVCacheItemPool";s:40:"f2893b8eae104a9eb39dcacae72bf7147a207175";s:29:"Google\Auth\CredentialsLoader";s:40:"b678cce83acba5ff51d01ef8220ce64ec6694235";s:46:"Google\Auth\Credentials\AppIdentityCredentials";s:40:"6720d6ca5e1618c5b7d34273c05fb3ede599a218";s:38:"Google\Auth\Credentials\GCECredentials";s:40:"008e5fc565d6e3fc79d76cf2af62080d3c9318bf";s:38:"Google\Auth\Credentials\IAMCredentials";s:40:"8f0cbcc83ef2640cd046f749d5570080490d5ae4";s:61:"Google\Auth\Credentials\ImpersonatedServiceAccountCredentials";s:40:"15973ae5183577b1a008a1f3a6a965c0a5781ef9";s:43:"Google\Auth\Credentials\InsecureCredentials";s:40:"d8a2f02802f7215e63ac320a0aa1e0595b16c8f7";s:49:"Google\Auth\Credentials\ServiceAccountCredentials";s:40:"9a686e67430be513d0bbca804c48484d2f0fd7f2";s:58:"Google\Auth\Credentials\ServiceAccountJwtAccessCredentials";s:40:"b42288d34aa67649058d1107f426931696925d62";s:46:"Google\Auth\Credentials\UserRefreshCredentials";s:40:"103ece2c6668a42b6321aa6c0ba5cf85be8dd172";s:52:"Google\Auth\ExternalAccountCredentialSourceInterface";s:40:"81389058fc830b89de459418a67146a774be9dc0";s:31:"Google\Auth\FetchAuthTokenCache";s:40:"8af9d8e42dac082012075f65e217375fa4759a5e";s:35:"Google\Auth\FetchAuthTokenInterface";s:40:"f7de9336bb873a3f45aef697145bfec916f8aec9";s:20:"Google\Auth\GCECache";s:40:"440591bc053f1d8e618b9ad1572567556c9be4bd";s:36:"Google\Auth\GetQuotaProjectInterface";s:40:"104800d4947cc03e2f63fbb56e230ce45d2aed64";s:42:"Google\Auth\HttpHandler\Guzzle6HttpHandler";s:40:"607c45215af5ab91f17dee34ee794b72d4cba793";s:42:"Google\Auth\HttpHandler\Guzzle7HttpHandler";s:40:"d6d3fda11b7ddafa1ec0b446fee243124eed1dbc";s:39:"Google\Auth\HttpHandler\HttpClientCache";s:40:"4623c12081ee037456d72ac9ad8c2c8425d922e0";s:42:"Google\Auth\HttpHandler\HttpHandlerFactory";s:40:"2cea2e240dadade1be20f450f7d52dd39138db67";s:15:"Google\Auth\Iam";s:40:"dca7e2099575f4b0265bed528067dc2a9faa32d3";s:26:"Google\Auth\IamSignerTrait";s:40:"7a5ed36959cd876c3b1436c47a60dd3f92ca417d";s:42:"Google\Auth\Middleware\AuthTokenMiddleware";s:40:"3e5a6ef6a1f335b7f644c65a41e3f067e7218b26";s:47:"Google\Auth\Middleware\ProxyAuthTokenMiddleware";s:40:"7dd6e9b5ca483dfaf68f168eeec0f6df71d5e117";s:50:"Google\Auth\Middleware\ScopedAccessTokenMiddleware";s:40:"bc94991c0e91f248198ba3a6ddd8c329d45479c4";s:39:"Google\Auth\Middleware\SimpleMiddleware";s:40:"335f16bc9fc8dc38ecccb7dd1235a141bf0de4dc";s:38:"Google\Auth\ProjectIdProviderInterface";s:40:"d9bb4a94832c65b79b2b196249b2ec4160438bcc";s:37:"Google\Auth\ServiceAccountSignerTrait";s:40:"6e327c06dcb88bcd03abaad543e687e499a21474";s:29:"Google\Auth\SignBlobInterface";s:40:"17f129d466f0887f6de66dd3dc1968e8af4fe8a4";s:35:"Google\Auth\UpdateMetadataInterface";s:40:"210283a6a1d34c944724bbd73b3a774115b12eee";s:31:"Google\Auth\UpdateMetadataTrait";s:40:"12d61a4cf3e6ff1faa602784bb28b2c3a4fd32ea";}i:1;a:56:{i:0;s:4:"v1.0";i:1;s:6:"v1.0.1";i:2;s:6:"v1.1.0";i:3;s:6:"v1.2.0";i:4;s:6:"v1.2.1";i:5;s:6:"v1.3.0";i:6;s:6:"v1.3.1";i:7;s:6:"v1.3.2";i:8;s:6:"v1.3.3";i:9;s:6:"v1.4.0";i:10;s:6:"v1.5.0";i:11;s:6:"v1.5.1";i:12;s:6:"v1.5.2";i:13;s:6:"v1.6.0";i:14;s:6:"v1.6.1";i:15;s:6:"v1.7.0";i:16;s:6:"v1.7.1";i:17;s:6:"v1.8.0";i:18;s:6:"v1.9.0";i:19;s:7:"v1.10.0";i:20;s:7:"v1.11.0";i:21;s:7:"v1.11.1";i:22;s:7:"v1.12.0";i:23;s:7:"v1.12.1";i:24;s:7:"v1.13.0";i:25;s:7:"v1.14.0";i:26;s:7:"v1.14.1";i:27;s:7:"v1.14.2";i:28;s:7:"v1.14.3";i:29;s:7:"v1.15.0";i:30;s:7:"v1.15.1";i:31;s:7:"v1.15.2";i:32;s:7:"v1.16.0";i:33;s:7:"v1.17.0";i:34;s:7:"v1.18.0";i:35;s:7:"v1.19.0";i:36;s:7:"v1.19.1";i:37;s:7:"v1.20.0";i:38;s:7:"v1.20.1";i:39;s:7:"v1.21.0";i:40;s:7:"v1.21.1";i:41;s:7:"v1.22.0";i:42;s:7:"v1.23.0";i:43;s:7:"v1.23.1";i:44;s:7:"v1.24.0";i:45;s:7:"v1.25.0";i:46;s:7:"v1.26.0";i:47;s:7:"v1.27.0";i:48;s:7:"v1.28.0";i:49;s:7:"v1.29.0";i:50;s:7:"v1.29.1";i:51;s:7:"v1.30.0";i:52;s:7:"v1.31.0";i:53;s:7:"v1.32.0";i:54;s:7:"v1.32.1";i:55;s:4:"main";}i:2;a:6:{i:0;s:6:"Google";i:1;s:11:"Google\Auth";i:2;s:17:"Google\Auth\Cache";i:3;s:23:"Google\Auth\Credentials";i:4;s:23:"Google\Auth\HttpHandler";i:5;s:22:"Google\Auth\Middleware";}}} \ No newline at end of file +C:19:"Sami\Renderer\Index":4604:{a:3:{i:0;a:36:{s:23:"Google\Auth\AccessToken";s:40:"e5db46d207cd5092c225b3340fdbce4cd2392c99";s:41:"Google\Auth\ApplicationDefaultCredentials";s:40:"2a6ce321a49f9b7a18a949f88967e3d6f9acaa0e";s:22:"Google\Auth\CacheTrait";s:40:"db4d1e565000de7d9a6fbd10bff36ba912d6d293";s:42:"Google\Auth\Cache\InvalidArgumentException";s:40:"8f2b4c6ae70bb114979a9b7db0f91f3deabf424f";s:22:"Google\Auth\Cache\Item";s:40:"1feb63ac653d62b87450c761ebcb04d4eb1f7464";s:37:"Google\Auth\Cache\MemoryCacheItemPool";s:40:"e45d7f64f7b749c769e61781e831b9b8d6f1b9fb";s:35:"Google\Auth\Cache\SysVCacheItemPool";s:40:"f2893b8eae104a9eb39dcacae72bf7147a207175";s:29:"Google\Auth\CredentialsLoader";s:40:"552b066981732a8cb8c35e719b434d875087a70f";s:46:"Google\Auth\Credentials\AppIdentityCredentials";s:40:"6720d6ca5e1618c5b7d34273c05fb3ede599a218";s:38:"Google\Auth\Credentials\GCECredentials";s:40:"008e5fc565d6e3fc79d76cf2af62080d3c9318bf";s:38:"Google\Auth\Credentials\IAMCredentials";s:40:"8f0cbcc83ef2640cd046f749d5570080490d5ae4";s:61:"Google\Auth\Credentials\ImpersonatedServiceAccountCredentials";s:40:"15973ae5183577b1a008a1f3a6a965c0a5781ef9";s:43:"Google\Auth\Credentials\InsecureCredentials";s:40:"d8a2f02802f7215e63ac320a0aa1e0595b16c8f7";s:58:"Google\Auth\Credentials\ServiceAccountJwtAccessCredentials";s:40:"b42288d34aa67649058d1107f426931696925d62";s:46:"Google\Auth\Credentials\UserRefreshCredentials";s:40:"103ece2c6668a42b6321aa6c0ba5cf85be8dd172";s:52:"Google\Auth\ExternalAccountCredentialSourceInterface";s:40:"81389058fc830b89de459418a67146a774be9dc0";s:31:"Google\Auth\FetchAuthTokenCache";s:40:"ae6477e89c24d17280ba8c8cce43c8eb8089472b";s:35:"Google\Auth\FetchAuthTokenInterface";s:40:"f7de9336bb873a3f45aef697145bfec916f8aec9";s:20:"Google\Auth\GCECache";s:40:"440591bc053f1d8e618b9ad1572567556c9be4bd";s:36:"Google\Auth\GetQuotaProjectInterface";s:40:"104800d4947cc03e2f63fbb56e230ce45d2aed64";s:38:"Google\Auth\GetUniverseDomainInterface";s:40:"daee3d66788da00fd2d6ae1bbd343c0cd6c20a3e";s:42:"Google\Auth\HttpHandler\Guzzle6HttpHandler";s:40:"607c45215af5ab91f17dee34ee794b72d4cba793";s:42:"Google\Auth\HttpHandler\Guzzle7HttpHandler";s:40:"d6d3fda11b7ddafa1ec0b446fee243124eed1dbc";s:39:"Google\Auth\HttpHandler\HttpClientCache";s:40:"4623c12081ee037456d72ac9ad8c2c8425d922e0";s:42:"Google\Auth\HttpHandler\HttpHandlerFactory";s:40:"2cea2e240dadade1be20f450f7d52dd39138db67";s:15:"Google\Auth\Iam";s:40:"dca7e2099575f4b0265bed528067dc2a9faa32d3";s:26:"Google\Auth\IamSignerTrait";s:40:"7a5ed36959cd876c3b1436c47a60dd3f92ca417d";s:42:"Google\Auth\Middleware\AuthTokenMiddleware";s:40:"3e5a6ef6a1f335b7f644c65a41e3f067e7218b26";s:47:"Google\Auth\Middleware\ProxyAuthTokenMiddleware";s:40:"7dd6e9b5ca483dfaf68f168eeec0f6df71d5e117";s:50:"Google\Auth\Middleware\ScopedAccessTokenMiddleware";s:40:"bc94991c0e91f248198ba3a6ddd8c329d45479c4";s:39:"Google\Auth\Middleware\SimpleMiddleware";s:40:"335f16bc9fc8dc38ecccb7dd1235a141bf0de4dc";s:38:"Google\Auth\ProjectIdProviderInterface";s:40:"d9bb4a94832c65b79b2b196249b2ec4160438bcc";s:37:"Google\Auth\ServiceAccountSignerTrait";s:40:"6e327c06dcb88bcd03abaad543e687e499a21474";s:29:"Google\Auth\SignBlobInterface";s:40:"17f129d466f0887f6de66dd3dc1968e8af4fe8a4";s:35:"Google\Auth\UpdateMetadataInterface";s:40:"210283a6a1d34c944724bbd73b3a774115b12eee";s:31:"Google\Auth\UpdateMetadataTrait";s:40:"12d61a4cf3e6ff1faa602784bb28b2c3a4fd32ea";}i:1;a:56:{i:0;s:4:"v1.0";i:1;s:6:"v1.0.1";i:2;s:6:"v1.1.0";i:3;s:6:"v1.2.0";i:4;s:6:"v1.2.1";i:5;s:6:"v1.3.0";i:6;s:6:"v1.3.1";i:7;s:6:"v1.3.2";i:8;s:6:"v1.3.3";i:9;s:6:"v1.4.0";i:10;s:6:"v1.5.0";i:11;s:6:"v1.5.1";i:12;s:6:"v1.5.2";i:13;s:6:"v1.6.0";i:14;s:6:"v1.6.1";i:15;s:6:"v1.7.0";i:16;s:6:"v1.7.1";i:17;s:6:"v1.8.0";i:18;s:6:"v1.9.0";i:19;s:7:"v1.10.0";i:20;s:7:"v1.11.0";i:21;s:7:"v1.11.1";i:22;s:7:"v1.12.0";i:23;s:7:"v1.12.1";i:24;s:7:"v1.13.0";i:25;s:7:"v1.14.0";i:26;s:7:"v1.14.1";i:27;s:7:"v1.14.2";i:28;s:7:"v1.14.3";i:29;s:7:"v1.15.0";i:30;s:7:"v1.15.1";i:31;s:7:"v1.15.2";i:32;s:7:"v1.16.0";i:33;s:7:"v1.17.0";i:34;s:7:"v1.18.0";i:35;s:7:"v1.19.0";i:36;s:7:"v1.19.1";i:37;s:7:"v1.20.0";i:38;s:7:"v1.20.1";i:39;s:7:"v1.21.0";i:40;s:7:"v1.21.1";i:41;s:7:"v1.22.0";i:42;s:7:"v1.23.0";i:43;s:7:"v1.23.1";i:44;s:7:"v1.24.0";i:45;s:7:"v1.25.0";i:46;s:7:"v1.26.0";i:47;s:7:"v1.27.0";i:48;s:7:"v1.28.0";i:49;s:7:"v1.29.0";i:50;s:7:"v1.29.1";i:51;s:7:"v1.30.0";i:52;s:7:"v1.31.0";i:53;s:7:"v1.32.0";i:54;s:7:"v1.32.1";i:55;s:4:"main";}i:2;a:6:{i:0;s:6:"Google";i:1;s:11:"Google\Auth";i:2;s:17:"Google\Auth\Cache";i:3;s:23:"Google\Auth\Credentials";i:4;s:23:"Google\Auth\HttpHandler";i:5;s:22:"Google\Auth\Middleware";}}} \ No newline at end of file diff --git a/main/sami.js b/main/sami.js index 402a51011..3fb157cac 100644 --- a/main/sami.js +++ b/main/sami.js @@ -5,7 +5,7 @@ window.projectVersion = 'main'; var bhIndex = null; var rootPath = ''; - var treeHtml = ' '; + var treeHtml = ' '; var searchTypeClasses = { 'Namespace': 'label-default', @@ -30,6 +30,9 @@ window.projectVersion = 'main'; {"type": "Interface", "fromName": "Google\\Auth", "fromLink": "Google/Auth.html", "link": "Google/Auth/GetQuotaProjectInterface.html", "name": "Google\\Auth\\GetQuotaProjectInterface", "doc": ""An interface implemented by objects that can get quota projects.""}, {"type": "Method", "fromName": "Google\\Auth\\GetQuotaProjectInterface", "fromLink": "Google/Auth/GetQuotaProjectInterface.html", "link": "Google/Auth/GetQuotaProjectInterface.html#method_getQuotaProject", "name": "Google\\Auth\\GetQuotaProjectInterface::getQuotaProject", "doc": ""Get the quota project used for this API request""}, + {"type": "Interface", "fromName": "Google\\Auth", "fromLink": "Google/Auth.html", "link": "Google/Auth/GetUniverseDomainInterface.html", "name": "Google\\Auth\\GetUniverseDomainInterface", "doc": ""An interface implemented by objects that can get universe domain for Google Cloud APIs.""}, + {"type": "Method", "fromName": "Google\\Auth\\GetUniverseDomainInterface", "fromLink": "Google/Auth/GetUniverseDomainInterface.html", "link": "Google/Auth/GetUniverseDomainInterface.html#method_getUniverseDomain", "name": "Google\\Auth\\GetUniverseDomainInterface::getUniverseDomain", "doc": ""Get the universe domain from the credential. This should always return\na string, and default to \"googleapis.com\" if no universe domain is\nconfigured.""}, + {"type": "Interface", "fromName": "Google\\Auth", "fromLink": "Google/Auth.html", "link": "Google/Auth/ProjectIdProviderInterface.html", "name": "Google\\Auth\\ProjectIdProviderInterface", "doc": ""Describes a Credentials object which supports fetching the project ID.""}, {"type": "Method", "fromName": "Google\\Auth\\ProjectIdProviderInterface", "fromLink": "Google/Auth/ProjectIdProviderInterface.html", "link": "Google/Auth/ProjectIdProviderInterface.html#method_getProjectId", "name": "Google\\Auth\\ProjectIdProviderInterface::getProjectId", "doc": ""Get the project ID.""}, @@ -102,6 +105,7 @@ window.projectVersion = 'main'; {"type": "Method", "fromName": "Google\\Auth\\CredentialsLoader", "fromLink": "Google/Auth/CredentialsLoader.html", "link": "Google/Auth/CredentialsLoader.html#method_quotaProjectFromEnv", "name": "Google\\Auth\\CredentialsLoader::quotaProjectFromEnv", "doc": ""Fetch a quota project from the environment variable\nGOOGLE_CLOUD_QUOTA_PROJECT. Return null if\nGOOGLE_CLOUD_QUOTA_PROJECT is not specified.""}, {"type": "Method", "fromName": "Google\\Auth\\CredentialsLoader", "fromLink": "Google/Auth/CredentialsLoader.html", "link": "Google/Auth/CredentialsLoader.html#method_getDefaultClientCertSource", "name": "Google\\Auth\\CredentialsLoader::getDefaultClientCertSource", "doc": ""Gets a callable which returns the default device certification.""}, {"type": "Method", "fromName": "Google\\Auth\\CredentialsLoader", "fromLink": "Google/Auth/CredentialsLoader.html", "link": "Google/Auth/CredentialsLoader.html#method_shouldLoadClientCertSource", "name": "Google\\Auth\\CredentialsLoader::shouldLoadClientCertSource", "doc": ""Determines whether or not the default device certificate should be loaded.""}, + {"type": "Method", "fromName": "Google\\Auth\\CredentialsLoader", "fromLink": "Google/Auth/CredentialsLoader.html", "link": "Google/Auth/CredentialsLoader.html#method_getUniverseDomain", "name": "Google\\Auth\\CredentialsLoader::getUniverseDomain", "doc": ""Get the universe domain from the credential. Defaults to \"googleapis.com\"\nfor all credential types which do not support universe domain.""}, {"type": "Class", "fromName": "Google\\Auth\\Credentials", "fromLink": "Google/Auth/Credentials.html", "link": "Google/Auth/Credentials/AppIdentityCredentials.html", "name": "Google\\Auth\\Credentials\\AppIdentityCredentials", "doc": """"}, {"type": "Method", "fromName": "Google\\Auth\\Credentials\\AppIdentityCredentials", "fromLink": "Google/Auth/Credentials/AppIdentityCredentials.html", "link": "Google/Auth/Credentials/AppIdentityCredentials.html#method___construct", "name": "Google\\Auth\\Credentials\\AppIdentityCredentials::__construct", "doc": """"}, @@ -144,18 +148,6 @@ window.projectVersion = 'main'; {"type": "Method", "fromName": "Google\\Auth\\Credentials\\InsecureCredentials", "fromLink": "Google/Auth/Credentials/InsecureCredentials.html", "link": "Google/Auth/Credentials/InsecureCredentials.html#method_getCacheKey", "name": "Google\\Auth\\Credentials\\InsecureCredentials::getCacheKey", "doc": ""Returns the cache key. In this case it returns a null value, disabling\ncaching.""}, {"type": "Method", "fromName": "Google\\Auth\\Credentials\\InsecureCredentials", "fromLink": "Google/Auth/Credentials/InsecureCredentials.html", "link": "Google/Auth/Credentials/InsecureCredentials.html#method_getLastReceivedToken", "name": "Google\\Auth\\Credentials\\InsecureCredentials::getLastReceivedToken", "doc": ""Fetches the last received token. In this case, it returns the same empty string\nauth token.""}, - {"type": "Class", "fromName": "Google\\Auth\\Credentials", "fromLink": "Google/Auth/Credentials.html", "link": "Google/Auth/Credentials/ServiceAccountCredentials.html", "name": "Google\\Auth\\Credentials\\ServiceAccountCredentials", "doc": ""ServiceAccountCredentials supports authorization using a Google service\naccount.""}, - {"type": "Method", "fromName": "Google\\Auth\\Credentials\\ServiceAccountCredentials", "fromLink": "Google/Auth/Credentials/ServiceAccountCredentials.html", "link": "Google/Auth/Credentials/ServiceAccountCredentials.html#method___construct", "name": "Google\\Auth\\Credentials\\ServiceAccountCredentials::__construct", "doc": ""Create a new ServiceAccountCredentials.""}, - {"type": "Method", "fromName": "Google\\Auth\\Credentials\\ServiceAccountCredentials", "fromLink": "Google/Auth/Credentials/ServiceAccountCredentials.html", "link": "Google/Auth/Credentials/ServiceAccountCredentials.html#method_useJwtAccessWithScope", "name": "Google\\Auth\\Credentials\\ServiceAccountCredentials::useJwtAccessWithScope", "doc": ""When called, the ServiceAccountCredentials will use an instance of\nServiceAccountJwtAccessCredentials to fetch (self-sign) an access token\neven when only scopes are supplied. Otherwise,\nServiceAccountJwtAccessCredentials is only called when no scopes and an\nauthUrl (audience) is suppled.""}, - {"type": "Method", "fromName": "Google\\Auth\\Credentials\\ServiceAccountCredentials", "fromLink": "Google/Auth/Credentials/ServiceAccountCredentials.html", "link": "Google/Auth/Credentials/ServiceAccountCredentials.html#method_fetchAuthToken", "name": "Google\\Auth\\Credentials\\ServiceAccountCredentials::fetchAuthToken", "doc": """"}, - {"type": "Method", "fromName": "Google\\Auth\\Credentials\\ServiceAccountCredentials", "fromLink": "Google/Auth/Credentials/ServiceAccountCredentials.html", "link": "Google/Auth/Credentials/ServiceAccountCredentials.html#method_getCacheKey", "name": "Google\\Auth\\Credentials\\ServiceAccountCredentials::getCacheKey", "doc": """"}, - {"type": "Method", "fromName": "Google\\Auth\\Credentials\\ServiceAccountCredentials", "fromLink": "Google/Auth/Credentials/ServiceAccountCredentials.html", "link": "Google/Auth/Credentials/ServiceAccountCredentials.html#method_getLastReceivedToken", "name": "Google\\Auth\\Credentials\\ServiceAccountCredentials::getLastReceivedToken", "doc": """"}, - {"type": "Method", "fromName": "Google\\Auth\\Credentials\\ServiceAccountCredentials", "fromLink": "Google/Auth/Credentials/ServiceAccountCredentials.html", "link": "Google/Auth/Credentials/ServiceAccountCredentials.html#method_getProjectId", "name": "Google\\Auth\\Credentials\\ServiceAccountCredentials::getProjectId", "doc": ""Get the project ID from the service account keyfile.""}, - {"type": "Method", "fromName": "Google\\Auth\\Credentials\\ServiceAccountCredentials", "fromLink": "Google/Auth/Credentials/ServiceAccountCredentials.html", "link": "Google/Auth/Credentials/ServiceAccountCredentials.html#method_updateMetadata", "name": "Google\\Auth\\Credentials\\ServiceAccountCredentials::updateMetadata", "doc": ""Updates metadata with the authorization token.""}, - {"type": "Method", "fromName": "Google\\Auth\\Credentials\\ServiceAccountCredentials", "fromLink": "Google/Auth/Credentials/ServiceAccountCredentials.html", "link": "Google/Auth/Credentials/ServiceAccountCredentials.html#method_setSub", "name": "Google\\Auth\\Credentials\\ServiceAccountCredentials::setSub", "doc": """"}, - {"type": "Method", "fromName": "Google\\Auth\\Credentials\\ServiceAccountCredentials", "fromLink": "Google/Auth/Credentials/ServiceAccountCredentials.html", "link": "Google/Auth/Credentials/ServiceAccountCredentials.html#method_getClientName", "name": "Google\\Auth\\Credentials\\ServiceAccountCredentials::getClientName", "doc": ""Get the client name from the keyfile.""}, - {"type": "Method", "fromName": "Google\\Auth\\Credentials\\ServiceAccountCredentials", "fromLink": "Google/Auth/Credentials/ServiceAccountCredentials.html", "link": "Google/Auth/Credentials/ServiceAccountCredentials.html#method_getQuotaProject", "name": "Google\\Auth\\Credentials\\ServiceAccountCredentials::getQuotaProject", "doc": ""Get the quota project used for this API request""}, - {"type": "Class", "fromName": "Google\\Auth\\Credentials", "fromLink": "Google/Auth/Credentials.html", "link": "Google/Auth/Credentials/ServiceAccountJwtAccessCredentials.html", "name": "Google\\Auth\\Credentials\\ServiceAccountJwtAccessCredentials", "doc": ""Authenticates requests using Google's Service Account credentials via\nJWT Access.""}, {"type": "Method", "fromName": "Google\\Auth\\Credentials\\ServiceAccountJwtAccessCredentials", "fromLink": "Google/Auth/Credentials/ServiceAccountJwtAccessCredentials.html", "link": "Google/Auth/Credentials/ServiceAccountJwtAccessCredentials.html#method___construct", "name": "Google\\Auth\\Credentials\\ServiceAccountJwtAccessCredentials::__construct", "doc": ""Create a new ServiceAccountJwtAccessCredentials.""}, {"type": "Method", "fromName": "Google\\Auth\\Credentials\\ServiceAccountJwtAccessCredentials", "fromLink": "Google/Auth/Credentials/ServiceAccountJwtAccessCredentials.html", "link": "Google/Auth/Credentials/ServiceAccountJwtAccessCredentials.html#method_updateMetadata", "name": "Google\\Auth\\Credentials\\ServiceAccountJwtAccessCredentials::updateMetadata", "doc": ""Updates metadata with the authorization token.""}, @@ -187,6 +179,7 @@ window.projectVersion = 'main'; {"type": "Method", "fromName": "Google\\Auth\\FetchAuthTokenCache", "fromLink": "Google/Auth/FetchAuthTokenCache.html", "link": "Google/Auth/FetchAuthTokenCache.html#method_signBlob", "name": "Google\\Auth\\FetchAuthTokenCache::signBlob", "doc": ""Sign a blob using the fetcher.""}, {"type": "Method", "fromName": "Google\\Auth\\FetchAuthTokenCache", "fromLink": "Google/Auth/FetchAuthTokenCache.html", "link": "Google/Auth/FetchAuthTokenCache.html#method_getQuotaProject", "name": "Google\\Auth\\FetchAuthTokenCache::getQuotaProject", "doc": ""Get the quota project used for this API request from the credentials\nfetcher.""}, {"type": "Method", "fromName": "Google\\Auth\\FetchAuthTokenCache", "fromLink": "Google/Auth/FetchAuthTokenCache.html", "link": "Google/Auth/FetchAuthTokenCache.html#method_getProjectId", "name": "Google\\Auth\\FetchAuthTokenCache::getProjectId", "doc": ""Get the project ID.""}, + {"type": "Method", "fromName": "Google\\Auth\\FetchAuthTokenCache", "fromLink": "Google/Auth/FetchAuthTokenCache.html", "link": "Google/Auth/FetchAuthTokenCache.html#method_getUniverseDomain", "name": "Google\\Auth\\FetchAuthTokenCache::getUniverseDomain", "doc": ""Get the universe domain from the credential. This should always return\na string, and default to \"googleapis.com\" if no universe domain is\nconfigured.""}, {"type": "Method", "fromName": "Google\\Auth\\FetchAuthTokenCache", "fromLink": "Google/Auth/FetchAuthTokenCache.html", "link": "Google/Auth/FetchAuthTokenCache.html#method_updateMetadata", "name": "Google\\Auth\\FetchAuthTokenCache::updateMetadata", "doc": ""Updates metadata with the authorization token.""}, {"type": "Class", "fromName": "Google\\Auth", "fromLink": "Google/Auth.html", "link": "Google/Auth/FetchAuthTokenInterface.html", "name": "Google\\Auth\\FetchAuthTokenInterface", "doc": ""An interface implemented by objects that can fetch auth tokens.""}, @@ -201,6 +194,9 @@ window.projectVersion = 'main'; {"type": "Class", "fromName": "Google\\Auth", "fromLink": "Google/Auth.html", "link": "Google/Auth/GetQuotaProjectInterface.html", "name": "Google\\Auth\\GetQuotaProjectInterface", "doc": ""An interface implemented by objects that can get quota projects.""}, {"type": "Method", "fromName": "Google\\Auth\\GetQuotaProjectInterface", "fromLink": "Google/Auth/GetQuotaProjectInterface.html", "link": "Google/Auth/GetQuotaProjectInterface.html#method_getQuotaProject", "name": "Google\\Auth\\GetQuotaProjectInterface::getQuotaProject", "doc": ""Get the quota project used for this API request""}, + {"type": "Class", "fromName": "Google\\Auth", "fromLink": "Google/Auth.html", "link": "Google/Auth/GetUniverseDomainInterface.html", "name": "Google\\Auth\\GetUniverseDomainInterface", "doc": ""An interface implemented by objects that can get universe domain for Google Cloud APIs.""}, + {"type": "Method", "fromName": "Google\\Auth\\GetUniverseDomainInterface", "fromLink": "Google/Auth/GetUniverseDomainInterface.html", "link": "Google/Auth/GetUniverseDomainInterface.html#method_getUniverseDomain", "name": "Google\\Auth\\GetUniverseDomainInterface::getUniverseDomain", "doc": ""Get the universe domain from the credential. This should always return\na string, and default to \"googleapis.com\" if no universe domain is\nconfigured.""}, + {"type": "Class", "fromName": "Google\\Auth\\HttpHandler", "fromLink": "Google/Auth/HttpHandler.html", "link": "Google/Auth/HttpHandler/Guzzle6HttpHandler.html", "name": "Google\\Auth\\HttpHandler\\Guzzle6HttpHandler", "doc": """"}, {"type": "Method", "fromName": "Google\\Auth\\HttpHandler\\Guzzle6HttpHandler", "fromLink": "Google/Auth/HttpHandler/Guzzle6HttpHandler.html", "link": "Google/Auth/HttpHandler/Guzzle6HttpHandler.html#method___construct", "name": "Google\\Auth\\HttpHandler\\Guzzle6HttpHandler::__construct", "doc": """"}, {"type": "Method", "fromName": "Google\\Auth\\HttpHandler\\Guzzle6HttpHandler", "fromLink": "Google/Auth/HttpHandler/Guzzle6HttpHandler.html", "link": "Google/Auth/HttpHandler/Guzzle6HttpHandler.html#method___invoke", "name": "Google\\Auth\\HttpHandler\\Guzzle6HttpHandler::__invoke", "doc": ""Accepts a PSR-7 request and an array of options and returns a PSR-7 response.""},