Class ThreeLeggedOAuth (0.1.0)

public final class ThreeLeggedOAuth extends GeneratedMessage implements ThreeLeggedOAuthOrBuilder

Message describing ThreeLeggedOAuth object.

Protobuf type google.cloud.agentidentity.v1beta.ThreeLeggedOAuth

Static Fields

AUTHORIZATION_URL_FIELD_NUMBER

public static final int AUTHORIZATION_URL_FIELD_NUMBER
Field Value
Type Description
int

CLIENT_ID_FIELD_NUMBER

public static final int CLIENT_ID_FIELD_NUMBER
Field Value
Type Description
int

CLIENT_SECRET_FIELD_NUMBER

public static final int CLIENT_SECRET_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_CONTINUE_URI_FIELD_NUMBER

public static final int DEFAULT_CONTINUE_URI_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_PKCE_FIELD_NUMBER

public static final int ENABLE_PKCE_FIELD_NUMBER
Field Value
Type Description
int

REDIRECT_URL_FIELD_NUMBER

public static final int REDIRECT_URL_FIELD_NUMBER
Field Value
Type Description
int

TOKEN_URL_FIELD_NUMBER

public static final int TOKEN_URL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ThreeLeggedOAuth getDefaultInstance()
Returns
Type Description
ThreeLeggedOAuth

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ThreeLeggedOAuth.Builder newBuilder()
Returns
Type Description
ThreeLeggedOAuth.Builder

newBuilder(ThreeLeggedOAuth prototype)

public static ThreeLeggedOAuth.Builder newBuilder(ThreeLeggedOAuth prototype)
Parameter
Name Description
prototype ThreeLeggedOAuth
Returns
Type Description
ThreeLeggedOAuth.Builder

parseDelimitedFrom(InputStream input)

public static ThreeLeggedOAuth parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ThreeLeggedOAuth
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ThreeLeggedOAuth parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ThreeLeggedOAuth
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ThreeLeggedOAuth parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ThreeLeggedOAuth
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ThreeLeggedOAuth parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ThreeLeggedOAuth
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ThreeLeggedOAuth parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ThreeLeggedOAuth
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ThreeLeggedOAuth parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ThreeLeggedOAuth
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ThreeLeggedOAuth parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ThreeLeggedOAuth
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ThreeLeggedOAuth parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ThreeLeggedOAuth
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ThreeLeggedOAuth parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ThreeLeggedOAuth
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ThreeLeggedOAuth parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ThreeLeggedOAuth
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ThreeLeggedOAuth parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ThreeLeggedOAuth
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ThreeLeggedOAuth parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ThreeLeggedOAuth
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ThreeLeggedOAuth> parser()
Returns
Type Description
Parser<ThreeLeggedOAuth>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

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.

getParserForType()

public Parser<ThreeLeggedOAuth> getParserForType()
Returns
Type Description
Parser<ThreeLeggedOAuth>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ThreeLeggedOAuth.Builder newBuilderForType()
Returns
Type Description
ThreeLeggedOAuth.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ThreeLeggedOAuth.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ThreeLeggedOAuth.Builder
Overrides

toBuilder()

public ThreeLeggedOAuth.Builder toBuilder()
Returns
Type Description
ThreeLeggedOAuth.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException