Package com.google.recaptchaenterprise.v1

Interface WebKeySettingsOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    WebKeySettings, WebKeySettings.Builder
    public interface WebKeySettingsOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getAllowAllDomains

        boolean getAllowAllDomains()
         If set to true, it means allowed_domains will not be enforced.
        bool allow_all_domains = 3;
        Returns:
        The allowAllDomains.

      • getAllowedDomainsList

        List<String> getAllowedDomainsList()
         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'
        repeated string allowed_domains = 1;
        Returns:
        A list containing the allowedDomains.

      • getAllowedDomainsCount

        int getAllowedDomainsCount()
         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'
        repeated string allowed_domains = 1;
        Returns:
        The count of allowedDomains.

      • getAllowedDomains

        String getAllowedDomains​(int index)
         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'
        repeated string allowed_domains = 1;
        Parameters:
        index - The index of the element to return.
        Returns:
        The allowedDomains at the given index.

      • getAllowedDomainsBytes

        com.google.protobuf.ByteString getAllowedDomainsBytes​(int index)
         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'
        repeated string allowed_domains = 1;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the allowedDomains at the given index.

      • getAllowAmpTraffic

        boolean getAllowAmpTraffic()
         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;
        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()
         Settings for the frequency and difficulty at which this key triggers
 captcha challenges. This should only be specified for IntegrationTypes
 CHECKBOX and INVISIBLE.
        .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5;
        Returns:
        The enum numeric value on the wire for challengeSecurityPreference.

      • getChallengeSecurityPreference

        WebKeySettings.ChallengeSecurityPreference getChallengeSecurityPreference()
         Settings for the frequency and difficulty at which this key triggers
 captcha challenges. This should only be specified for IntegrationTypes
 CHECKBOX and INVISIBLE.
        .google.cloud.recaptchaenterprise.v1.WebKeySettings.ChallengeSecurityPreference challenge_security_preference = 5;
        Returns:
        The challengeSecurityPreference.