- 3.52.0 (latest)
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class AuthConfig.OidcConfig.Builder extends GeneratedMessageV3.Builder<AuthConfig.OidcConfig.Builder> implements AuthConfig.OidcConfigOrBuilderConfig for user OIDC auth.
Protobuf type google.cloud.aiplatform.v1beta1.AuthConfig.OidcConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AuthConfig.OidcConfig.BuilderImplements
AuthConfig.OidcConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AuthConfig.OidcConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
|
build()
public AuthConfig.OidcConfig build()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig |
|
buildPartial()
public AuthConfig.OidcConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig |
|
clear()
public AuthConfig.OidcConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public AuthConfig.OidcConfig.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
|
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 | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
This builder for chaining. |
clearOidcConfig()
public AuthConfig.OidcConfig.Builder clearOidcConfig()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public AuthConfig.OidcConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
|
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.getOpenIdTokenpermission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
string service_account = 2;
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
This builder for chaining. |
clone()
public AuthConfig.OidcConfig.Builder clone()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
|
getDefaultInstanceForType()
public AuthConfig.OidcConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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;
| Returns | |
|---|---|
| Type | Description |
String |
The idToken. |
getIdTokenBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for idToken. |
getOidcConfigCase()
public AuthConfig.OidcConfig.OidcConfigCase getOidcConfigCase()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.OidcConfigCase |
|
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.getOpenIdTokenpermission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
string service_account = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The serviceAccount. |
getServiceAccountBytes()
public 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.getOpenIdTokenpermission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
string service_account = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for serviceAccount. |
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the idToken field is set. |
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.getOpenIdTokenpermission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
string service_account = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the serviceAccount field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(AuthConfig.OidcConfig other)
public AuthConfig.OidcConfig.Builder mergeFrom(AuthConfig.OidcConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
AuthConfig.OidcConfig |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AuthConfig.OidcConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public AuthConfig.OidcConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AuthConfig.OidcConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public AuthConfig.OidcConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
|
setIdToken(String value)
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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe idToken to set. |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
This builder for chaining. |
setIdTokenBytes(ByteString value)
public AuthConfig.OidcConfig.Builder setIdTokenBytes(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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for idToken to set. |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AuthConfig.OidcConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
|
setServiceAccount(String value)
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.getOpenIdTokenpermission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
string service_account = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
This builder for chaining. |
setServiceAccountBytes(ByteString value)
public AuthConfig.OidcConfig.Builder setServiceAccountBytes(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.getOpenIdTokenpermission to Vertex AI Extension Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).
string service_account = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final AuthConfig.OidcConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OidcConfig.Builder |
|