target.apidocs.com.google.api.services.servicemanagement.model.JwtLocation.html Maven / Gradle / Ivy
JwtLocation (Service Management API v1-rev20240823-2.0.0)
com.google.api.services.servicemanagement.model
Class JwtLocation
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.servicemanagement.model.JwtLocation
-
public final class JwtLocation
extends com.google.api.client.json.GenericJson
Specifies a location to extract JWT from an API request.
This is the Java data model class that specifies how to parse/serialize into the JSON that is
transmitted over HTTP when working with the Service Management API. For a detailed explanation
see:
https://developers.google.com/api-client-library/java/google-http-java-client/json
- Author:
- Google, Inc.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Constructor and Description
JwtLocation()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
JwtLocation
clone()
String
getCookie()
Specifies cookie name to extract JWT token.
String
getHeader()
Specifies HTTP header name to extract JWT token.
String
getQuery()
Specifies URL query parameter name to extract JWT token.
String
getValuePrefix()
The value prefix.
JwtLocation
set(String fieldName,
Object value)
JwtLocation
setCookie(String cookie)
Specifies cookie name to extract JWT token.
JwtLocation
setHeader(String header)
Specifies HTTP header name to extract JWT token.
JwtLocation
setQuery(String query)
Specifies URL query parameter name to extract JWT token.
JwtLocation
setValuePrefix(String valuePrefix)
The value prefix.
-
Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString
-
Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Method Detail
-
getCookie
public String getCookie()
Specifies cookie name to extract JWT token.
- Returns:
- value or
null
for none
-
setCookie
public JwtLocation setCookie(String cookie)
Specifies cookie name to extract JWT token.
- Parameters:
cookie
- cookie or null
for none
-
getHeader
public String getHeader()
Specifies HTTP header name to extract JWT token.
- Returns:
- value or
null
for none
-
setHeader
public JwtLocation setHeader(String header)
Specifies HTTP header name to extract JWT token.
- Parameters:
header
- header or null
for none
-
getQuery
public String getQuery()
Specifies URL query parameter name to extract JWT token.
- Returns:
- value or
null
for none
-
setQuery
public JwtLocation setQuery(String query)
Specifies URL query parameter name to extract JWT token.
- Parameters:
query
- query or null
for none
-
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.
- Returns:
- value or
null
for none
-
setValuePrefix
public JwtLocation setValuePrefix(String valuePrefix)
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.
- Parameters:
valuePrefix
- valuePrefix or null
for none
-
set
public JwtLocation set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public JwtLocation clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy