Package com.google.api

Class JwtLocation

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.api.JwtLocation
All Implemented Interfaces:
JwtLocationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class JwtLocation extends com.google.protobuf.GeneratedMessageV3 implements JwtLocationOrBuilder
 Specifies a location to extract JWT from an API request.
Protobuf type google.api.JwtLocation
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    JwtLocation.Builder
    Specifies a location to extract JWT from an API request.
    static enum 
    JwtLocation.InCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    HEADER_FIELD_NUMBER
     
    static final int
    QUERY_FIELD_NUMBER
     
    static final int
    VALUE_PREFIX_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static JwtLocation
    getDefaultInstance()
     
    JwtLocation
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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()
     
    com.google.protobuf.Parser<JwtLocation>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    String
    getValuePrefix()
    The value prefix.
    com.google.protobuf.ByteString
    getValuePrefixBytes()
    The value prefix.
    int
    hashCode()
     
    boolean
    hasHeader()
    Specifies HTTP header name to extract JWT token.
    boolean
    hasQuery()
    Specifies URL query parameter name to extract JWT token.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static JwtLocation.Builder
    newBuilder()
     
    static JwtLocation.Builder
    newBuilder(JwtLocation prototype)
     
    JwtLocation.Builder
    newBuilderForType()
     
    protected JwtLocation.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static JwtLocation
    parseDelimitedFrom(InputStream input)
     
    static JwtLocation
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JwtLocation
    parseFrom(byte[] data)
     
    static JwtLocation
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JwtLocation
    parseFrom(com.google.protobuf.ByteString data)
     
    static JwtLocation
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JwtLocation
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static JwtLocation
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JwtLocation
    parseFrom(InputStream input)
     
    static JwtLocation
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static JwtLocation
    parseFrom(ByteBuffer data)
     
    static JwtLocation
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<JwtLocation>
    parser()
     
    JwtLocation.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getInCase

      public JwtLocation.InCase getInCase()
      Specified by:
      getInCase in interface JwtLocationOrBuilder

    • hasHeader

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

    • getHeader

      public String getHeader()
       Specifies HTTP header name to extract JWT token.
      string header = 1;
      Specified by:
      getHeader in interface JwtLocationOrBuilder
      Returns:
      The header.

    • getHeaderBytes

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

    • hasQuery

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

    • getQuery

      public String getQuery()
       Specifies URL query parameter name to extract JWT token.
      string query = 2;
      Specified by:
      getQuery in interface JwtLocationOrBuilder
      Returns:
      The query.

    • getQueryBytes

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

    • getValuePrefix

      public 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;
      Specified by:
      getValuePrefix in interface JwtLocationOrBuilder
      Returns:
      The valuePrefix.

    • getValuePrefixBytes

      public 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;
      Specified by:
      getValuePrefixBytes in interface JwtLocationOrBuilder
      Returns:
      The bytes for valuePrefix.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static JwtLocation parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static JwtLocation parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static JwtLocation parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static JwtLocation parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static JwtLocation parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static JwtLocation parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static JwtLocation parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static JwtLocation parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static JwtLocation parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static JwtLocation parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static JwtLocation parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static JwtLocation parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public JwtLocation.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static JwtLocation.Builder newBuilder()

    • newBuilder

      public static JwtLocation.Builder newBuilder(JwtLocation prototype)

    • toBuilder

      public JwtLocation.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected JwtLocation.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static JwtLocation getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<JwtLocation> parser()

    • getParserForType

      public com.google.protobuf.Parser<JwtLocation> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public JwtLocation getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder