Package com.google.cloud.iap.v1

Class OAuthSettings

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.iap.v1.OAuthSettings
All Implemented Interfaces:
OAuthSettingsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class OAuthSettings extends com.google.protobuf.GeneratedMessage implements OAuthSettingsOrBuilder
 Configuration for OAuth login&consent flow behavior as well as for OAuth
 Credentials.
Protobuf type google.cloud.iap.v1.OAuthSettings
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    OAuthSettings.Builder
    Configuration for OAuth login&consent flow behavior as well as for OAuth Credentials.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CLIENT_ID_FIELD_NUMBER
     
    static final int
    CLIENT_SECRET_FIELD_NUMBER
     
    static final int
    CLIENT_SECRET_SHA256_FIELD_NUMBER
     
    static final int
    LOGIN_HINT_FIELD_NUMBER
     
    static final int
    PROGRAMMATIC_CLIENTS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    com.google.protobuf.StringValue
    getClientId()
    Optional.
    com.google.protobuf.StringValueOrBuilder
    getClientIdOrBuilder()
    Optional.
    com.google.protobuf.StringValue
    getClientSecret()
    Optional.
    com.google.protobuf.StringValueOrBuilder
    getClientSecretOrBuilder()
    Optional.
    com.google.protobuf.StringValue
    getClientSecretSha256()
    Output only.
    com.google.protobuf.StringValueOrBuilder
    getClientSecretSha256OrBuilder()
    Output only.
    static OAuthSettings
    getDefaultInstance()
     
    OAuthSettings
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.StringValue
    getLoginHint()
    Domain hint to send as hd=?
    com.google.protobuf.StringValueOrBuilder
    getLoginHintOrBuilder()
    Domain hint to send as hd=?
    com.google.protobuf.Parser<OAuthSettings>
    getParserForType()
     
    String
    getProgrammaticClients(int index)
    Optional.
    com.google.protobuf.ByteString
    getProgrammaticClientsBytes(int index)
    Optional.
    int
    getProgrammaticClientsCount()
    Optional.
    com.google.protobuf.ProtocolStringList
    getProgrammaticClientsList()
    Optional.
    int
    getSerializedSize()
     
    boolean
    hasClientId()
    Optional.
    boolean
    hasClientSecret()
    Optional.
    boolean
    hasClientSecretSha256()
    Output only.
    int
    hashCode()
     
    boolean
    hasLoginHint()
    Domain hint to send as hd=?
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static OAuthSettings.Builder
    newBuilder()
     
    static OAuthSettings.Builder
    newBuilder(OAuthSettings prototype)
     
    OAuthSettings.Builder
    newBuilderForType()
     
    protected OAuthSettings.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static OAuthSettings
    parseDelimitedFrom(InputStream input)
     
    static OAuthSettings
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OAuthSettings
    parseFrom(byte[] data)
     
    static OAuthSettings
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OAuthSettings
    parseFrom(com.google.protobuf.ByteString data)
     
    static OAuthSettings
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OAuthSettings
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static OAuthSettings
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OAuthSettings
    parseFrom(InputStream input)
     
    static OAuthSettings
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OAuthSettings
    parseFrom(ByteBuffer data)
     
    static OAuthSettings
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<OAuthSettings>
    parser()
     
    OAuthSettings.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • LOGIN_HINT_FIELD_NUMBER

      public static final int LOGIN_HINT_FIELD_NUMBER
      See Also:

    • CLIENT_ID_FIELD_NUMBER

      public static final int CLIENT_ID_FIELD_NUMBER
      See Also:

    • CLIENT_SECRET_FIELD_NUMBER

      public static final int CLIENT_SECRET_FIELD_NUMBER
      See Also:

    • CLIENT_SECRET_SHA256_FIELD_NUMBER

      public static final int CLIENT_SECRET_SHA256_FIELD_NUMBER
      See Also:

    • PROGRAMMATIC_CLIENTS_FIELD_NUMBER

      public static final int PROGRAMMATIC_CLIENTS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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;
      Specified by:
      hasLoginHint in interface OAuthSettingsOrBuilder
      Returns:
      Whether the loginHint field is set.

    • getLoginHint

      public com.google.protobuf.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;
      Specified by:
      getLoginHint in interface OAuthSettingsOrBuilder
      Returns:
      The loginHint.

    • getLoginHintOrBuilder

      public com.google.protobuf.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;
      Specified by:
      getLoginHintOrBuilder in interface OAuthSettingsOrBuilder

    • 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];
      Specified by:
      hasClientId in interface OAuthSettingsOrBuilder
      Returns:
      Whether the clientId field is set.

    • getClientId

      public com.google.protobuf.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];
      Specified by:
      getClientId in interface OAuthSettingsOrBuilder
      Returns:
      The clientId.

    • getClientIdOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getClientIdOrBuilder in interface OAuthSettingsOrBuilder

    • 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];
      Specified by:
      hasClientSecret in interface OAuthSettingsOrBuilder
      Returns:
      Whether the clientSecret field is set.

    • getClientSecret

      public com.google.protobuf.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];
      Specified by:
      getClientSecret in interface OAuthSettingsOrBuilder
      Returns:
      The clientSecret.

    • getClientSecretOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getClientSecretOrBuilder in interface OAuthSettingsOrBuilder

    • 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];
      Specified by:
      hasClientSecretSha256 in interface OAuthSettingsOrBuilder
      Returns:
      Whether the clientSecretSha256 field is set.

    • getClientSecretSha256

      public com.google.protobuf.StringValue getClientSecretSha256()
       Output only. OAuth secret SHA256 paired with client ID.
      .google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getClientSecretSha256 in interface OAuthSettingsOrBuilder
      Returns:
      The clientSecretSha256.

    • getClientSecretSha256OrBuilder

      public com.google.protobuf.StringValueOrBuilder getClientSecretSha256OrBuilder()
       Output only. OAuth secret SHA256 paired with client ID.
      .google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getClientSecretSha256OrBuilder in interface OAuthSettingsOrBuilder

    • getProgrammaticClientsList

      public com.google.protobuf.ProtocolStringList getProgrammaticClientsList()
       Optional. List of client ids allowed to use IAP programmatically.
      repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getProgrammaticClientsList in interface OAuthSettingsOrBuilder
      Returns:
      A list containing the programmaticClients.

    • getProgrammaticClientsCount

      public int getProgrammaticClientsCount()
       Optional. List of client ids allowed to use IAP programmatically.
      repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getProgrammaticClientsCount in interface OAuthSettingsOrBuilder
      Returns:
      The count of programmaticClients.

    • getProgrammaticClients

      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];
      Specified by:
      getProgrammaticClients in interface OAuthSettingsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The programmaticClients at the given index.

    • getProgrammaticClientsBytes

      public com.google.protobuf.ByteString getProgrammaticClientsBytes(int index)
       Optional. List of client ids allowed to use IAP programmatically.
      repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getProgrammaticClientsBytes in interface OAuthSettingsOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the programmaticClients at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static OAuthSettings parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OAuthSettings parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OAuthSettings parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OAuthSettings parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OAuthSettings parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OAuthSettings parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OAuthSettings parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OAuthSettings parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OAuthSettings parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OAuthSettings parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OAuthSettings parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OAuthSettings parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public OAuthSettings.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static OAuthSettings.Builder newBuilder()

    • newBuilder

      public static OAuthSettings.Builder newBuilder(OAuthSettings prototype)

    • toBuilder

      public OAuthSettings.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected OAuthSettings.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static OAuthSettings getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<OAuthSettings> parser()

    • getParserForType

      public com.google.protobuf.Parser<OAuthSettings> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public OAuthSettings getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder