Class OAuthSettings.Builder (0.5.0)

Version 0.5.0

• 0.9.0 (latest)
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class OAuthSettings.Builder extends GeneratedMessageV3.Builder<OAuthSettings.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > OAuthSettings.Builder

Implements

OAuthSettingsOrBuilder

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)

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

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

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

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

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

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

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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

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

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(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

addAllProgrammaticClients(Iterable<String> values)

public OAuthSettings.Builder addAllProgrammaticClients(Iterable<String> values)

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

repeated string programmatic_clients = 5;

Parameter
Name	Description
values	Iterable<String> The programmaticClients to add.

Returns
Type	Description
OAuthSettings.Builder	This builder for chaining.

addProgrammaticClients(String value)

public OAuthSettings.Builder addProgrammaticClients(String value)

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

repeated string programmatic_clients = 5;

Parameter
Name	Description
value	String The programmaticClients to add.

Returns
Type	Description
OAuthSettings.Builder	This builder for chaining.

addProgrammaticClientsBytes(ByteString value)

public OAuthSettings.Builder addProgrammaticClientsBytes(ByteString value)

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

repeated string programmatic_clients = 5;

Parameter
Name	Description
value	ByteString The bytes of the programmaticClients to add.

Returns
Type	Description
OAuthSettings.Builder	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public OAuthSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
OAuthSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public OAuthSettings build()

Returns
Type	Description
OAuthSettings

buildPartial()

public OAuthSettings buildPartial()

Returns
Type	Description
OAuthSettings

clear()

public OAuthSettings.Builder clear()

Returns
Type	Description
OAuthSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public OAuthSettings.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
OAuthSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLoginHint()

public OAuthSettings.Builder clearLoginHint()

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
OAuthSettings.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public OAuthSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
OAuthSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearProgrammaticClients()

public OAuthSettings.Builder clearProgrammaticClients()

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

repeated string programmatic_clients = 5;

Returns
Type	Description
OAuthSettings.Builder	This builder for chaining.

clone()

public OAuthSettings.Builder clone()

Returns
Type	Description
OAuthSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public OAuthSettings getDefaultInstanceForType()

Returns
Type	Description
OAuthSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getLoginHintBuilder()

public StringValue.Builder getLoginHintBuilder()

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
Builder

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

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(OAuthSettings other)

public OAuthSettings.Builder mergeFrom(OAuthSettings other)

Parameter
Name	Description
other	OAuthSettings

Returns
Type	Description
OAuthSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
OAuthSettings.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public OAuthSettings.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
OAuthSettings.Builder

Overrides

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

mergeLoginHint(StringValue value)

public OAuthSettings.Builder mergeLoginHint(StringValue value)

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;

Parameter
Name	Description
value	StringValue

Returns
Type	Description
OAuthSettings.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OAuthSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
OAuthSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public OAuthSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
OAuthSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setLoginHint(StringValue value)

public OAuthSettings.Builder setLoginHint(StringValue value)

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;

Parameter
Name	Description
value	StringValue

Returns
Type	Description
OAuthSettings.Builder

setLoginHint(StringValue.Builder builderForValue)

public OAuthSettings.Builder setLoginHint(StringValue.Builder builderForValue)

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;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
OAuthSettings.Builder

setProgrammaticClients(int index, String value)

public OAuthSettings.Builder setProgrammaticClients(int index, String value)

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

repeated string programmatic_clients = 5;

Parameters
Name	Description
index	int The index to set the value at.
value	String The programmaticClients to set.

Returns
Type	Description
OAuthSettings.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public OAuthSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
OAuthSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final OAuthSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
OAuthSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)