Class ThreeLeggedOAuth.Builder (0.1.0)

public static final class ThreeLeggedOAuth.Builder extends GeneratedMessage.Builder<ThreeLeggedOAuth.Builder> implements ThreeLeggedOAuthOrBuilder

Message describing ThreeLeggedOAuth object.

Protobuf type google.cloud.agentidentity.v1beta.ThreeLeggedOAuth

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > ThreeLeggedOAuth.Builder

Implements

ThreeLeggedOAuthOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public ThreeLeggedOAuth build()

Returns
Type	Description
ThreeLeggedOAuth

buildPartial()

public ThreeLeggedOAuth buildPartial()

Returns
Type	Description
ThreeLeggedOAuth

clear()

public ThreeLeggedOAuth.Builder clear()

Returns
Type	Description
ThreeLeggedOAuth.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAuthorizationUrl()

public ThreeLeggedOAuth.Builder clearAuthorizationUrl()

Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.example.com/authorize"

string authorization_url = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

clearClientId()

public ThreeLeggedOAuth.Builder clearClientId()

Optional. The client ID of the OAuth client.

string client_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

clearClientSecret()

public ThreeLeggedOAuth.Builder clearClientSecret()

Optional. Input only. The client secret of the OAuth client.

string client_secret = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

clearDefaultContinueUri()

public ThreeLeggedOAuth.Builder clearDefaultContinueUri()

Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.

string default_continue_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

clearEnablePkce()

public ThreeLeggedOAuth.Builder clearEnablePkce()

Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.

bool enable_pkce = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

clearRedirectUrl()

public ThreeLeggedOAuth.Builder clearRedirectUrl()

Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.

string redirect_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

clearTokenUrl()

public ThreeLeggedOAuth.Builder clearTokenUrl()

Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.example.com/oauth/token"

string token_url = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

getAuthorizationUrl()

public String getAuthorizationUrl()

Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.example.com/authorize"

string authorization_url = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The authorizationUrl.

getAuthorizationUrlBytes()

public ByteString getAuthorizationUrlBytes()

Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.example.com/authorize"

string authorization_url = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for authorizationUrl.

getClientId()

public String getClientId()

Optional. The client ID of the OAuth client.

string client_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The clientId.

getClientIdBytes()

public ByteString getClientIdBytes()

Optional. The client ID of the OAuth client.

string client_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for clientId.

getClientSecret()

public String getClientSecret()

Optional. Input only. The client secret of the OAuth client.

string client_secret = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
String	The clientSecret.

getClientSecretBytes()

public ByteString getClientSecretBytes()

Optional. Input only. The client secret of the OAuth client.

string client_secret = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for clientSecret.

getDefaultContinueUri()

public String getDefaultContinueUri()

Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.

string default_continue_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The defaultContinueUri.

getDefaultContinueUriBytes()

public ByteString getDefaultContinueUriBytes()

Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.

string default_continue_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for defaultContinueUri.

getDefaultInstanceForType()

public ThreeLeggedOAuth getDefaultInstanceForType()

Returns
Type	Description
ThreeLeggedOAuth

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getEnablePkce()

public boolean getEnablePkce()

Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.

bool enable_pkce = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The enablePkce.

getRedirectUrl()

public String getRedirectUrl()

Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.

string redirect_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The redirectUrl.

getRedirectUrlBytes()

public ByteString getRedirectUrlBytes()

Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.

string redirect_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for redirectUrl.

getTokenUrl()

public String getTokenUrl()

Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.example.com/oauth/token"

string token_url = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The tokenUrl.

getTokenUrlBytes()

public ByteString getTokenUrlBytes()

Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.example.com/oauth/token"

string token_url = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for tokenUrl.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(ThreeLeggedOAuth other)

public ThreeLeggedOAuth.Builder mergeFrom(ThreeLeggedOAuth other)

Parameter
Name	Description
other	ThreeLeggedOAuth

Returns
Type	Description
ThreeLeggedOAuth.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ThreeLeggedOAuth.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ThreeLeggedOAuth.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ThreeLeggedOAuth.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ThreeLeggedOAuth.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setAuthorizationUrl(String value)

public ThreeLeggedOAuth.Builder setAuthorizationUrl(String value)

Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.example.com/authorize"

string authorization_url = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The authorizationUrl to set.

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

setAuthorizationUrlBytes(ByteString value)

public ThreeLeggedOAuth.Builder setAuthorizationUrlBytes(ByteString value)

Optional. The authorization endpoint to send users to for consenting to delegate to the agent. eg. "https://auth.example.com/authorize"

string authorization_url = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for authorizationUrl to set.

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

setClientId(String value)

public ThreeLeggedOAuth.Builder setClientId(String value)

Optional. The client ID of the OAuth client.

string client_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The clientId to set.

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

setClientIdBytes(ByteString value)

public ThreeLeggedOAuth.Builder setClientIdBytes(ByteString value)

Optional. The client ID of the OAuth client.

string client_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for clientId to set.

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

setClientSecret(String value)

public ThreeLeggedOAuth.Builder setClientSecret(String value)

Optional. Input only. The client secret of the OAuth client.

string client_secret = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
value	String The clientSecret to set.

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

setClientSecretBytes(ByteString value)

public ThreeLeggedOAuth.Builder setClientSecretBytes(ByteString value)

Optional. Input only. The client secret of the OAuth client.

string client_secret = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_behavior) = INPUT_ONLY];

Parameter
Name	Description
value	ByteString The bytes for clientSecret to set.

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

setDefaultContinueUri(String value)

public ThreeLeggedOAuth.Builder setDefaultContinueUri(String value)

Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.

string default_continue_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The defaultContinueUri to set.

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

setDefaultContinueUriBytes(ByteString value)

public ThreeLeggedOAuth.Builder setDefaultContinueUriBytes(ByteString value)

Optional. The default continue URI for 3LO flow and it will be used when no continue URI is provided in the RetrieveCredentials request.

string default_continue_uri = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for defaultContinueUri to set.

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

setEnablePkce(boolean value)

public ThreeLeggedOAuth.Builder setEnablePkce(boolean value)

Optional. Enables Proof Key for Code Exchange (PKCE) for the OAuth flow to prevent authorization code interception attacks.

bool enable_pkce = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The enablePkce to set.

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

setRedirectUrl(String value)

public ThreeLeggedOAuth.Builder setRedirectUrl(String value)

Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.

string redirect_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	String The redirectUrl to set.

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

setRedirectUrlBytes(ByteString value)

public ThreeLeggedOAuth.Builder setRedirectUrlBytes(ByteString value)

Output only. The redirect URL this auth_provider uses for the OAuth exchange. This is deterministic based on the name of the auth_provider.

string redirect_url = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	ByteString The bytes for redirectUrl to set.

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

setTokenUrl(String value)

public ThreeLeggedOAuth.Builder setTokenUrl(String value)

Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.example.com/oauth/token"

string token_url = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The tokenUrl to set.

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.

setTokenUrlBytes(ByteString value)

public ThreeLeggedOAuth.Builder setTokenUrlBytes(ByteString value)

Optional. The token endpoint for requesting tokens on behalf of an end user. eg. "https://auth.example.com/oauth/token"

string token_url = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for tokenUrl to set.

Returns
Type	Description
ThreeLeggedOAuth.Builder	This builder for chaining.