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.GeneratedMessageV3.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.GeneratedMessageV3.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 and Description
AuthConfig.OidcConfig.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AuthConfig.OidcConfig	build()
AuthConfig.OidcConfig	buildPartial()
AuthConfig.OidcConfig.Builder	clear()
AuthConfig.OidcConfig.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
AuthConfig.OidcConfig.Builder	clearIdToken() OpenID Connect formatted ID token for extension endpoint.
AuthConfig.OidcConfig.Builder	clearOidcConfig()
AuthConfig.OidcConfig.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
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.Builder	clone()
AuthConfig.OidcConfig	getDefaultInstanceForType()
static 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.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
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	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
AuthConfig.OidcConfig.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
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	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
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).
AuthConfig.OidcConfig.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

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

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, 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, newUninitializedMessageException

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

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

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

clone

public AuthConfig.OidcConfig.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<AuthConfig.OidcConfig.Builder>

setField

public AuthConfig.OidcConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<AuthConfig.OidcConfig.Builder>

clearField

public AuthConfig.OidcConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<AuthConfig.OidcConfig.Builder>

clearOneof

public AuthConfig.OidcConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<AuthConfig.OidcConfig.Builder>

setRepeatedField

public AuthConfig.OidcConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AuthConfig.OidcConfig.Builder>

addRepeatedField

public AuthConfig.OidcConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AuthConfig.OidcConfig.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.GeneratedMessageV3.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.

setUnknownFields

public final AuthConfig.OidcConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AuthConfig.OidcConfig.Builder>

mergeUnknownFields

public final AuthConfig.OidcConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AuthConfig.OidcConfig.Builder>