Class ApiKeyCredentials (1.30.0)

public class ApiKeyCredentials extends Credentials

Credentials class for calling Google APIs using an API key.

Uses an API key directly in the request metadata to provide authorization.

Note: ApiKeyCredentials extends from base Credentials class rather than GoogleCredentials/OAuth2Credentials, as it does not provide an access token and is not considered an OAuth2 credential.


 Credentials credentials = ApiKeyCredentials.create("your api key");

Inheritance

java.lang.Object > Credentials > ApiKeyCredentials

Inherited Members

Credentials.blockingGetToCallback(URI,RequestMetadataCallback)

Credentials.getAuthenticationType()

Credentials.getMetricsCredentialType()

Credentials.getRequestMetadata()

Credentials.getRequestMetadata(URI)

Credentials.getRequestMetadata(URI,Executor,RequestMetadataCallback)

Credentials.getUniverseDomain()

Credentials.hasRequestMetadata()

Credentials.hasRequestMetadataOnly()

Credentials.refresh()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(String apiKey)

public static ApiKeyCredentials create(String apiKey)

Parameter
Name	Description
`apiKey`	`String`

Returns
Type	Description
`ApiKeyCredentials`

Methods

getAuthenticationType()

public String getAuthenticationType()

A constant string name describing the authentication technology.

E.g. “OAuth2”, “SSL”. For use by the transport layer to determine whether it supports the type of authentication in the case where Credentials#hasRequestMetadataOnly is false. Also serves as a debugging helper.

Returns
Type	Description
`String`

Overrides

Credentials.getAuthenticationType()

getRequestMetadata(URI uri)

public Map<String,List<String>> getRequestMetadata(URI uri)

Get the current request metadata in a blocking manner, refreshing tokens if required.

This should be called by the transport layer on each request, and the data should be populated in headers or other context. The operation can block and fail to complete and may do things such as refreshing access tokens.

The convention for handling binary data is for the key in the returned map to end with "-bin" and for the corresponding values to be base64 encoded.

Parameter
Name	Description
`uri`	`URI`

Returns
Type	Description
`Map<String,List<String>>`

Overrides

Credentials.getRequestMetadata(URI uri)

Exceptions
Type	Description
`IOException`

hasRequestMetadata()

public boolean hasRequestMetadata()

Whether the credentials have metadata entries that should be added to each request.

This should be called by the transport layer to see if Credentials#getRequestMetadata should be used for each request.

Returns
Type	Description
`boolean`

Overrides

Credentials.hasRequestMetadata()

hasRequestMetadataOnly()

public boolean hasRequestMetadataOnly()

Indicates whether or not the Auth mechanism works purely by including request metadata.

This is meant for the transport layer. If this is true a transport does not need to take actions other than including the request metadata. If this is false, a transport must specifically know about the authentication technology to support it, and should fail to accept the credentials otherwise.

Returns
Type	Description
`boolean`

Overrides

Credentials.hasRequestMetadataOnly()

refresh()

public void refresh()

There is no concept of refreshing an API tokens, this method is a no-op.

Overrides

Credentials.refresh()

Exceptions
Type	Description
`IOException`