PHPFUI/InstaDoc

This message defines attributes for a node that handles a network request.

The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in principal and labels as appropriate.

Generated from protobuf message google.rpc.context.AttributeContext.Peer

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

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

@type string $ip
      The IP address of the peer.
@type int|string $port
      The network port of the peer.
@type array|\Google\Protobuf\Internal\MapField $labels
      The labels associated with the peer.
@type string $principal
      The identity of this peer. Similar to `Request.auth.principal`, but
      relative to the peer instead of the request. For example, the
      identity associated with a load balancer that forwarded the request.
@type string $region_code
      The CLDR country/region code associated with the above IP address.
      If the IP address is private, the `region_code` should reflect the
      physical location where this peer is running.

}

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

The IP address of the peer.

Generated from protobuf field string ip = 1;

return string

public getLabels()

The labels associated with the peer.

Generated from protobuf field map<string, string> labels = 6;

return \Google\Protobuf\Internal\MapField

public getPort()

The network port of the peer.

Generated from protobuf field int64 port = 2;

return int|string

public getPrincipal()

The identity of this peer. Similar to Request.auth.principal, but relative to the peer instead of the request. For example, the identity associated with a load balancer that forwarded the request.

Generated from protobuf field string principal = 7;

return string

public getRegionCode()

The CLDR country/region code associated with the above IP address.

If the IP address is private, the region_code should reflect the physical location where this peer is running.

Generated from protobuf field string region_code = 8;

return string

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)

The IP address of the peer.

Generated from protobuf field string ip = 1;

param string $var
return $this

public setLabels( $var)

The labels associated with the peer.

Generated from protobuf field map<string, string> labels = 6;

param array|\Google\Protobuf\Internal\MapField $var
return $this

public setPort( $var)

The network port of the peer.

Generated from protobuf field int64 port = 2;

param int|string $var
return $this

public setPrincipal( $var)

The identity of this peer. Similar to Request.auth.principal, but relative to the peer instead of the request. For example, the identity associated with a load balancer that forwarded the request.

Generated from protobuf field string principal = 7;

param string $var
return $this

public setRegionCode( $var)

The CLDR country/region code associated with the above IP address.

If the IP address is private, the region_code should reflect the physical location where this peer is running.

Generated from protobuf field string region_code = 8;

param string $var
return $this

Properties

protected $ip = ''

The IP address of the peer.

Generated from protobuf field string ip = 1;

protected $port = 0

The network port of the peer.

Generated from protobuf field int64 port = 2;

protected $principal = ''

The identity of this peer. Similar to Request.auth.principal, but relative to the peer instead of the request. For example, the identity associated with a load balancer that forwarded the request.

Generated from protobuf field string principal = 7;

protected $region_code = ''

The CLDR country/region code associated with the above IP address.

If the IP address is private, the region_code should reflect the physical location where this peer is running.

Generated from protobuf field string region_code = 8;

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

The labels associated with the peer.

Generated from protobuf field map<string, string> labels = 6;