Package com.google.cloud.aiplatform.v1beta1

Class AuthConfig.OidcConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<AuthConfig.OidcConfig.Builder>
com.google.cloud.aiplatform.v1beta1.AuthConfig.OidcConfig.Builder
All Implemented Interfaces:
AuthConfig.OidcConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
AuthConfig.OidcConfig
public static final class AuthConfig.OidcConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<AuthConfig.OidcConfig.Builder> implements AuthConfig.OidcConfigOrBuilder
 Config for user OIDC auth.
Protobuf type google.cloud.aiplatform.v1beta1.AuthConfig.OidcConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    AuthConfig.OidcConfig
    build()
     
    AuthConfig.OidcConfig
    buildPartial()
     
    AuthConfig.OidcConfig.Builder
    clear()
     
    AuthConfig.OidcConfig.Builder
    clearIdToken()
    OpenID Connect formatted ID token for extension endpoint.
    AuthConfig.OidcConfig.Builder
    clearOidcConfig()
     
    AuthConfig.OidcConfig.Builder
    clearServiceAccount()
    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)
    AuthConfig.OidcConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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)
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    AuthConfig.OidcConfig.Builder
    mergeFrom(AuthConfig.OidcConfig other)
     
    AuthConfig.OidcConfig.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    AuthConfig.OidcConfig.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    AuthConfig.OidcConfig.Builder
    setIdToken(String value)
    OpenID Connect formatted ID token for extension endpoint.
    AuthConfig.OidcConfig.Builder
    setIdTokenBytes(com.google.protobuf.ByteString value)
    OpenID Connect formatted ID token for extension endpoint.
    AuthConfig.OidcConfig.Builder
    setServiceAccount(String value)
    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)
    AuthConfig.OidcConfig.Builder
    setServiceAccountBytes(com.google.protobuf.ByteString value)
    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 class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<AuthConfig.OidcConfig.Builder>

    • clear

      public AuthConfig.OidcConfig.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<AuthConfig.OidcConfig.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<AuthConfig.OidcConfig.Builder>

    • getDefaultInstanceForType

      public AuthConfig.OidcConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public AuthConfig.OidcConfig build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public AuthConfig.OidcConfig buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public AuthConfig.OidcConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AuthConfig.OidcConfig.Builder>

    • mergeFrom

      public AuthConfig.OidcConfig.Builder mergeFrom(AuthConfig.OidcConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<AuthConfig.OidcConfig.Builder>

    • mergeFrom

      public AuthConfig.OidcConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AuthConfig.OidcConfig.Builder>
      Throws:
      IOException

    • getOidcConfigCase

      public AuthConfig.OidcConfig.OidcConfigCase getOidcConfigCase()
      Specified by:
      getOidcConfigCase in interface AuthConfig.OidcConfigOrBuilder

    • clearOidcConfig

      public AuthConfig.OidcConfig.Builder clearOidcConfig()

    • hasIdToken

      public 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;
      Specified by:
      hasIdToken in interface AuthConfig.OidcConfigOrBuilder
      Returns:
      Whether the idToken field is set.

    • getIdToken

      public 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;
      Specified by:
      getIdToken in interface AuthConfig.OidcConfigOrBuilder
      Returns:
      The idToken.

    • getIdTokenBytes

      public 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;
      Specified by:
      getIdTokenBytes in interface AuthConfig.OidcConfigOrBuilder
      Returns:
      The bytes for idToken.

    • setIdToken

      public AuthConfig.OidcConfig.Builder setIdToken(String value)
       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;
      Parameters:
      value - The idToken to set.
      Returns:
      This builder for chaining.

    • clearIdToken

      public AuthConfig.OidcConfig.Builder clearIdToken()
       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:
      This builder for chaining.

    • setIdTokenBytes

      public AuthConfig.OidcConfig.Builder setIdTokenBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for idToken to set.
      Returns:
      This builder for chaining.

    • hasServiceAccount

      public 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;
      Specified by:
      hasServiceAccount in interface AuthConfig.OidcConfigOrBuilder
      Returns:
      Whether the serviceAccount field is set.

    • getServiceAccount

      public 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;
      Specified by:
      getServiceAccount in interface AuthConfig.OidcConfigOrBuilder
      Returns:
      The serviceAccount.

    • getServiceAccountBytes

      public 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;
      Specified by:
      getServiceAccountBytes in interface AuthConfig.OidcConfigOrBuilder
      Returns:
      The bytes for serviceAccount.

    • setServiceAccount

      public AuthConfig.OidcConfig.Builder setServiceAccount(String value)
       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;
      Parameters:
      value - The serviceAccount to set.
      Returns:
      This builder for chaining.

    • clearServiceAccount

      public AuthConfig.OidcConfig.Builder clearServiceAccount()
       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:
      This builder for chaining.

    • setServiceAccountBytes

      public AuthConfig.OidcConfig.Builder setServiceAccountBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for serviceAccount to set.
      Returns:
      This builder for chaining.