PHPFUI/InstaDoc

Metrics for a single Key.

Generated from protobuf message google.cloud.recaptchaenterprise.v1.Metrics

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
      Output only. Identifier. The name of the metrics, in the format
      `projects/{project}/keys/{key}/metrics`.
@type \Google\Protobuf\Timestamp $start_time
      Inclusive start time aligned to a day in the America/Los_Angeles (Pacific)
      timezone.
@type array<\Google\Cloud\RecaptchaEnterprise\V1\ScoreMetrics>|\Google\Protobuf\Internal\RepeatedField $score_metrics
      Metrics are continuous and in order by dates, and in the granularity
      of day. All Key types should have score-based data.
@type array<\Google\Cloud\RecaptchaEnterprise\V1\ChallengeMetrics>|\Google\Protobuf\Internal\RepeatedField $challenge_metrics
      Metrics are continuous and in order by dates, and in the granularity
      of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have
      challenge-based data.

}

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 clearStartTime()

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

Clear all unknown fields previously parsed.

return null

public getChallengeMetrics()

Metrics are continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have challenge-based data.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.ChallengeMetrics challenge_metrics = 3;

return \Google\Protobuf\Internal\RepeatedField

public getName()

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

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

return string

public getScoreMetrics()

Metrics are continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.ScoreMetrics score_metrics = 2;

return \Google\Protobuf\Internal\RepeatedField

public getStartTime()

Inclusive start time aligned to a day in the America/Los_Angeles (Pacific) timezone.

Generated from protobuf field .google.protobuf.Timestamp start_time = 1;

return \Google\Protobuf\Timestamp|null

public hasStartTime()

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 setChallengeMetrics( $var)

Metrics are continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have challenge-based data.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.ChallengeMetrics challenge_metrics = 3;

param \Google\Cloud\RecaptchaEnterprise\V1\ChallengeMetrics[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

public setName( $var)

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

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

param string $var
return $this

public setScoreMetrics( $var)

Metrics are continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.ScoreMetrics score_metrics = 2;

param \Google\Cloud\RecaptchaEnterprise\V1\ScoreMetrics[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

public setStartTime( $var)

Inclusive start time aligned to a day in the America/Los_Angeles (Pacific) timezone.

Generated from protobuf field .google.protobuf.Timestamp start_time = 1;

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

Properties

protected $name = ''

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

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

protected $start_time = NULL

Inclusive start time aligned to a day in the America/Los_Angeles (Pacific) timezone.

Generated from protobuf field .google.protobuf.Timestamp start_time = 1;

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 $challenge_metrics = NULL

Metrics are continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE) have challenge-based data.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.ChallengeMetrics challenge_metrics = 3;

private $score_metrics = NULL

Metrics are continuous and in order by dates, and in the granularity of day. All Key types should have score-based data.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.ScoreMetrics score_metrics = 2;