Send feedback
Class JwtLocation (2.54.1)
Version 2.54.1keyboard_arrow_down
public final class JwtLocation extends GeneratedMessageV3 implements JwtLocationOrBuilder
Specifies a location to extract JWT from an API request.
Protobuf type google.api.JwtLocation
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
COOKIE_FIELD_NUMBER
public static final int COOKIE_FIELD_NUMBER
Field Value
Type Description
int
public static final int HEADER_FIELD_NUMBER
Field Value
Type Description
int
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int
VALUE_PREFIX_FIELD_NUMBER
public static final int VALUE_PREFIX_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static JwtLocation getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static JwtLocation . Builder newBuilder ()
newBuilder(JwtLocation prototype)
public static JwtLocation . Builder newBuilder ( JwtLocation prototype )
public static JwtLocation parseDelimitedFrom ( InputStream input )
public static JwtLocation parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static JwtLocation parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static JwtLocation parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static JwtLocation parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static JwtLocation parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static JwtLocation parseFrom ( CodedInputStream input )
public static JwtLocation parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static JwtLocation parseFrom ( InputStream input )
public static JwtLocation parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static JwtLocation parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static JwtLocation parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<JwtLocation> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getCookie()
public String getCookie ()
Specifies cookie name to extract JWT token.
string cookie = 4;
Returns
Type Description
String The cookie.
getCookieBytes()
public ByteString getCookieBytes ()
Specifies cookie name to extract JWT token.
string cookie = 4;
Returns
Type Description
ByteString The bytes for cookie.
getDefaultInstanceForType()
public JwtLocation getDefaultInstanceForType ()
public String getHeader ()
Specifies HTTP header name to extract JWT token.
string header = 1;
Returns
Type Description
String The header.
public ByteString getHeaderBytes ()
Specifies HTTP header name to extract JWT token.
string header = 1;
Returns
Type Description
ByteString The bytes for header.
getInCase()
public JwtLocation . InCase getInCase ()
getParserForType()
public Parser<JwtLocation> getParserForType ()
Overrides
getQuery()
Specifies URL query parameter name to extract JWT token.
string query = 2;
Returns
Type Description
String The query.
getQueryBytes()
public ByteString getQueryBytes ()
Specifies URL query parameter name to extract JWT token.
string query = 2;
Returns
Type Description
ByteString The bytes for query.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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;
Returns
Type Description
String The valuePrefix.
getValuePrefixBytes()
public 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
Type Description
ByteString The bytes for valuePrefix.
hasCookie()
public boolean hasCookie ()
Specifies cookie name to extract JWT token.
string cookie = 4;
Returns
Type Description
boolean Whether the cookie field is set.
public boolean hasHeader ()
Specifies HTTP header name to extract JWT token.
string header = 1;
Returns
Type Description
boolean Whether the header field is set.
hasQuery()
public boolean hasQuery ()
Specifies URL query parameter name to extract JWT token.
string query = 2;
Returns
Type Description
boolean Whether the query field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public JwtLocation . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected JwtLocation . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public JwtLocation . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-28 UTC."],[],[]]
