Class: Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings

Inherits:

Object

• Object
• Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb

Overview

Settings specific to keys that can be used by websites.

Defined Under Namespace

Modules: ChallengeSecurityPreference, IntegrationType

Instance Attribute Summary

• #allow_all_domains ⇒ ::Boolean

  Optional.

• #allow_amp_traffic ⇒ ::Boolean

  Optional.

• #allowed_domains ⇒ ::Array<::String>

  Optional.

• #challenge_security_preference ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::ChallengeSecurityPreference

  Optional.

• #integration_type ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::IntegrationType

  Required.

Instance Attribute Details

#allow_all_domains ⇒ ::Boolean

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1378

class WebKeySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the integration types for web keys.
  module IntegrationType
    # Default type that indicates this enum hasn't been specified. This is not
    # a valid IntegrationType, one of the other types must be specified
    # instead.
    INTEGRATION_TYPE_UNSPECIFIED = 0

    # Only used to produce scores. It doesn't display the "I'm not a robot"
    # checkbox and never shows captcha challenges.
    SCORE = 1

    # Displays the "I'm not a robot" checkbox and may show captcha challenges
    # after it is checked.
    CHECKBOX = 2

    # Doesn't display the "I'm not a robot" checkbox, but may show captcha
    # challenges after risk analysis.
    INVISIBLE = 3
  end

  # Enum that represents the possible challenge frequency and difficulty
  # configurations for a web key.
  module ChallengeSecurityPreference
    # Default type that indicates this enum hasn't been specified.
    CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0

    # Key tends to show fewer and easier challenges.
    USABILITY = 1

    # Key tends to show balanced (in amount and difficulty) challenges.
    BALANCE = 2

    # Key tends to show more and harder challenges.
    SECURITY = 3
  end
end

#allow_amp_traffic ⇒ ::Boolean

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1378

class WebKeySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the integration types for web keys.
  module IntegrationType
    # Default type that indicates this enum hasn't been specified. This is not
    # a valid IntegrationType, one of the other types must be specified
    # instead.
    INTEGRATION_TYPE_UNSPECIFIED = 0

    # Only used to produce scores. It doesn't display the "I'm not a robot"
    # checkbox and never shows captcha challenges.
    SCORE = 1

    # Displays the "I'm not a robot" checkbox and may show captcha challenges
    # after it is checked.
    CHECKBOX = 2

    # Doesn't display the "I'm not a robot" checkbox, but may show captcha
    # challenges after risk analysis.
    INVISIBLE = 3
  end

  # Enum that represents the possible challenge frequency and difficulty
  # configurations for a web key.
  module ChallengeSecurityPreference
    # Default type that indicates this enum hasn't been specified.
    CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0

    # Key tends to show fewer and easier challenges.
    USABILITY = 1

    # Key tends to show balanced (in amount and difficulty) challenges.
    BALANCE = 2

    # Key tends to show more and harder challenges.
    SECURITY = 3
  end
end

#allowed_domains ⇒ ::Array<::String>

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1378

class WebKeySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the integration types for web keys.
  module IntegrationType
    # Default type that indicates this enum hasn't been specified. This is not
    # a valid IntegrationType, one of the other types must be specified
    # instead.
    INTEGRATION_TYPE_UNSPECIFIED = 0

    # Only used to produce scores. It doesn't display the "I'm not a robot"
    # checkbox and never shows captcha challenges.
    SCORE = 1

    # Displays the "I'm not a robot" checkbox and may show captcha challenges
    # after it is checked.
    CHECKBOX = 2

    # Doesn't display the "I'm not a robot" checkbox, but may show captcha
    # challenges after risk analysis.
    INVISIBLE = 3
  end

  # Enum that represents the possible challenge frequency and difficulty
  # configurations for a web key.
  module ChallengeSecurityPreference
    # Default type that indicates this enum hasn't been specified.
    CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0

    # Key tends to show fewer and easier challenges.
    USABILITY = 1

    # Key tends to show balanced (in amount and difficulty) challenges.
    BALANCE = 2

    # Key tends to show more and harder challenges.
    SECURITY = 3
  end
end

#challenge_security_preference ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::ChallengeSecurityPreference

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1378

class WebKeySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the integration types for web keys.
  module IntegrationType
    # Default type that indicates this enum hasn't been specified. This is not
    # a valid IntegrationType, one of the other types must be specified
    # instead.
    INTEGRATION_TYPE_UNSPECIFIED = 0

    # Only used to produce scores. It doesn't display the "I'm not a robot"
    # checkbox and never shows captcha challenges.
    SCORE = 1

    # Displays the "I'm not a robot" checkbox and may show captcha challenges
    # after it is checked.
    CHECKBOX = 2

    # Doesn't display the "I'm not a robot" checkbox, but may show captcha
    # challenges after risk analysis.
    INVISIBLE = 3
  end

  # Enum that represents the possible challenge frequency and difficulty
  # configurations for a web key.
  module ChallengeSecurityPreference
    # Default type that indicates this enum hasn't been specified.
    CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0

    # Key tends to show fewer and easier challenges.
    USABILITY = 1

    # Key tends to show balanced (in amount and difficulty) challenges.
    BALANCE = 2

    # Key tends to show more and harder challenges.
    SECURITY = 3
  end
end

#integration_type ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings::IntegrationType

# File 'proto_docs/google/cloud/recaptchaenterprise/v1/recaptchaenterprise.rb', line 1378

class WebKeySettings
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Enum that represents the integration types for web keys.
  module IntegrationType
    # Default type that indicates this enum hasn't been specified. This is not
    # a valid IntegrationType, one of the other types must be specified
    # instead.
    INTEGRATION_TYPE_UNSPECIFIED = 0

    # Only used to produce scores. It doesn't display the "I'm not a robot"
    # checkbox and never shows captcha challenges.
    SCORE = 1

    # Displays the "I'm not a robot" checkbox and may show captcha challenges
    # after it is checked.
    CHECKBOX = 2

    # Doesn't display the "I'm not a robot" checkbox, but may show captcha
    # challenges after risk analysis.
    INVISIBLE = 3
  end

  # Enum that represents the possible challenge frequency and difficulty
  # configurations for a web key.
  module ChallengeSecurityPreference
    # Default type that indicates this enum hasn't been specified.
    CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED = 0

    # Key tends to show fewer and easier challenges.
    USABILITY = 1

    # Key tends to show balanced (in amount and difficulty) challenges.
    BALANCE = 2

    # Key tends to show more and harder challenges.
    SECURITY = 3
  end
end