Class: Google::Cloud::RecaptchaEnterprise::V1::Key

Inherits:

Object

• Object
• Google::Cloud::RecaptchaEnterprise::V1::Key

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

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

Overview

A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.

Defined Under Namespace

Classes: LabelsEntry

Instance Attribute Summary

• #android_settings ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::AndroidKeySettings

  Settings for keys that can be used by Android apps.

• #create_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

• #display_name ⇒ ::String

  Required.

• #express_settings ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::ExpressKeySettings

  Settings for keys that can be used by reCAPTCHA Express.

• #ios_settings ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::IOSKeySettings

  Settings for keys that can be used by iOS apps.

• #labels ⇒ ::Google::Protobuf::Map{::String => ::String}

  Optional.

• #name ⇒ ::String

  Identifier.

• #testing_options ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions

  Optional.

• #waf_settings ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::WafSettings

  Optional.

• #web_settings ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings

  Settings for keys that can be used by websites.

Instance Attribute Details

#android_settings ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::AndroidKeySettings

Returns Settings for keys that can be used by Android apps.

Returns:

• (::Google::Cloud::RecaptchaEnterprise::V1::AndroidKeySettings) —

  Settings for keys that can be used by Android apps.

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

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp corresponding to the creation of this key.

Returns:

• (::Google::Protobuf::Timestamp) —

  Output only. The timestamp corresponding to the creation of this key.

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

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

Returns Required. Human-readable display name of this key. Modifiable by user.

Returns:

• (::String) —

  Required. Human-readable display name of this key. Modifiable by user.

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

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#express_settings ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::ExpressKeySettings

Returns Settings for keys that can be used by reCAPTCHA Express.

Returns:

• (::Google::Cloud::RecaptchaEnterprise::V1::ExpressKeySettings) —

  Settings for keys that can be used by reCAPTCHA Express.

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

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ios_settings ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::IOSKeySettings

Returns Settings for keys that can be used by iOS apps.

Returns:

• (::Google::Cloud::RecaptchaEnterprise::V1::IOSKeySettings) —

  Settings for keys that can be used by iOS apps.

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

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Optional. See Creating and managing labels.

Returns:

• (::Google::Protobuf::Map{::String => ::String}) —

  Optional. See Creating and managing labels.

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

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.

Returns:

• (::String) —

  Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.

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

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#testing_options ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions

Returns Optional. Options for user acceptance testing.

Returns:

• (::Google::Cloud::RecaptchaEnterprise::V1::TestingOptions) —

  Optional. Options for user acceptance testing.

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

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#waf_settings ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::WafSettings

Returns Optional. Settings for WAF.

Returns:

• (::Google::Cloud::RecaptchaEnterprise::V1::WafSettings) —

  Optional. Settings for WAF

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

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#web_settings ⇒ ::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings

Returns Settings for keys that can be used by websites.

Returns:

• (::Google::Cloud::RecaptchaEnterprise::V1::WebKeySettings) —

  Settings for keys that can be used by websites.

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

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end