Package org.springframework.vault.authentication

Class GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder

java.lang.Object

org.springframework.vault.authentication.GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder

Enclosing class:

GcpIamAuthenticationOptions

public static class GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder
extends Object

Builder for GcpIamAuthenticationOptions.

Method Summary

Modifier and Type	Method	Description
GcpIamAuthenticationOptions	build()	Build a new GcpIamAuthenticationOptions instance.
GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder	clock(Clock clock)	Configure the Clock used to calculate epoch seconds until the JWT expiration.
GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder	credential(com.google.api.client.googleapis.auth.oauth2.GoogleCredential credential)	Configure static Google credentials, required to create a signed JWT.
GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder	credentialSupplier(GcpCredentialSupplier credentialSupplier)	Configure a GcpCredentialSupplier, required to create a signed JWT.
GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder	jwtValidity(Duration jwtValidity)	Configure the Duration for the JWT expiration.
GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder	path(String path)	Configure the mount path, defaults to aws.
GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder	projectId(String projectId)	Configure an explicit GCP project id to use in GCP IAM API calls.
GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder	role(String role)	Configure the name of the role against which the login is being attempted.
GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder	serviceAccountId(String serviceAccountId)	Configure an explicit service account id to use in GCP IAM calls.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

path

public GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder path(String path)

Configure the mount path, defaults to aws.

Parameters:

path - must not be empty or null.

Returns:

this builder.

credential

public GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder credential(com.google.api.client.googleapis.auth.oauth2.GoogleCredential credential)

Configure static Google credentials, required to create a signed JWT. Either use static credentials or provide a credentials provider.

Parameters:

credential - must not be null.

Returns:

this builder.

See Also:

• credentialSupplier(GcpCredentialSupplier)

credentialSupplier

public GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder credentialSupplier(GcpCredentialSupplier credentialSupplier)

Configure a GcpCredentialSupplier, required to create a signed JWT. Alternatively, configure static credentials.

Parameters:

credentialSupplier - must not be null.

Returns:

this builder.

See Also:

• credential(GoogleCredential)

serviceAccountId

public GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder serviceAccountId(String serviceAccountId)

Configure an explicit service account id to use in GCP IAM calls. If none is configured, falls back to using GoogleCredential.getServiceAccountId().

Parameters:

serviceAccountId - the service account id (email) to use

Returns:

this builder.

Since:

2.1

projectId

public GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder projectId(String projectId)

Configure an explicit GCP project id to use in GCP IAM API calls. If none is configured, falls back using GoogleCredential.getServiceAccountProjectId().

Parameters:

projectId - the GCP project id to use in GCP IAM API calls

Returns:

this builder.

Since:

2.1

role

public GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder role(String role)

Configure the name of the role against which the login is being attempted.

Parameters:

role - must not be empty or null.

Returns:

this builder.

jwtValidity

public GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder jwtValidity(Duration jwtValidity)

Configure the Duration for the JWT expiration. This defaults to 15 minutes and cannot be more than a hour.

Parameters:

jwtValidity - must not be null.

Returns:

this builder.

clock

public GcpIamAuthenticationOptions.GcpIamAuthenticationOptionsBuilder clock(Clock clock)

Configure the Clock used to calculate epoch seconds until the JWT expiration.

Parameters:

clock - must not be null.

Returns:

this builder.

build

public GcpIamAuthenticationOptions build()

Build a new GcpIamAuthenticationOptions instance.

Returns:

a new GcpIamAuthenticationOptions.