Class StartOAuthResponse (0.44.0)

public final class StartOAuthResponse extends GeneratedMessage implements StartOAuthResponseOrBuilder

Message for responding to starting an OAuth flow.

Protobuf type google.cloud.developerconnect.v1.StartOAuthResponse

Static Fields

AUTH_URI_FIELD_NUMBER

public static final int AUTH_URI_FIELD_NUMBER
Field Value
Type Description
int

CLIENT_ID_FIELD_NUMBER

public static final int CLIENT_ID_FIELD_NUMBER
Field Value
Type Description
int

CODE_CHALLENGE_FIELD_NUMBER

public static final int CODE_CHALLENGE_FIELD_NUMBER
Field Value
Type Description
int

CODE_CHALLENGE_METHOD_FIELD_NUMBER

public static final int CODE_CHALLENGE_METHOD_FIELD_NUMBER
Field Value
Type Description
int

SCOPES_FIELD_NUMBER

public static final int SCOPES_FIELD_NUMBER
Field Value
Type Description
int

SYSTEM_PROVIDER_ID_FIELD_NUMBER

public static final int SYSTEM_PROVIDER_ID_FIELD_NUMBER
Field Value
Type Description
int

TICKET_FIELD_NUMBER

public static final int TICKET_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StartOAuthResponse getDefaultInstance()
Returns
Type Description
StartOAuthResponse

getDescriptor()

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

newBuilder()

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

newBuilder(StartOAuthResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAuthUri()

public String getAuthUri()

The authorization server URL to the OAuth flow of the service provider.

string auth_uri = 6;

Returns
Type Description
String

The authUri.

getAuthUriBytes()

public ByteString getAuthUriBytes()

The authorization server URL to the OAuth flow of the service provider.

string auth_uri = 6;

Returns
Type Description
ByteString

The bytes for authUri.

getClientId()

public String getClientId()

The client ID to the OAuth App of the service provider.

string client_id = 4;

Returns
Type Description
String

The clientId.

getClientIdBytes()

public ByteString getClientIdBytes()

The client ID to the OAuth App of the service provider.

string client_id = 4;

Returns
Type Description
ByteString

The bytes for clientId.

getCodeChallenge()

public String getCodeChallenge()

Please refer to https://datatracker.ietf.org/doc/html/rfc7636#section-4.1

string code_challenge = 2;

Returns
Type Description
String

The codeChallenge.

getCodeChallengeBytes()

public ByteString getCodeChallengeBytes()

Please refer to https://datatracker.ietf.org/doc/html/rfc7636#section-4.1

string code_challenge = 2;

Returns
Type Description
ByteString

The bytes for codeChallenge.

getCodeChallengeMethod()

public String getCodeChallengeMethod()

Please refer to https://datatracker.ietf.org/doc/html/rfc7636#section-4.2

string code_challenge_method = 3;

Returns
Type Description
String

The codeChallengeMethod.

getCodeChallengeMethodBytes()

public ByteString getCodeChallengeMethodBytes()

Please refer to https://datatracker.ietf.org/doc/html/rfc7636#section-4.2

string code_challenge_method = 3;

Returns
Type Description
ByteString

The bytes for codeChallengeMethod.

getDefaultInstanceForType()

public StartOAuthResponse getDefaultInstanceForType()
Returns
Type Description
StartOAuthResponse

getIdCase()

public StartOAuthResponse.IdCase getIdCase()
Returns
Type Description
StartOAuthResponse.IdCase

getParserForType()

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

getScopes(int index)

public String getScopes(int index)

The list of scopes requested by the application.

repeated string scopes = 5;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The scopes at the given index.

getScopesBytes(int index)

public ByteString getScopesBytes(int index)

The list of scopes requested by the application.

repeated string scopes = 5;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the scopes at the given index.

getScopesCount()

public int getScopesCount()

The list of scopes requested by the application.

repeated string scopes = 5;

Returns
Type Description
int

The count of scopes.

getScopesList()

public ProtocolStringList getScopesList()

The list of scopes requested by the application.

repeated string scopes = 5;

Returns
Type Description
ProtocolStringList

A list containing the scopes.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSystemProviderId()

public SystemProvider getSystemProviderId()

The ID of the system provider.

.google.cloud.developerconnect.v1.SystemProvider system_provider_id = 7;

Returns
Type Description
SystemProvider

The systemProviderId.

getSystemProviderIdValue()

public int getSystemProviderIdValue()

The ID of the system provider.

.google.cloud.developerconnect.v1.SystemProvider system_provider_id = 7;

Returns
Type Description
int

The enum numeric value on the wire for systemProviderId.

getTicket()

public String getTicket()

The ticket to be used for post processing the callback from the service provider.

string ticket = 1;

Returns
Type Description
String

The ticket.

getTicketBytes()

public ByteString getTicketBytes()

The ticket to be used for post processing the callback from the service provider.

string ticket = 1;

Returns
Type Description
ByteString

The bytes for ticket.

hasSystemProviderId()

public boolean hasSystemProviderId()

The ID of the system provider.

.google.cloud.developerconnect.v1.SystemProvider system_provider_id = 7;

Returns
Type Description
boolean

Whether the systemProviderId field is set.

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 StartOAuthResponse.Builder newBuilderForType()
Returns
Type Description
StartOAuthResponse.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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