Package com.google.cloud.iap.v1

Class OAuthSettings.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<OAuthSettings.Builder>
com.google.cloud.iap.v1.OAuthSettings.Builder
All Implemented Interfaces:
OAuthSettingsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
OAuthSettings
public static final class OAuthSettings.Builder extends com.google.protobuf.GeneratedMessage.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

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

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<OAuthSettings.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public OAuthSettings.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OAuthSettings.Builder>

    • mergeFrom

      public OAuthSettings.Builder mergeFrom(OAuthSettings other)

    • isInitialized

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

    • mergeFrom

      public OAuthSettings.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<OAuthSettings.Builder>
      Throws:
      IOException

    • 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.

    • setLoginHint

      public OAuthSettings.Builder setLoginHint(com.google.protobuf.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;

    • setLoginHint

      public OAuthSettings.Builder setLoginHint(com.google.protobuf.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;

    • mergeLoginHint

      public OAuthSettings.Builder mergeLoginHint(com.google.protobuf.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;

    • 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;

    • getLoginHintBuilder

      public com.google.protobuf.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;

    • 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.

    • setClientId

      public OAuthSettings.Builder setClientId(com.google.protobuf.StringValue value)
       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];

    • setClientId

      public OAuthSettings.Builder setClientId(com.google.protobuf.StringValue.Builder builderForValue)
       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];

    • mergeClientId

      public OAuthSettings.Builder mergeClientId(com.google.protobuf.StringValue value)
       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];

    • clearClientId

      public OAuthSettings.Builder clearClientId()
       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];

    • getClientIdBuilder

      public com.google.protobuf.StringValue.Builder getClientIdBuilder()
       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];

    • 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.

    • setClientSecret

      public OAuthSettings.Builder setClientSecret(com.google.protobuf.StringValue value)
       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];

    • setClientSecret

      public OAuthSettings.Builder setClientSecret(com.google.protobuf.StringValue.Builder builderForValue)
       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];

    • mergeClientSecret

      public OAuthSettings.Builder mergeClientSecret(com.google.protobuf.StringValue value)
       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];

    • clearClientSecret

      public OAuthSettings.Builder clearClientSecret()
       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];

    • getClientSecretBuilder

      public com.google.protobuf.StringValue.Builder getClientSecretBuilder()
       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];

    • 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.

    • setClientSecretSha256

      public OAuthSettings.Builder setClientSecretSha256(com.google.protobuf.StringValue value)
       Output only. OAuth secret SHA256 paired with client ID.
      .google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • setClientSecretSha256

      public OAuthSettings.Builder setClientSecretSha256(com.google.protobuf.StringValue.Builder builderForValue)
       Output only. OAuth secret SHA256 paired with client ID.
      .google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • mergeClientSecretSha256

      public OAuthSettings.Builder mergeClientSecretSha256(com.google.protobuf.StringValue value)
       Output only. OAuth secret SHA256 paired with client ID.
      .google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • clearClientSecretSha256

      public OAuthSettings.Builder clearClientSecretSha256()
       Output only. OAuth secret SHA256 paired with client ID.
      .google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getClientSecretSha256Builder

      public com.google.protobuf.StringValue.Builder getClientSecretSha256Builder()
       Output only. OAuth secret SHA256 paired with client ID.
      .google.protobuf.StringValue client_secret_sha256 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • 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.

    • setProgrammaticClients

      public OAuthSettings.Builder setProgrammaticClients(int index, String value)
       Optional. List of client ids allowed to use IAP programmatically.
      repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index to set the value at.
      value - The programmaticClients to set.
      Returns:
      This builder for chaining.

    • addProgrammaticClients

      public OAuthSettings.Builder addProgrammaticClients(String value)
       Optional. List of client ids allowed to use IAP programmatically.
      repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The programmaticClients to add.
      Returns:
      This builder for chaining.

    • addAllProgrammaticClients

      public OAuthSettings.Builder addAllProgrammaticClients(Iterable<String> values)
       Optional. List of client ids allowed to use IAP programmatically.
      repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      values - The programmaticClients to add.
      Returns:
      This builder for chaining.

    • clearProgrammaticClients

      public OAuthSettings.Builder clearProgrammaticClients()
       Optional. List of client ids allowed to use IAP programmatically.
      repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • addProgrammaticClientsBytes

      public OAuthSettings.Builder addProgrammaticClientsBytes(com.google.protobuf.ByteString value)
       Optional. List of client ids allowed to use IAP programmatically.
      repeated string programmatic_clients = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes of the programmaticClients to add.
      Returns:
      This builder for chaining.