PHPFUI/InstaDoc

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

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type string $name
      Identifier. The resource name for the Key in the format
      `projects/{project}/keys/{key}`.
@type string $display_name
      Required. Human-readable display name of this key. Modifiable by user.
@type \Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings $web_settings
      Settings for keys that can be used by websites.
@type \Google\Cloud\RecaptchaEnterprise\V1\AndroidKeySettings $android_settings
      Settings for keys that can be used by Android apps.
@type \Google\Cloud\RecaptchaEnterprise\V1\IOSKeySettings $ios_settings
      Settings for keys that can be used by iOS apps.
@type \Google\Cloud\RecaptchaEnterprise\V1\ExpressKeySettings $express_settings
      Settings for keys that can be used by reCAPTCHA Express.
@type array|\Google\Protobuf\Internal\MapField $labels
      Optional. See [Creating and managing labels]
      (https://cloud.google.com/recaptcha/docs/labels).
@type \Google\Protobuf\Timestamp $create_time
      Output only. The timestamp corresponding to the creation of this key.
@type \Google\Cloud\RecaptchaEnterprise\V1\TestingOptions $testing_options
      Optional. Options for user acceptance testing.
@type \Google\Cloud\RecaptchaEnterprise\V1\WafSettings $waf_settings
      Optional. Settings for WAF

}

public Google\Protobuf\Internal\Message::__debugInfo()

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

public clearCreateTime()

public clearTestingOptions()

public clearWafSettings()

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getAndroidSettings()

Settings for keys that can be used by Android apps.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AndroidKeySettings android_settings = 4;

return \Google\Cloud\RecaptchaEnterprise\V1\AndroidKeySettings|null

public getCreateTime()

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

Generated from protobuf field .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

return \Google\Protobuf\Timestamp|null

public getDisplayName()

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

Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

return string

public getExpressSettings()

Settings for keys that can be used by reCAPTCHA Express.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.ExpressKeySettings express_settings = 11;

return \Google\Cloud\RecaptchaEnterprise\V1\ExpressKeySettings|null

public getIosSettings()

Settings for keys that can be used by iOS apps.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.IOSKeySettings ios_settings = 5;

return \Google\Cloud\RecaptchaEnterprise\V1\IOSKeySettings|null

public getLabels()

Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).

Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

return \Google\Protobuf\Internal\MapField

public getName()

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

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

return string

public getPlatformSettings()

return string

public getTestingOptions()

Optional. Options for user acceptance testing.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9 [(.google.api.field_behavior) = OPTIONAL];

return \Google\Cloud\RecaptchaEnterprise\V1\TestingOptions|null

public getWafSettings()

Optional. Settings for WAF

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

return \Google\Cloud\RecaptchaEnterprise\V1\WafSettings|null

public getWebSettings()

Settings for keys that can be used by websites.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings web_settings = 3;

return \Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings|null

public hasAndroidSettings()

public hasCreateTime()

public hasExpressSettings()

public hasIosSettings()

public hasTestingOptions()

public hasWafSettings()

public hasWebSettings()

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

public Google\Protobuf\Internal\Message::parseFromStream( $input)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

Serialize the message to json string.

return string Serialized json protobuf data.

public Google\Protobuf\Internal\Message::serializeToStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToString()

Serialize the message to string.

return string Serialized binary protobuf data.

public setAndroidSettings( $var)

Settings for keys that can be used by Android apps.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AndroidKeySettings android_settings = 4;

param \Google\Cloud\RecaptchaEnterprise\V1\AndroidKeySettings $var
return $this

public setCreateTime( $var)

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

Generated from protobuf field .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

param \Google\Protobuf\Timestamp $var
return $this

public setDisplayName( $var)

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

Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

param string $var
return $this

public setExpressSettings( $var)

Settings for keys that can be used by reCAPTCHA Express.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.ExpressKeySettings express_settings = 11;

param \Google\Cloud\RecaptchaEnterprise\V1\ExpressKeySettings $var
return $this

public setIosSettings( $var)

Settings for keys that can be used by iOS apps.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.IOSKeySettings ios_settings = 5;

param \Google\Cloud\RecaptchaEnterprise\V1\IOSKeySettings $var
return $this

public setLabels( $var)

Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).

Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

param array|\Google\Protobuf\Internal\MapField $var
return $this

public setName( $var)

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

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

param string $var
return $this

public setTestingOptions( $var)

Optional. Options for user acceptance testing.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9 [(.google.api.field_behavior) = OPTIONAL];

param \Google\Cloud\RecaptchaEnterprise\V1\TestingOptions $var
return $this

public setWafSettings( $var)

Optional. Settings for WAF

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

param \Google\Cloud\RecaptchaEnterprise\V1\WafSettings $var
return $this

public setWebSettings( $var)

Settings for keys that can be used by websites.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WebKeySettings web_settings = 3;

param \Google\Cloud\RecaptchaEnterprise\V1\WebKeySettings $var
return $this

Properties

protected $create_time = NULL

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

Generated from protobuf field .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

protected $display_name = ''

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

Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

protected $name = ''

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

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

protected $platform_settings = NULL

protected $testing_options = NULL

Optional. Options for user acceptance testing.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TestingOptions testing_options = 9 [(.google.api.field_behavior) = OPTIONAL];

protected $waf_settings = NULL

Optional. Settings for WAF

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.WafSettings waf_settings = 10 [(.google.api.field_behavior) = OPTIONAL];

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

protected Google\Protobuf\Internal\Message::readOneof( $number)

protected Google\Protobuf\Internal\Message::readWrapperValue( $member)

protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)

protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)

protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)

Properties

private $labels = NULL

Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).

Generated from protobuf field map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];