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

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
NameDescription
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

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
TypeDescription
string

setName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDisplayName

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

Returns
TypeDescription
string

setDisplayName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getWebSettings

Settings for keys that can be used by websites.

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings|null

hasWebSettings

setWebSettings

Settings for keys that can be used by websites.

Parameter
NameDescription
var Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings
Returns
TypeDescription
$this

getAndroidSettings

Settings for keys that can be used by Android apps.

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\AndroidKeySettings|null

hasAndroidSettings

setAndroidSettings

Settings for keys that can be used by Android apps.

Parameter
NameDescription
var Google\Cloud\RecaptchaEnterprise\V1\AndroidKeySettings
Returns
TypeDescription
$this

getIosSettings

Settings for keys that can be used by iOS apps.

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\IOSKeySettings|null

hasIosSettings

setIosSettings

Settings for keys that can be used by iOS apps.

Parameter
NameDescription
var Google\Cloud\RecaptchaEnterprise\V1\IOSKeySettings
Returns
TypeDescription
$this

getLabels

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getCreateTime

The timestamp corresponding to the creation of this Key.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

The timestamp corresponding to the creation of this Key.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getTestingOptions

Options for user acceptance testing.

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\TestingOptions|null

hasTestingOptions

clearTestingOptions

setTestingOptions

Options for user acceptance testing.

Parameter
NameDescription
var Google\Cloud\RecaptchaEnterprise\V1\TestingOptions
Returns
TypeDescription
$this

getWafSettings

Settings for WAF

Returns
TypeDescription
Google\Cloud\RecaptchaEnterprise\V1\WafSettings|null

hasWafSettings

clearWafSettings

setWafSettings

Settings for WAF

Parameter
NameDescription
var Google\Cloud\RecaptchaEnterprise\V1\WafSettings
Returns
TypeDescription
$this

getPlatformSettings

Returns
TypeDescription
string