Console
    Contact Us Start free

    Google Cloud Recaptcha Enterprise V1 Client - Class Key (1.3.2)

    Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class Key.

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

    Generated from protobuf message google.cloud.recaptchaenterprise.v1.Key

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

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

    ↳ display_name
    string

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

    ↳ web_settings
    Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings

    Settings for keys that can be used by websites.

    ↳ android_settings
    Google\Cloud\RecaptchaEnterprise\V1\AndroidKeySettings

    Settings for keys that can be used by Android apps.

    ↳ ios_settings
    Google\Cloud\RecaptchaEnterprise\V1\IOSKeySettings

    Settings for keys that can be used by iOS apps.

    ↳ labels
    array| Google\Protobuf\Internal\MapField

    See Creating and managing labels .

    ↳ create_time
    Google\Protobuf\Timestamp

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

    ↳ testing_options
    Google\Cloud\RecaptchaEnterprise\V1\TestingOptions

    Options for user acceptance testing.

    ↳ waf_settings
    Google\Cloud\RecaptchaEnterprise\V1\WafSettings

    Settings for WAF

    getName

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

    Returns
    Type
    Description
    string

    setName

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

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

    Returns
    Type
    Description
    string

    setDisplayName

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

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getWebSettings

    Settings for keys that can be used by websites.

    Returns
    Type
    Description
    Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings |null

    hasWebSettings

    setWebSettings

    Settings for keys that can be used by websites.

    Parameter
    Name
    Description
    var
    Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings
    Returns
    Type
    Description
    $this

    getAndroidSettings

    Settings for keys that can be used by Android apps.

    Returns
    Type
    Description
    Google\Cloud\RecaptchaEnterprise\V1\AndroidKeySettings |null

    hasAndroidSettings

    setAndroidSettings

    Settings for keys that can be used by Android apps.

    Parameter
    Name
    Description
    var
    Google\Cloud\RecaptchaEnterprise\V1\AndroidKeySettings
    Returns
    Type
    Description
    $this

    getIosSettings

    Settings for keys that can be used by iOS apps.

    Returns
    Type
    Description
    Google\Cloud\RecaptchaEnterprise\V1\IOSKeySettings |null

    hasIosSettings

    setIosSettings

    Settings for keys that can be used by iOS apps.

    Parameter
    Name
    Description
    var
    Google\Cloud\RecaptchaEnterprise\V1\IOSKeySettings
    Returns
    Type
    Description
    $this

    getLabels

    See Creating and managing labels .

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    See Creating and managing labels .

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getCreateTime

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

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

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

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getTestingOptions

    Options for user acceptance testing.

    Returns
    Type
    Description
    Google\Cloud\RecaptchaEnterprise\V1\TestingOptions |null

    hasTestingOptions

    clearTestingOptions

    setTestingOptions

    Options for user acceptance testing.

    Parameter
    Name
    Description
    var
    Google\Cloud\RecaptchaEnterprise\V1\TestingOptions
    Returns
    Type
    Description
    $this

    getWafSettings

    Settings for WAF

    Returns
    Type
    Description
    Google\Cloud\RecaptchaEnterprise\V1\WafSettings |null

    hasWafSettings

    clearWafSettings

    setWafSettings

    Settings for WAF

    Parameter
    Name
    Description
    var
    Google\Cloud\RecaptchaEnterprise\V1\WafSettings
    Returns
    Type
    Description
    $this

    getPlatformSettings

    Returns
    Type
    Description
    string
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: