Class WebKeySettings

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.recaptchaenterprise.v1.WebKeySettings
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, WebKeySettingsOrBuilder, Serializable

@Generated public final class WebKeySettings extends com.google.protobuf.GeneratedMessage implements WebKeySettingsOrBuilder
 Settings specific to keys that can be used by websites.
 
Protobuf type google.cloud.recaptchaenterprise.v1.WebKeySettings
See Also:
  • Field Details

    • ALLOW_ALL_DOMAINS_FIELD_NUMBER

      public static final int ALLOW_ALL_DOMAINS_FIELD_NUMBER
      See Also:
    • ALLOWED_DOMAINS_FIELD_NUMBER

      public static final int ALLOWED_DOMAINS_FIELD_NUMBER
      See Also:
    • ALLOW_AMP_TRAFFIC_FIELD_NUMBER

      public static final int ALLOW_AMP_TRAFFIC_FIELD_NUMBER
      See Also:
    • INTEGRATION_TYPE_FIELD_NUMBER

      public static final int INTEGRATION_TYPE_FIELD_NUMBER
      See Also:
    • CHALLENGE_SECURITY_PREFERENCE_FIELD_NUMBER

      public static final int CHALLENGE_SECURITY_PREFERENCE_FIELD_NUMBER
      See Also:
    • CHALLENGE_SETTINGS_FIELD_NUMBER

      public static final int CHALLENGE_SETTINGS_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
    • getAllowAllDomains

      public boolean getAllowAllDomains()
       Optional. If set to true, it means allowed_domains are not enforced.
       
      bool allow_all_domains = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAllowAllDomains in interface WebKeySettingsOrBuilder
      Returns:
      The allowAllDomains.
    • getAllowedDomainsList

      public com.google.protobuf.ProtocolStringList getAllowedDomainsList()
       Optional. Domains or subdomains of websites allowed to use the key. All
       subdomains of an allowed domain are automatically allowed. A valid domain
       requires a host and must not include any path, port, query or fragment.
       Examples: 'example.com' or 'subdomain.example.com'
       Each key supports a maximum of 250 domains. To use a key on more domains,
       set `allow_all_domains` to true. When this is set, you are responsible for
       validating the hostname by checking the `token_properties.hostname` field
       in each assessment response against your list of allowed domains.
       
      repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAllowedDomainsList in interface WebKeySettingsOrBuilder
      Returns:
      A list containing the allowedDomains.
    • getAllowedDomainsCount

      public int getAllowedDomainsCount()
       Optional. Domains or subdomains of websites allowed to use the key. All
       subdomains of an allowed domain are automatically allowed. A valid domain
       requires a host and must not include any path, port, query or fragment.
       Examples: 'example.com' or 'subdomain.example.com'
       Each key supports a maximum of 250 domains. To use a key on more domains,
       set `allow_all_domains` to true. When this is set, you are responsible for
       validating the hostname by checking the `token_properties.hostname` field
       in each assessment response against your list of allowed domains.
       
      repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAllowedDomainsCount in interface WebKeySettingsOrBuilder
      Returns:
      The count of allowedDomains.
    • getAllowedDomains

      public String getAllowedDomains(int index)
       Optional. Domains or subdomains of websites allowed to use the key. All
       subdomains of an allowed domain are automatically allowed. A valid domain
       requires a host and must not include any path, port, query or fragment.
       Examples: 'example.com' or 'subdomain.example.com'
       Each key supports a maximum of 250 domains. To use a key on more domains,
       set `allow_all_domains` to true. When this is set, you are responsible for
       validating the hostname by checking the `token_properties.hostname` field
       in each assessment response against your list of allowed domains.
       
      repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAllowedDomains in interface WebKeySettingsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The allowedDomains at the given index.
    • getAllowedDomainsBytes

      public com.google.protobuf.ByteString getAllowedDomainsBytes(int index)
       Optional. Domains or subdomains of websites allowed to use the key. All
       subdomains of an allowed domain are automatically allowed. A valid domain
       requires a host and must not include any path, port, query or fragment.
       Examples: 'example.com' or 'subdomain.example.com'
       Each key supports a maximum of 250 domains. To use a key on more domains,
       set `allow_all_domains` to true. When this is set, you are responsible for
       validating the hostname by checking the `token_properties.hostname` field
       in each assessment response against your list of allowed domains.
       
      repeated string allowed_domains = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAllowedDomainsBytes in interface WebKeySettingsOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the allowedDomains at the given index.
    • getAllowAmpTraffic

      public boolean getAllowAmpTraffic()
       Optional. If set to true, the key can be used on AMP (Accelerated Mobile
       Pages) websites. This is supported only for the SCORE integration type.
       
      bool allow_amp_traffic = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAllowAmpTraffic in interface WebKeySettingsOrBuilder
      Returns:
      The allowAmpTraffic.
    • getIntegrationTypeValue

      public int getIntegrationTypeValue()
       Required. Describes how this key is integrated with the website.
       
      .google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType integration_type = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getIntegrationTypeValue in interface WebKeySettingsOrBuilder
      Returns:
      The enum numeric value on the wire for integrationType.
    • getIntegrationType

      public WebKeySettings.IntegrationType getIntegrationType()
       Required. Describes how this key is integrated with the website.
       
      .google.cloud.recaptchaenterprise.v1.WebKeySettings.IntegrationType integration_type = 4 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getIntegrationType in interface WebKeySettingsOrBuilder
      Returns:
      The integrationType.
    • getChallengeSecurityPreferenceValue

      public int getChallengeSecurityPreferenceValue()
       Optional. Settings for the frequency and difficulty at which this key
       triggers captcha challenges. This should only be specified for
       `IntegrationType` CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.
       
      .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getChallengeSecurityPreferenceValue in interface WebKeySettingsOrBuilder
      Returns:
      The enum numeric value on the wire for challengeSecurityPreference.
    • getChallengeSecurityPreference

      public WebKeySettings.ChallengeSecurityPreference getChallengeSecurityPreference()
       Optional. Settings for the frequency and difficulty at which this key
       triggers captcha challenges. This should only be specified for
       `IntegrationType` CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.
       
      .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getChallengeSecurityPreference in interface WebKeySettingsOrBuilder
      Returns:
      The challengeSecurityPreference.
    • hasChallengeSettings

      public boolean hasChallengeSettings()
       Optional. Challenge settings.
       
      .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings challenge_settings = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasChallengeSettings in interface WebKeySettingsOrBuilder
      Returns:
      Whether the challengeSettings field is set.
    • getChallengeSettings

      public WebKeySettings.ChallengeSettings getChallengeSettings()
       Optional. Challenge settings.
       
      .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings challenge_settings = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getChallengeSettings in interface WebKeySettingsOrBuilder
      Returns:
      The challengeSettings.
    • getChallengeSettingsOrBuilder

      public WebKeySettings.ChallengeSettingsOrBuilder getChallengeSettingsOrBuilder()
       Optional. Challenge settings.
       
      .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings challenge_settings = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getChallengeSettingsOrBuilder in interface WebKeySettingsOrBuilder
    • 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 WebKeySettings parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static WebKeySettings parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static WebKeySettings parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static WebKeySettings.Builder newBuilder()
    • newBuilder

      public static WebKeySettings.Builder newBuilder(WebKeySettings prototype)
    • toBuilder

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

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

      public static WebKeySettings getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<WebKeySettings> parser()
    • getParserForType

      public com.google.protobuf.Parser<WebKeySettings> 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 WebKeySettings getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder