Package com.google.cloud.aiplatform.v1beta1

Class AuthConfig.OidcConfig

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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    AuthConfig.OidcConfig.Builder
    Config for user OIDC auth.
    static enum 
    AuthConfig.OidcConfig.OidcConfigCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ID_TOKEN_FIELD_NUMBER
     
    static final int
    SERVICE_ACCOUNT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static AuthConfig.OidcConfig
    getDefaultInstance()
     
    AuthConfig.OidcConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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()
     
    com.google.protobuf.Parser<AuthConfig.OidcConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    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)
    int
    hashCode()
     
    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()
     
    static AuthConfig.OidcConfig.Builder
    newBuilder()
     
    static AuthConfig.OidcConfig.Builder
    newBuilder(AuthConfig.OidcConfig prototype)
     
    AuthConfig.OidcConfig.Builder
    newBuilderForType()
     
    protected AuthConfig.OidcConfig.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static AuthConfig.OidcConfig
    parseDelimitedFrom(InputStream input)
     
    static AuthConfig.OidcConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthConfig.OidcConfig
    parseFrom(byte[] data)
     
    static AuthConfig.OidcConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthConfig.OidcConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static AuthConfig.OidcConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthConfig.OidcConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static AuthConfig.OidcConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthConfig.OidcConfig
    parseFrom(InputStream input)
     
    static AuthConfig.OidcConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static AuthConfig.OidcConfig
    parseFrom(ByteBuffer data)
     
    static AuthConfig.OidcConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AuthConfig.OidcConfig>
    parser()
     
    AuthConfig.OidcConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • ID_TOKEN_FIELD_NUMBER

      public static final int ID_TOKEN_FIELD_NUMBER
      See Also:

    • SERVICE_ACCOUNT_FIELD_NUMBER

      public static final int SERVICE_ACCOUNT_FIELD_NUMBER
      See Also:

  • 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

    • getOidcConfigCase

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

    • 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.

    • 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.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static AuthConfig.OidcConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AuthConfig.OidcConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AuthConfig.OidcConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AuthConfig.OidcConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AuthConfig.OidcConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AuthConfig.OidcConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AuthConfig.OidcConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AuthConfig.OidcConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AuthConfig.OidcConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AuthConfig.OidcConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AuthConfig.OidcConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AuthConfig.OidcConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static AuthConfig.OidcConfig.Builder newBuilder()

    • newBuilder

      public static AuthConfig.OidcConfig.Builder newBuilder(AuthConfig.OidcConfig prototype)

    • toBuilder

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

    • newBuilderForType

      protected AuthConfig.OidcConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AuthConfig.OidcConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AuthConfig.OidcConfig> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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