Package com.google.cloud.aiplatform.v1beta1

Interface AuthConfig.OauthConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AuthConfig.OauthConfig, AuthConfig.OauthConfig.Builder
Enclosing class:
AuthConfig
public static interface AuthConfig.OauthConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAccessToken()
    Access token for extension endpoint.
    com.google.protobuf.ByteString
    getAccessTokenBytes()
    Access token for extension endpoint.
    AuthConfig.OauthConfig.OauthConfigCase
    getOauthConfigCase()
     
    String
    getServiceAccount()
    The service account used to generate access tokens for executing the Extension
    com.google.protobuf.ByteString
    getServiceAccountBytes()
    The service account used to generate access tokens for executing the Extension
    boolean
    hasAccessToken()
    Access token for extension endpoint.
    boolean
    hasServiceAccount()
    The service account used to generate access tokens for executing the Extension

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasAccessToken

      boolean hasAccessToken()
       Access token for extension endpoint.
 Only used to propagate token from
 [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
      string access_token = 1;
      Returns:
      Whether the accessToken field is set.

    • getAccessToken

      String getAccessToken()
       Access token for extension endpoint.
 Only used to propagate token from
 [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
      string access_token = 1;
      Returns:
      The accessToken.

    • getAccessTokenBytes

      com.google.protobuf.ByteString getAccessTokenBytes()
       Access token for extension endpoint.
 Only used to propagate token from
 [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
      string access_token = 1;
      Returns:
      The bytes for accessToken.

    • hasServiceAccount

      boolean hasServiceAccount()
       The service account used to generate access tokens for executing the
 Extension.

 - If the service account is specified,
 the `iam.serviceAccounts.getAccessToken` permission should be granted
 to Vertex AI Extension Service Agent
 (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 on the provided service account.
      string service_account = 2;
      Returns:
      Whether the serviceAccount field is set.

    • getServiceAccount

      String getServiceAccount()
       The service account used to generate access tokens for executing the
 Extension.

 - If the service account is specified,
 the `iam.serviceAccounts.getAccessToken` permission should be granted
 to Vertex AI Extension Service Agent
 (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 on the provided service account.
      string service_account = 2;
      Returns:
      The serviceAccount.

    • getServiceAccountBytes

      com.google.protobuf.ByteString getServiceAccountBytes()
       The service account used to generate access tokens for executing the
 Extension.

 - If the service account is specified,
 the `iam.serviceAccounts.getAccessToken` permission should be granted
 to Vertex AI Extension Service Agent
 (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)
 on the provided service account.
      string service_account = 2;
      Returns:
      The bytes for serviceAccount.

    • getOauthConfigCase

      AuthConfig.OauthConfig.OauthConfigCase getOauthConfigCase()