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

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

Namespace

Google \ Cloud \ RecaptchaEnterprise \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

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

↳ display_name
string

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

↳ web_settings
WebKeySettings

Settings for keys that can be used by websites.

↳ android_settings
AndroidKeySettings

Settings for keys that can be used by Android apps.

↳ ios_settings
IOSKeySettings

Settings for keys that can be used by iOS apps.

↳ express_settings
ExpressKeySettings

Settings for keys that can be used by reCAPTCHA Express.

↳ create_time
Google\Protobuf\Timestamp

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

↳ testing_options
TestingOptions

Optional. Options for user acceptance testing.

↳ waf_settings
WafSettings

Optional. Settings for WAF

getName

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

Returns
Type
Description
string

setName

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDisplayName

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

Returns
Type
Description
string

setDisplayName

Required. 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

hasWebSettings

setWebSettings

Settings for keys that can be used by websites.

Parameter
Name
Description
Returns
Type
Description
$this

getAndroidSettings

Settings for keys that can be used by Android apps.

Returns
Type
Description

hasAndroidSettings

setAndroidSettings

Settings for keys that can be used by Android apps.

Parameter
Name
Description
Returns
Type
Description
$this

getIosSettings

Settings for keys that can be used by iOS apps.

Returns
Type
Description

hasIosSettings

setIosSettings

Settings for keys that can be used by iOS apps.

Parameter
Name
Description
Returns
Type
Description
$this

getExpressSettings

Settings for keys that can be used by reCAPTCHA Express.

Returns
Type
Description

hasExpressSettings

setExpressSettings

Settings for keys that can be used by reCAPTCHA Express.

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

Returns
Type
Description

setLabels

Parameter
Name
Description
Returns
Type
Description
$this

getCreateTime

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

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

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

Parameter
Name
Description
Returns
Type
Description
$this

getTestingOptions

Optional. Options for user acceptance testing.

Returns
Type
Description

hasTestingOptions

clearTestingOptions

setTestingOptions

Optional. Options for user acceptance testing.

Parameter
Name
Description
Returns
Type
Description
$this

getWafSettings

Optional. Settings for WAF

Returns
Type
Description
WafSettings |null

hasWafSettings

clearWafSettings

setWafSettings

Optional. Settings for WAF

Parameter
Name
Description
Returns
Type
Description
$this

getPlatformSettings

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