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

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. The name of the metrics, in the format "projects/{project}/keys/{key}/metrics".

↳ 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. The name of the metrics, in the format "projects/{project}/keys/{key}/metrics".

Returns
TypeDescription
string

setName

Output only. The name of the metrics, in the format "projects/{project}/keys/{key}/metrics".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStartTime

Inclusive start time aligned to a day (UTC).

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

Inclusive start time aligned to a day (UTC).

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array<Google\Cloud\RecaptchaEnterprise\V1\ScoreMetrics>
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array<Google\Cloud\RecaptchaEnterprise\V1\ChallengeMetrics>
Returns
TypeDescription
$this