Class OAuthSettings (0.44.0)

public final class OAuthSettings extends GeneratedMessage 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 > GeneratedMessage > OAuthSettings

Implements

OAuthSettingsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

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`

CLIENT_SECRET_SHA256_FIELD_NUMBER

public static final int CLIENT_SECRET_SHA256_FIELD_NUMBER

Field Value
Type	Description
`int`

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

AbstractMessage.equals(Object other)

getClientId()

public StringValue getClientId()

Optional. OAuth 2.0 client ID used in the OAuth flow. This allows for client sharing. The risks of client sharing are outlined here: https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.

.google.protobuf.StringValue client_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`StringValue`	The clientId.

getClientIdOrBuilder()

public StringValueOrBuilder getClientIdOrBuilder()

Optional. OAuth 2.0 client ID used in the OAuth flow. This allows for client sharing. The risks of client sharing are outlined here: https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.

.google.protobuf.StringValue client_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`StringValueOrBuilder`

getClientSecret()

public StringValue getClientSecret()

Optional. Input only. OAuth secret paired with client ID.

.google.protobuf.StringValue client_secret = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`StringValue`	The clientSecret.

getClientSecretOrBuilder()

public StringValueOrBuilder getClientSecretOrBuilder()

Optional. Input only. OAuth secret paired with client ID.

.google.protobuf.StringValue client_secret = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`StringValueOrBuilder`

getClientSecretSha256()

public StringValue getClientSecretSha256()

Output only. OAuth secret SHA256 paired with client ID.

.google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`StringValue`	The clientSecretSha256.

getClientSecretSha256OrBuilder()

public StringValueOrBuilder getClientSecretSha256OrBuilder()

Output only. OAuth secret SHA256 paired with client ID.

.google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`StringValueOrBuilder`

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()

.google.protobuf.StringValue login_hint = 2;

Returns
Type	Description
`StringValueOrBuilder`

getParserForType()

public Parser<OAuthSettings> getParserForType()

Returns
Type	Description
`Parser<OAuthSettings>`

Overrides

GeneratedMessage.getParserForType()

getProgrammaticClients(int index)

public String getProgrammaticClients(int index)

Optional. List of client ids allowed to use IAP programmatically.

repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];

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)

Optional. List of client ids allowed to use IAP programmatically.

repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];

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()

Optional. List of client ids allowed to use IAP programmatically.

repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The count of programmaticClients.

getProgrammaticClientsList()

public ProtocolStringList getProgrammaticClientsList()

Optional. List of client ids allowed to use IAP programmatically.

repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ProtocolStringList`	A list containing the programmaticClients.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

hasClientId()

public boolean hasClientId()

Optional. OAuth 2.0 client ID used in the OAuth flow. This allows for client sharing. The risks of client sharing are outlined here: https://cloud.google.com/iap/docs/sharing-oauth-clients#risks.

.google.protobuf.StringValue client_id = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the clientId field is set.

hasClientSecret()

public boolean hasClientSecret()

Optional. Input only. OAuth secret paired with client ID.

.google.protobuf.StringValue client_secret = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the clientSecret field is set.

hasClientSecretSha256()

public boolean hasClientSecretSha256()

Output only. OAuth secret SHA256 paired with client ID.

.google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the clientSecretSha256 field is set.

hasLoginHint()

public boolean hasLoginHint()

.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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public OAuthSettings.Builder newBuilderForType()

Returns
Type	Description
`OAuthSettings.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected OAuthSettings.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`OAuthSettings.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public OAuthSettings.Builder toBuilder()

Returns
Type	Description
`OAuthSettings.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`

Class OAuthSettings (0.44.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Implements

Inherited Members

Static Fields

CLIENT_ID_FIELD_NUMBER

CLIENT_SECRET_FIELD_NUMBER

CLIENT_SECRET_SHA256_FIELD_NUMBER

LOGIN_HINT_FIELD_NUMBER

PROGRAMMATIC_CLIENTS_FIELD_NUMBER

Static Methods

getDefaultInstance()

getDescriptor()

newBuilder()

newBuilder(OAuthSettings prototype)

parseDelimitedFrom(InputStream input)

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(byte[] data)

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteString data)

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

parseFrom(CodedInputStream input)

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(InputStream input)

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

parseFrom(ByteBuffer data)

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

parser()

Methods

equals(Object obj)

getClientId()

getClientIdOrBuilder()

getClientSecret()

getClientSecretOrBuilder()

getClientSecretSha256()

getClientSecretSha256OrBuilder()

getDefaultInstanceForType()

getLoginHint()

getLoginHintOrBuilder()

getParserForType()

getProgrammaticClients(int index)

getProgrammaticClientsBytes(int index)

getProgrammaticClientsCount()

getProgrammaticClientsList()

getSerializedSize()

hasClientId()

hasClientSecret()

hasClientSecretSha256()

hasLoginHint()

hashCode()

internalGetFieldAccessorTable()

isInitialized()

newBuilderForType()

newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

writeTo(CodedOutputStream output)

Class OAuthSettings (0.44.0)