com.google.cloud.aiplatform.v1beta1

Interface AuthConfig.OidcConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AuthConfig.OidcConfig, AuthConfig.OidcConfig.Builder

Enclosing class:

AuthConfig

public static interface AuthConfig.OidcConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getIdToken() OpenID Connect formatted ID token for extension endpoint.
com.google.protobuf.ByteString	getIdTokenBytes() OpenID Connect formatted ID token for extension endpoint.
AuthConfig.OidcConfig.OidcConfigCase	getOidcConfigCase()
String	getServiceAccount() The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc)
com.google.protobuf.ByteString	getServiceAccountBytes() The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc)
boolean	hasIdToken() OpenID Connect formatted ID token for extension endpoint.
boolean	hasServiceAccount() The service account used to generate an OpenID Connect (OIDC)-compatible JWT token signed by the Google OIDC Provider (accounts.google.com) for extension endpoint (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc)

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasIdToken

boolean hasIdToken()

 OpenID Connect formatted ID token for extension endpoint.
 Only used to propagate token from
 [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
 

string id_token = 1;

Returns:

Whether the idToken field is set.

getIdToken

String getIdToken()

 OpenID Connect formatted ID token for extension endpoint.
 Only used to propagate token from
 [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
 

string id_token = 1;

Returns:

The idToken.

getIdTokenBytes

com.google.protobuf.ByteString getIdTokenBytes()

 OpenID Connect formatted ID token for extension endpoint.
 Only used to propagate token from
 [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
 

string id_token = 1;

Returns:

The bytes for idToken.

hasServiceAccount

boolean hasServiceAccount()

 The service account used to generate an OpenID Connect
 (OIDC)-compatible JWT token signed by the Google OIDC Provider
 (accounts.google.com) for extension endpoint
 (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc).

 - The audience for the token will be set to the URL in the server url
 defined in the OpenApi spec.

 - If the service account is provided, the service account should grant
 `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension
 Service Agent
 (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
 

string service_account = 2;

Returns:

Whether the serviceAccount field is set.

getServiceAccount

String getServiceAccount()

 The service account used to generate an OpenID Connect
 (OIDC)-compatible JWT token signed by the Google OIDC Provider
 (accounts.google.com) for extension endpoint
 (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc).

 - The audience for the token will be set to the URL in the server url
 defined in the OpenApi spec.

 - If the service account is provided, the service account should grant
 `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension
 Service Agent
 (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
 

string service_account = 2;

Returns:

The serviceAccount.

getServiceAccountBytes

com.google.protobuf.ByteString getServiceAccountBytes()

 The service account used to generate an OpenID Connect
 (OIDC)-compatible JWT token signed by the Google OIDC Provider
 (accounts.google.com) for extension endpoint
 (https://cloud.google.com/iam/docs/create-short-lived-credentials-direct#sa-credentials-oidc).

 - The audience for the token will be set to the URL in the server url
 defined in the OpenApi spec.

 - If the service account is provided, the service account should grant
 `iam.serviceAccounts.getOpenIdToken` permission to Vertex AI Extension
 Service Agent
 (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
 

string service_account = 2;

Returns:

The bytes for serviceAccount.

getOidcConfigCase

AuthConfig.OidcConfig.OidcConfigCase getOidcConfigCase()