Class StartOAuthResponse.Builder (0.44.0)

public static final class StartOAuthResponse.Builder extends GeneratedMessage.Builder<StartOAuthResponse.Builder> implements StartOAuthResponseOrBuilder

Message for responding to starting an OAuth flow.

Protobuf type google.cloud.developerconnect.v1.StartOAuthResponse

Static Methods

getDescriptor()

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

Methods

addAllScopes(Iterable<String> values)

public StartOAuthResponse.Builder addAllScopes(Iterable<String> values)

The list of scopes requested by the application.

repeated string scopes = 5;

Parameter
Name Description
values Iterable<String>

The scopes to add.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

addScopes(String value)

public StartOAuthResponse.Builder addScopes(String value)

The list of scopes requested by the application.

repeated string scopes = 5;

Parameter
Name Description
value String

The scopes to add.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

addScopesBytes(ByteString value)

public StartOAuthResponse.Builder addScopesBytes(ByteString value)

The list of scopes requested by the application.

repeated string scopes = 5;

Parameter
Name Description
value ByteString

The bytes of the scopes to add.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

build()

public StartOAuthResponse build()
Returns
Type Description
StartOAuthResponse

buildPartial()

public StartOAuthResponse buildPartial()
Returns
Type Description
StartOAuthResponse

clear()

public StartOAuthResponse.Builder clear()
Returns
Type Description
StartOAuthResponse.Builder
Overrides

clearAuthUri()

public StartOAuthResponse.Builder clearAuthUri()

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

string auth_uri = 6;

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

clearClientId()

public StartOAuthResponse.Builder clearClientId()

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

string client_id = 4;

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

clearCodeChallenge()

public StartOAuthResponse.Builder clearCodeChallenge()

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

string code_challenge = 2;

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

clearCodeChallengeMethod()

public StartOAuthResponse.Builder clearCodeChallengeMethod()

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

string code_challenge_method = 3;

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

clearId()

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

clearScopes()

public StartOAuthResponse.Builder clearScopes()

The list of scopes requested by the application.

repeated string scopes = 5;

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

clearSystemProviderId()

public StartOAuthResponse.Builder clearSystemProviderId()

The ID of the system provider.

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

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

clearTicket()

public StartOAuthResponse.Builder clearTicket()

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

string ticket = 1;

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getIdCase()

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

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(StartOAuthResponse other)

public StartOAuthResponse.Builder mergeFrom(StartOAuthResponse other)
Parameter
Name Description
other StartOAuthResponse
Returns
Type Description
StartOAuthResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StartOAuthResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StartOAuthResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public StartOAuthResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
StartOAuthResponse.Builder
Overrides

setAuthUri(String value)

public StartOAuthResponse.Builder setAuthUri(String value)

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

string auth_uri = 6;

Parameter
Name Description
value String

The authUri to set.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

setAuthUriBytes(ByteString value)

public StartOAuthResponse.Builder setAuthUriBytes(ByteString value)

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

string auth_uri = 6;

Parameter
Name Description
value ByteString

The bytes for authUri to set.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

setClientId(String value)

public StartOAuthResponse.Builder setClientId(String value)

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

string client_id = 4;

Parameter
Name Description
value String

The clientId to set.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

setClientIdBytes(ByteString value)

public StartOAuthResponse.Builder setClientIdBytes(ByteString value)

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

string client_id = 4;

Parameter
Name Description
value ByteString

The bytes for clientId to set.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

setCodeChallenge(String value)

public StartOAuthResponse.Builder setCodeChallenge(String value)

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

string code_challenge = 2;

Parameter
Name Description
value String

The codeChallenge to set.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

setCodeChallengeBytes(ByteString value)

public StartOAuthResponse.Builder setCodeChallengeBytes(ByteString value)

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

string code_challenge = 2;

Parameter
Name Description
value ByteString

The bytes for codeChallenge to set.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

setCodeChallengeMethod(String value)

public StartOAuthResponse.Builder setCodeChallengeMethod(String value)

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

string code_challenge_method = 3;

Parameter
Name Description
value String

The codeChallengeMethod to set.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

setCodeChallengeMethodBytes(ByteString value)

public StartOAuthResponse.Builder setCodeChallengeMethodBytes(ByteString value)

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

string code_challenge_method = 3;

Parameter
Name Description
value ByteString

The bytes for codeChallengeMethod to set.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

setScopes(int index, String value)

public StartOAuthResponse.Builder setScopes(int index, String value)

The list of scopes requested by the application.

repeated string scopes = 5;

Parameters
Name Description
index int

The index to set the value at.

value String

The scopes to set.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

setSystemProviderId(SystemProvider value)

public StartOAuthResponse.Builder setSystemProviderId(SystemProvider value)

The ID of the system provider.

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

Parameter
Name Description
value SystemProvider

The systemProviderId to set.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

setSystemProviderIdValue(int value)

public StartOAuthResponse.Builder setSystemProviderIdValue(int value)

The ID of the system provider.

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

Parameter
Name Description
value int

The enum numeric value on the wire for systemProviderId to set.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

setTicket(String value)

public StartOAuthResponse.Builder setTicket(String value)

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

string ticket = 1;

Parameter
Name Description
value String

The ticket to set.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.

setTicketBytes(ByteString value)

public StartOAuthResponse.Builder setTicketBytes(ByteString value)

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

string ticket = 1;

Parameter
Name Description
value ByteString

The bytes for ticket to set.

Returns
Type Description
StartOAuthResponse.Builder

This builder for chaining.