PHPFUI/InstaDoc
 
Copied!

Specifies a location to extract JWT from an API request.

Generated from protobuf message google.api.JwtLocation

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $header
      Specifies HTTP header name to extract JWT token.
@type string $query
      Specifies URL query parameter name to extract JWT token.
@type string $cookie
      Specifies cookie name to extract JWT token.
@type string $value_prefix
      The value prefix. The value format is "value_prefix{token}"
      Only applies to "in" header type. Must be empty for "in" query type.
      If not empty, the header value has to match (case sensitive) this prefix.
      If not matched, JWT will not be extracted. If matched, JWT will be
      extracted after the prefix is removed.
      For example, for "Authorization: Bearer {JWT}",
      value_prefix="Bearer " with a space at the end.
    }
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 getCookie()
 

Specifies cookie name to extract JWT token.

Generated from protobuf field string cookie = 4;

  • return string
public getHeader()
 

Specifies HTTP header name to extract JWT token.

Generated from protobuf field string header = 1;

  • return string
public getIn()
 
  • return string
public getQuery()
 

Specifies URL query parameter name to extract JWT token.

Generated from protobuf field string query = 2;

  • return string
public getValuePrefix()
 

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type.

If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

Generated from protobuf field string value_prefix = 3;

  • return string
public hasCookie()
public hasHeader()
public hasQuery()
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 setCookie( $var)
 

Specifies cookie name to extract JWT token.

Generated from protobuf field string cookie = 4;

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

Specifies HTTP header name to extract JWT token.

Generated from protobuf field string header = 1;

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

Specifies URL query parameter name to extract JWT token.

Generated from protobuf field string query = 2;

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

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type.

If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

Generated from protobuf field string value_prefix = 3;

  • param string $var
  • return $this
Properties
protected $in = NULL
protected $value_prefix = ''
 

The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type.

If not empty, the header value has to match (case sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}", value_prefix="Bearer " with a space at the end.

Generated from protobuf field string value_prefix = 3;

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