Package com.google.api

Interface JwtLocationOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    JwtLocation, JwtLocation.Builder
    public interface JwtLocationOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getCookie()
      Specifies cookie name to extract JWT token.
      com.google.protobuf.ByteString getCookieBytes()
      Specifies cookie name to extract JWT token.
      String getHeader()
      Specifies HTTP header name to extract JWT token.
      com.google.protobuf.ByteString getHeaderBytes()
      Specifies HTTP header name to extract JWT token.
      JwtLocation.InCase getInCase()  
      String getQuery()
      Specifies URL query parameter name to extract JWT token.
      com.google.protobuf.ByteString getQueryBytes()
      Specifies URL query parameter name to extract JWT token.
      String getValuePrefix()
      The value prefix.
      com.google.protobuf.ByteString getValuePrefixBytes()
      The value prefix.
      boolean hasCookie()
      Specifies cookie name to extract JWT token.
      boolean hasHeader()
      Specifies HTTP header name to extract JWT token.
      boolean hasQuery()
      Specifies URL query parameter name to extract JWT token.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasHeader

        boolean hasHeader()
         Specifies HTTP header name to extract JWT token.
        string header = 1;
        Returns:
        Whether the header field is set.

      • getHeader

        String getHeader()
         Specifies HTTP header name to extract JWT token.
        string header = 1;
        Returns:
        The header.

      • getHeaderBytes

        com.google.protobuf.ByteString getHeaderBytes()
         Specifies HTTP header name to extract JWT token.
        string header = 1;
        Returns:
        The bytes for header.

      • hasQuery

        boolean hasQuery()
         Specifies URL query parameter name to extract JWT token.
        string query = 2;
        Returns:
        Whether the query field is set.

      • getQuery

        String getQuery()
         Specifies URL query parameter name to extract JWT token.
        string query = 2;
        Returns:
        The query.

      • getQueryBytes

        com.google.protobuf.ByteString getQueryBytes()
         Specifies URL query parameter name to extract JWT token.
        string query = 2;
        Returns:
        The bytes for query.

      • hasCookie

        boolean hasCookie()
         Specifies cookie name to extract JWT token.
        string cookie = 4;
        Returns:
        Whether the cookie field is set.

      • getCookie

        String getCookie()
         Specifies cookie name to extract JWT token.
        string cookie = 4;
        Returns:
        The cookie.

      • getCookieBytes

        com.google.protobuf.ByteString getCookieBytes()
         Specifies cookie name to extract JWT token.
        string cookie = 4;
        Returns:
        The bytes for cookie.

      • getValuePrefix

        String 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.
        string value_prefix = 3;
        Returns:
        The valuePrefix.

      • getValuePrefixBytes

        com.google.protobuf.ByteString getValuePrefixBytes()
         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.
        string value_prefix = 3;
        Returns:
        The bytes for valuePrefix.