public static final class AuthConfig.OauthConfig.Builder extends GeneratedMessage.Builder<AuthConfig.OauthConfig.Builder> implements AuthConfig.OauthConfigOrBuilderConfig for user oauth.
Protobuf type google.cloud.aiplatform.v1beta1.AuthConfig.OauthConfig
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > AuthConfig.OauthConfig.BuilderImplements
AuthConfig.OauthConfigOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public AuthConfig.OauthConfig build()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
buildPartial()
public AuthConfig.OauthConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
clear()
public AuthConfig.OauthConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
|
clearAccessToken()
public AuthConfig.OauthConfig.Builder clearAccessToken()Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
string access_token = 1;
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
This builder for chaining. |
clearOauthConfig()
public AuthConfig.OauthConfig.Builder clearOauthConfig()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
|
clearServiceAccount()
public AuthConfig.OauthConfig.Builder clearServiceAccount()The service account used to generate access tokens for executing the Extension.
- If the service account is specified,
the
iam.serviceAccounts.getAccessTokenpermission 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 | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
This builder for chaining. |
getAccessToken()
public 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 | |
|---|---|
| Type | Description |
String |
The accessToken. |
getAccessTokenBytes()
public 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for accessToken. |
getDefaultInstanceForType()
public AuthConfig.OauthConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getOauthConfigCase()
public AuthConfig.OauthConfig.OauthConfigCase getOauthConfigCase()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.OauthConfigCase |
|
getServiceAccount()
public String getServiceAccount()The service account used to generate access tokens for executing the Extension.
- If the service account is specified,
the
iam.serviceAccounts.getAccessTokenpermission 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 | |
|---|---|
| Type | Description |
String |
The serviceAccount. |
getServiceAccountBytes()
public ByteString getServiceAccountBytes()The service account used to generate access tokens for executing the Extension.
- If the service account is specified,
the
iam.serviceAccounts.getAccessTokenpermission 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for serviceAccount. |
hasAccessToken()
public 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 | |
|---|---|
| Type | Description |
boolean |
Whether the accessToken field is set. |
hasServiceAccount()
public boolean hasServiceAccount()The service account used to generate access tokens for executing the Extension.
- If the service account is specified,
the
iam.serviceAccounts.getAccessTokenpermission 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 | |
|---|---|
| Type | Description |
boolean |
Whether the serviceAccount field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(AuthConfig.OauthConfig other)
public AuthConfig.OauthConfig.Builder mergeFrom(AuthConfig.OauthConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
AuthConfig.OauthConfig |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public AuthConfig.OauthConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public AuthConfig.OauthConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
|
setAccessToken(String value)
public AuthConfig.OauthConfig.Builder setAccessToken(String value)Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
string access_token = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe accessToken to set. |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
This builder for chaining. |
setAccessTokenBytes(ByteString value)
public AuthConfig.OauthConfig.Builder setAccessTokenBytes(ByteString value)Access token for extension endpoint. Only used to propagate token from [[ExecuteExtensionRequest.runtime_auth_config]] at request time.
string access_token = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for accessToken to set. |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
This builder for chaining. |
setServiceAccount(String value)
public AuthConfig.OauthConfig.Builder setServiceAccount(String value)The service account used to generate access tokens for executing the Extension.
- If the service account is specified,
the
iam.serviceAccounts.getAccessTokenpermission 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
This builder for chaining. |
setServiceAccountBytes(ByteString value)
public AuthConfig.OauthConfig.Builder setServiceAccountBytes(ByteString value)The service account used to generate access tokens for executing the Extension.
- If the service account is specified,
the
iam.serviceAccounts.getAccessTokenpermission 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for serviceAccount to set. |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
This builder for chaining. |