PHPFUI/InstaDoc

The request message to annotate an Assessment.

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

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
      Required. The resource name of the Assessment, in the format
      `projects/{project}/assessments/{assessment}`.
@type int $annotation
      Optional. The annotation that is assigned to the Event. This field can be
      left empty to provide reasons that apply to an event without concluding
      whether the event is legitimate or fraudulent.
@type array<int>|\Google\Protobuf\Internal\RepeatedField $reasons
      Optional. Reasons for the annotation that are assigned to the event.
@type string $account_id
      Optional. A stable account identifier to apply to the assessment. This is
      an alternative to setting `account_id` in `CreateAssessment`, for example
      when a stable account identifier is not yet known in the initial request.
@type string $hashed_account_id
      Optional. A stable hashed account identifier to apply to the assessment.
      This is an alternative to setting `hashed_account_id` in
      `CreateAssessment`, for example when a stable account identifier is not yet
      known in the initial request.
@type \Google\Cloud\RecaptchaEnterprise\V1\TransactionEvent $transaction_event
      Optional. If the assessment is part of a payment transaction, provide
      details on payment lifecycle events that occur in the transaction.
@type \Google\Cloud\RecaptchaEnterprise\V1\PhoneAuthenticationEvent $phone_authentication_event
      Optional. If using an external multi-factor authentication provider,
      provide phone authentication details for fraud detection purposes.

}

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

public static build(string $name, int $annotation) : Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest

param string $name Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}. Please see {@see \RecaptchaEnterpriseServiceClient::assessmentName()} for help formatting this field.
param int $annotation Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent. For allowed values, use constants defined on {@see \Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest\Annotation}
return \Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest
experimental

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

ignore

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

Clear all containing fields.

return null

public clearPhoneAuthenticationEvent()

public clearTransactionEvent()

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

Clear all unknown fields previously parsed.

return null

public getAccountId()

Optional. A stable account identifier to apply to the assessment. This is an alternative to setting account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.

Generated from protobuf field string account_id = 7 [(.google.api.field_behavior) = OPTIONAL];

return string

public getAnnotation()

Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation annotation = 2 [(.google.api.field_behavior) = OPTIONAL];

return int

public getHashedAccountId()

Optional. A stable hashed account identifier to apply to the assessment.

This is an alternative to setting hashed_account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.

Generated from protobuf field bytes hashed_account_id = 4 [(.google.api.field_behavior) = OPTIONAL];

return string

public getName()

Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

return string

public getPhoneAuthenticationEvent()

Optional. If using an external multi-factor authentication provider, provide phone authentication details for fraud detection purposes.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.PhoneAuthenticationEvent phone_authentication_event = 6 [(.google.api.field_behavior) = OPTIONAL];

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

public getReasons()

Optional. Reasons for the annotation that are assigned to the event.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason reasons = 3 [(.google.api.field_behavior) = OPTIONAL];

return \Google\Protobuf\Internal\RepeatedField

public getTransactionEvent()

Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL];

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

public hasPhoneAuthenticationEvent()

public hasTransactionEvent()

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

Generated from protobuf field string account_id = 7 [(.google.api.field_behavior) = OPTIONAL];

param string $var
return $this

public setAnnotation( $var)

Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation annotation = 2 [(.google.api.field_behavior) = OPTIONAL];

param int $var
return $this

public setHashedAccountId( $var)

Optional. A stable hashed account identifier to apply to the assessment.

This is an alternative to setting hashed_account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.

Generated from protobuf field bytes hashed_account_id = 4 [(.google.api.field_behavior) = OPTIONAL];

param string $var
return $this

public setName( $var)

Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

param string $var
return $this

public setPhoneAuthenticationEvent( $var)

Optional. If using an external multi-factor authentication provider, provide phone authentication details for fraud detection purposes.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.PhoneAuthenticationEvent phone_authentication_event = 6 [(.google.api.field_behavior) = OPTIONAL];

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

public setReasons( $var)

Optional. Reasons for the annotation that are assigned to the event.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason reasons = 3 [(.google.api.field_behavior) = OPTIONAL];

param int[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

public setTransactionEvent( $var)

Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionEvent transaction_event = 5 [(.google.api.field_behavior) = OPTIONAL];

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

Properties

protected $account_id = ''

Generated from protobuf field string account_id = 7 [(.google.api.field_behavior) = OPTIONAL];

protected $annotation = 0

Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Annotation annotation = 2 [(.google.api.field_behavior) = OPTIONAL];

protected $hashed_account_id = ''

Optional. A stable hashed account identifier to apply to the assessment.

This is an alternative to setting hashed_account_id in CreateAssessment, for example when a stable account identifier is not yet known in the initial request.

Generated from protobuf field bytes hashed_account_id = 4 [(.google.api.field_behavior) = OPTIONAL];

protected $name = ''

Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

Generated from protobuf field string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

protected $phone_authentication_event = NULL

Optional. If using an external multi-factor authentication provider, provide phone authentication details for fraud detection purposes.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.PhoneAuthenticationEvent phone_authentication_event = 6 [(.google.api.field_behavior) = OPTIONAL];

protected $transaction_event = NULL

Optional. If the assessment is part of a payment transaction, provide details on payment lifecycle events that occur in the transaction.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.TransactionEvent transaction_event = 5 [(.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 $reasons = NULL

Optional. Reasons for the annotation that are assigned to the event.

Generated from protobuf field repeated .google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest.Reason reasons = 3 [(.google.api.field_behavior) = OPTIONAL];

Methods

public static build(string $name, int $annotation) : Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest

param string $name Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}. Please see {@see \RecaptchaEnterpriseServiceClient::assessmentName()} for help formatting this field.
param int $annotation Optional. The annotation that is assigned to the Event. This field can be left empty to provide reasons that apply to an event without concluding whether the event is legitimate or fraudulent. For allowed values, use constants defined on {@see \Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest\Annotation}
return \Google\Cloud\RecaptchaEnterprise\V1\AnnotateAssessmentRequest
experimental