Reference documentation and code samples for the Google Cloud Recaptcha Enterprise V1 Client class Metrics.
Metrics for a single Key.
Generated from protobuf message google.cloud.recaptchaenterprise.v1.Metrics
Namespace
Google \ Cloud \ RecaptchaEnterprise \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Identifier. The name of the metrics, in the format |
↳ start_time |
Google\Protobuf\Timestamp
Inclusive start time aligned to a day (UTC). |
↳ score_metrics |
array<Google\Cloud\RecaptchaEnterprise\V1\ScoreMetrics>
Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data. |
↳ challenge_metrics |
array<Google\Cloud\RecaptchaEnterprise\V1\ChallengeMetrics>
Metrics will be continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have challenge-based data. |
getName
Output only. Identifier. The name of the metrics, in the format
projects/{project}/keys/{key}/metrics.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. Identifier. The name of the metrics, in the format
projects/{project}/keys/{key}/metrics.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStartTime
Inclusive start time aligned to a day (UTC).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasStartTime
clearStartTime
setStartTime
Inclusive start time aligned to a day (UTC).
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getScoreMetrics
Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setScoreMetrics
Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\RecaptchaEnterprise\V1\ScoreMetrics>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getChallengeMetrics
Metrics will be continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have challenge-based data.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setChallengeMetrics
Metrics will be continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have challenge-based data.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\RecaptchaEnterprise\V1\ChallengeMetrics>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|