Class OAuthSettings (0.10.0) 

public final class OAuthSettings extends GeneratedMessageV3 implements OAuthSettingsOrBuilder

Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials.

Protobuf type google.cloud.iap.v1.OAuthSettings

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > OAuthSettings

Static Fields

LOGIN_HINT_FIELD_NUMBER

public static final int LOGIN_HINT_FIELD_NUMBER
Field Value
Type Description
int

PROGRAMMATIC_CLIENTS_FIELD_NUMBER

public static final int PROGRAMMATIC_CLIENTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OAuthSettings getDefaultInstance()
Returns
Type Description
OAuthSettings

getDescriptor()

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

newBuilder()

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

newBuilder(OAuthSettings prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public OAuthSettings getDefaultInstanceForType()
Returns
Type Description
OAuthSettings

getLoginHint()

public StringValue getLoginHint()

Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by skipping Google's login screen. https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not verify that the id token's hd claim matches this value since access behavior is managed by IAM policies.

.google.protobuf.StringValue login_hint = 2;

Returns
Type Description
StringValue

The loginHint.

getLoginHintOrBuilder()

public StringValueOrBuilder getLoginHintOrBuilder()

Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by skipping Google's login screen. https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not verify that the id token's hd claim matches this value since access behavior is managed by IAM policies.

.google.protobuf.StringValue login_hint = 2;

Returns
Type Description
StringValueOrBuilder

getParserForType()

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

getProgrammaticClients(int index)

public String getProgrammaticClients(int index)

List of OAuth client IDs allowed to programmatically authenticate with IAP.

repeated string programmatic_clients = 5;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The programmaticClients at the given index.

getProgrammaticClientsBytes(int index)

public ByteString getProgrammaticClientsBytes(int index)

List of OAuth client IDs allowed to programmatically authenticate with IAP.

repeated string programmatic_clients = 5;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the programmaticClients at the given index.

getProgrammaticClientsCount()

public int getProgrammaticClientsCount()

List of OAuth client IDs allowed to programmatically authenticate with IAP.

repeated string programmatic_clients = 5;

Returns
Type Description
int

The count of programmaticClients.

getProgrammaticClientsList()

public ProtocolStringList getProgrammaticClientsList()

List of OAuth client IDs allowed to programmatically authenticate with IAP.

repeated string programmatic_clients = 5;

Returns
Type Description
ProtocolStringList

A list containing the programmaticClients.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasLoginHint()

public boolean hasLoginHint()

Domain hint to send as hd=? parameter in OAuth request flow. Enables redirect to primary IDP by skipping Google's login screen. https://developers.google.com/identity/protocols/OpenIDConnect#hd-param Note: IAP does not verify that the id token's hd claim matches this value since access behavior is managed by IAM policies.

.google.protobuf.StringValue login_hint = 2;

Returns
Type Description
boolean

Whether the loginHint field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OAuthSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
OAuthSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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