PHPFUI/InstaDoc
 
Copied!

This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request.

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

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $id
      The unique ID for a request, which can be propagated to downstream
      systems. The ID should have low probability of collision
      within a single day for a specific service.
@type string $method
      The HTTP request method, such as `GET`, `POST`.
@type array|\Google\Protobuf\Internal\MapField $headers
      The HTTP request headers. If multiple headers share the same key, they
      must be merged according to the HTTP spec. All header keys must be
      lowercased, because HTTP header keys are case-insensitive.
@type string $path
      The HTTP URL path, excluding the query parameters.
@type string $host
      The HTTP request `Host` header value.
@type string $scheme
      The HTTP URL scheme, such as `http` and `https`.
@type string $query
      The HTTP URL query in the format of `name1=value1&name2=value2`, as it
      appears in the first line of the HTTP request. No decoding is performed.
@type \Google\Protobuf\Timestamp $time
      The timestamp when the `destination` service receives the last byte of
      the request.
@type int|string $size
      The HTTP request size in bytes. If unknown, it must be -1.
@type string $protocol
      The network protocol used with the request, such as "http/1.1",
      "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See
      https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
      for details.
@type string $reason
      A special parameter for request reason. It is used by security systems
      to associate auditing information with a request.
@type \Google\Rpc\Context\AttributeContext\Auth $auth
      The request authentication. May be absent for unauthenticated requests.
      Derived from the HTTP request `Authorization` header or equivalent.
@type string $origin
      The values from Origin header from the HTTP request, such as
      "https://console.cloud.google.com". Modern browsers can only have one
      origin. Special browsers and/or HTTP clients may require multiple
      origins.
    }
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 clearAuth()
public clearTime()
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getAuth()
 

The request authentication. May be absent for unauthenticated requests.

Derived from the HTTP request Authorization header or equivalent.

Generated from protobuf field .google.rpc.context.AttributeContext.Auth auth = 13;

  • return \Google\Rpc\Context\AttributeContext\Auth|null
public getHeaders()
 

The HTTP request headers. If multiple headers share the same key, they must be merged according to the HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.

Generated from protobuf field map<string, string> headers = 3;

  • return \Google\Protobuf\Internal\MapField
public getHost()
 

The HTTP request Host header value.

Generated from protobuf field string host = 5;

  • return string
public getId()
 

The unique ID for a request, which can be propagated to downstream systems. The ID should have low probability of collision within a single day for a specific service.

Generated from protobuf field string id = 1;

  • return string
public getMethod()
 

The HTTP request method, such as GET, POST.

Generated from protobuf field string method = 2;

  • return string
public getOrigin()
 

The values from Origin header from the HTTP request, such as "https://console.cloud.google.com". Modern browsers can only have one origin. Special browsers and/or HTTP clients may require multiple origins.

Generated from protobuf field string origin = 14;

  • return string
public getPath()
 

The HTTP URL path, excluding the query parameters.

Generated from protobuf field string path = 4;

  • return string
public getProtocol()
 

The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for details.

Generated from protobuf field string protocol = 11;

  • return string
public getQuery()
 

The HTTP URL query in the format of name1=value1&name2=value2, as it appears in the first line of the HTTP request. No decoding is performed.

Generated from protobuf field string query = 7;

  • return string
public getReason()
 

A special parameter for request reason. It is used by security systems to associate auditing information with a request.

Generated from protobuf field string reason = 12;

  • return string
public getScheme()
 

The HTTP URL scheme, such as http and https.

Generated from protobuf field string scheme = 6;

  • return string
public getSize()
 

The HTTP request size in bytes. If unknown, it must be -1.

Generated from protobuf field int64 size = 10;

  • return int|string
public getTime()
 

The timestamp when the destination service receives the last byte of the request.

Generated from protobuf field .google.protobuf.Timestamp time = 9;

  • return \Google\Protobuf\Timestamp|null
public hasAuth()
public hasTime()
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 setAuth( $var)
 

