Interface WebKeySettingsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
WebKeySettings, WebKeySettings.Builder

@Generated public interface WebKeySettingsOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getAllowAllDomains

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

      List<String> 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];
      Returns:
      A list containing the allowedDomains.
    • getAllowedDomainsCount

      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];
      Returns:
      The count of allowedDomains.
    • getAllowedDomains

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The allowedDomains at the given index.
    • getAllowedDomainsBytes

      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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the allowedDomains at the given index.
    • getAllowAmpTraffic

      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];
      Returns:
      The allowAmpTraffic.
    • getIntegrationTypeValue

      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];
      Returns:
      The enum numeric value on the wire for integrationType.
    • getIntegrationType

      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];
      Returns:
      The integrationType.
    • getChallengeSecurityPreferenceValue

      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];
      Returns:
      The enum numeric value on the wire for challengeSecurityPreference.
    • getChallengeSecurityPreference

      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];
      Returns:
      The challengeSecurityPreference.
    • hasChallengeSettings

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

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

      WebKeySettings.ChallengeSettingsOrBuilder getChallengeSettingsOrBuilder()
       Optional. Challenge settings.
       
      .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSettings challenge_settings = 6 [(.google.api.field_behavior) = OPTIONAL];