PHPFUI/InstaDoc

Information about the IP or IP range override.

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

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Public
Protected

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type string $ip
      Required. The IP address to override (can be IPv4, IPv6 or CIDR).
      The IP override must be a valid IPv4 or IPv6 address, or a CIDR range.
      The IP override must be a public IP address.
      Example of IPv4: 168.192.5.6
      Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B
      Example of IPv4 with CIDR: 168.192.5.0/24
      Example of IPv6 with CIDR: 2001:0DB8:1234::/48
@type int $override_type
      Required. Describes the type of IP override.

}

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 Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getIp()

Required. The IP address to override (can be IPv4, IPv6 or CIDR).

The IP override must be a valid IPv4 or IPv6 address, or a CIDR range. The IP override must be a public IP address. Example of IPv4: 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: 2001:0DB8:1234::/48

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

return string

public getOverrideType()

Required. Describes the type of IP override.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.IpOverrideData.OverrideType override_type = 3 [(.google.api.field_behavior) = REQUIRED];

return int

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

Required. The IP address to override (can be IPv4, IPv6 or CIDR).

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

param string $var
return $this

public setOverrideType( $var)

Required. Describes the type of IP override.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.IpOverrideData.OverrideType override_type = 3 [(.google.api.field_behavior) = REQUIRED];

param int $var
return $this

Properties

protected $ip = ''

Required. The IP address to override (can be IPv4, IPv6 or CIDR).

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

protected $override_type = 0

Required. Describes the type of IP override.

Generated from protobuf field .google.cloud.recaptchaenterprise.v1.IpOverrideData.OverrideType override_type = 3 [(.google.api.field_behavior) = REQUIRED];

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)