The request authentication. May be absent for unauthenticated requests.

Derived from the HTTP request Authorization header or equivalent.

Generated from protobuf field .google.rpc.context.AttributeContext.Auth auth = 13;

  • param \Google\Rpc\Context\AttributeContext\Auth $var
  • return $this
public setHeaders( $var)
 

The HTTP request headers. If multiple headers share the same key, they must be merged according to the HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.

Generated from protobuf field map<string, string> headers = 3;

  • param array|\Google\Protobuf\Internal\MapField $var
  • return $this
public setHost( $var)
 

The HTTP request Host header value.

Generated from protobuf field string host = 5;

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

The unique ID for a request, which can be propagated to downstream systems. The ID should have low probability of collision within a single day for a specific service.

Generated from protobuf field string id = 1;

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

The HTTP request method, such as GET, POST.

Generated from protobuf field string method = 2;

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

The values from Origin header from the HTTP request, such as "https://console.cloud.google.com". Modern browsers can only have one origin. Special browsers and/or HTTP clients may require multiple origins.

Generated from protobuf field string origin = 14;

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

The HTTP URL path, excluding the query parameters.

Generated from protobuf field string path = 4;

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

The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for details.

Generated from protobuf field string protocol = 11;

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

The HTTP URL query in the format of name1=value1&name2=value2, as it appears in the first line of the HTTP request. No decoding is performed.

Generated from protobuf field string query = 7;

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

A special parameter for request reason. It is used by security systems to associate auditing information with a request.

Generated from protobuf field string reason = 12;

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

The HTTP URL scheme, such as http and https.

Generated from protobuf field string scheme = 6;

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

The HTTP request size in bytes. If unknown, it must be -1.

Generated from protobuf field int64 size = 10;

  • param int|string $var
  • return $this
public setTime( $var)
 

The timestamp when the destination service receives the last byte of the request.

Generated from protobuf field .google.protobuf.Timestamp time = 9;

  • param \Google\Protobuf\Timestamp $var
  • return $this
Properties
protected $auth = NULL
 

The request authentication. May be absent for unauthenticated requests.

Derived from the HTTP request Authorization header or equivalent.

Generated from protobuf field .google.rpc.context.AttributeContext.Auth auth = 13;

protected $host = ''
 

The HTTP request Host header value.

Generated from protobuf field string host = 5;

protected $id = ''
 

The unique ID for a request, which can be propagated to downstream systems. The ID should have low probability of collision within a single day for a specific service.

Generated from protobuf field string id = 1;

protected $method = ''
 

The HTTP request method, such as GET, POST.

Generated from protobuf field string method = 2;

protected $origin = ''
 

The values from Origin header from the HTTP request, such as "https://console.cloud.google.com". Modern browsers can only have one origin. Special browsers and/or HTTP clients may require multiple origins.

Generated from protobuf field string origin = 14;

protected $path = ''
 

The HTTP URL path, excluding the query parameters.

Generated from protobuf field string path = 4;

protected $protocol = ''
 

The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for details.

Generated from protobuf field string protocol = 11;

protected $query = ''
 

The HTTP URL query in the format of name1=value1&name2=value2, as it appears in the first line of the HTTP request. No decoding is performed.

Generated from protobuf field string query = 7;

protected $reason = ''
 

A special parameter for request reason. It is used by security systems to associate auditing information with a request.

Generated from protobuf field string reason = 12;

protected $scheme = ''
 

The HTTP URL scheme, such as http and https.

Generated from protobuf field string scheme = 6;

protected $size = 0
 

The HTTP request size in bytes. If unknown, it must be -1.

Generated from protobuf field int64 size = 10;

protected $time = NULL
 

The timestamp when the destination service receives the last byte of the request.

Generated from protobuf field .google.protobuf.Timestamp time = 9;

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

The HTTP request headers. If multiple headers share the same key, they must be merged according to the HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.

Generated from protobuf field map<string, string> headers = 3;

© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration