Send feedback
Class JwtLocation (2.14.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.14.1 keyboard_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
Static Fields
COOKIE_FIELD_NUMBER
public static final int COOKIE_FIELD_NUMBER
Field Value
public static final int HEADER_FIELD_NUMBER
Field Value
QUERY_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
Field Value
VALUE_PREFIX_FIELD_NUMBER
public static final int VALUE_PREFIX_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static JwtLocation getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static JwtLocation . Builder newBuilder ()
Returns
newBuilder(JwtLocation prototype)
public static JwtLocation . Builder newBuilder ( JwtLocation prototype )
Parameter
Returns
public static JwtLocation parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static JwtLocation parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static JwtLocation parseFrom ( byte [] data )
Parameter
Name Description databyte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static JwtLocation parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static JwtLocation parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static JwtLocation parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static JwtLocation parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static JwtLocation parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static JwtLocation parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static JwtLocation parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static JwtLocation parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static JwtLocation parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<JwtLocation> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
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
getDefaultInstanceForType()
public JwtLocation getDefaultInstanceForType ()
Returns
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
getInCase()
public JwtLocation . InCase getInCase ()
Returns
getParserForType()
public Parser<JwtLocation> getParserForType ()
Returns
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
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public JwtLocation . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected JwtLocation . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public JwtLocation . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
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-01-21 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-01-21 UTC."],[],[]]
