public static final class AuthConfig.OauthConfig extends GeneratedMessage implements AuthConfig.OauthConfigOrBuilderConfig for user oauth.
Protobuf type google.cloud.aiplatform.v1beta1.AuthConfig.OauthConfig
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > AuthConfig.OauthConfigImplements
AuthConfig.OauthConfigOrBuilderStatic Fields
ACCESS_TOKEN_FIELD_NUMBER
public static final int ACCESS_TOKEN_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SERVICE_ACCOUNT_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static AuthConfig.OauthConfig getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static AuthConfig.OauthConfig.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
|
newBuilder(AuthConfig.OauthConfig prototype)
public static AuthConfig.OauthConfig.Builder newBuilder(AuthConfig.OauthConfig prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
AuthConfig.OauthConfig |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
|
parseDelimitedFrom(InputStream input)
public static AuthConfig.OauthConfig parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AuthConfig.OauthConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static AuthConfig.OauthConfig parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AuthConfig.OauthConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static AuthConfig.OauthConfig parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AuthConfig.OauthConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static AuthConfig.OauthConfig parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AuthConfig.OauthConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static AuthConfig.OauthConfig parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AuthConfig.OauthConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static AuthConfig.OauthConfig parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AuthConfig.OauthConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<AuthConfig.OauthConfig> parser()| Returns | |
|---|---|
| Type | Description |
Parser<OauthConfig> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
getOauthConfigCase()
public AuthConfig.OauthConfig.OauthConfigCase getOauthConfigCase()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.OauthConfigCase |
|
getParserForType()
public Parser<AuthConfig.OauthConfig> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<OauthConfig> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public AuthConfig.OauthConfig.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected AuthConfig.OauthConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
|
toBuilder()
public AuthConfig.OauthConfig.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
AuthConfig.OauthConfig.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|