Copied!

Information about a verification endpoint that can be used for 2FA.

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

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object.
    @type string $email_address
          Email address for which to trigger a verification request.
    @type string $phone_number
          Phone number for which to trigger a verification request. Should be given
          in E.164 format.
    @type string $request_token
          Output only. Token to provide to the client to trigger endpoint
          verification. It must be used within 15 minutes.
    @type \Google\Protobuf\Timestamp $last_verification_time
          Output only. Timestamp of the last successful verification for the
          endpoint, if any.
    
    }
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 clearLastVerificationTime()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getEmailAddress()
 

Email address for which to trigger a verification request.

Generated from protobuf field string email_address = 1;

  • return string
public getEndpoint()
 
  • return string
public getLastVerificationTime()
 

Output only. Timestamp of the last successful verification for the endpoint, if any.

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

  • return \Google\Protobuf\Timestamp|null
public getPhoneNumber()
 

Phone number for which to trigger a verification request. Should be given in E.164 format.

Generated from protobuf field string phone_number = 2;

  • return string
public getRequestToken()
 

Output only. Token to provide to the client to trigger endpoint verification. It must be used within 15 minutes.

Generated from protobuf field string request_token = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

  • return string
public hasEmailAddress()
public hasLastVerificationTime()
public hasPhoneNumber()
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 setEmailAddress( $var)
 

Email address for which to trigger a verification request.

Generated from protobuf field string email_address = 1;

  • param string $var
  • return $this
public setLastVerificationTime( $var)
 

Output only. Timestamp of the last successful verification for the endpoint, if any.

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

  • param \Google\Protobuf\Timestamp $var
  • return $this
public setPhoneNumber( $var)
 

Phone number for which to trigger a verification request. Should be given in E.164 format.

Generated from protobuf field string phone_number = 2;

  • param string $var
  • return $this
public setRequestToken( $var)
 

Output only. Token to provide to the client to trigger endpoint verification. It must be used within 15 minutes.

Generated from protobuf field string request_token = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

  • param string $var
  • return $this
Properties
protected $endpoint = NULL
protected $last_verification_time = NULL
 

Output only. Timestamp of the last successful verification for the endpoint, if any.

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

protected $request_token = ''
 

Output only. Token to provide to the client to trigger endpoint verification. It must be used within 15 minutes.

Generated from protobuf field string request_token = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

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)
© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration