target.apidocs.com.google.api.services.compute.model.Jwt.html Maven / Gradle / Ivy

Go to download







Jwt (Compute Engine API alpha-rev20200526-1.30.9)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class Jwt



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.compute.model.Jwt













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class Jwt
extends GenericJson
[Deprecated] JWT configuration for origin authentication. JWT configuration for origin
 authentication.

  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 Compute Engine 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
GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


Jwt() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Jwt
clone() 


List<String>
getAudiences()
A JWT containing any of these audiences will be accepted.



String
getIssuer()
Identifies the issuer that issued the JWT, which is usually a URL or an email address.



String
getJwksPublicKeys()
The provider's public key set to validate the signature of the JWT.



List<JwtHeader>
getJwtHeaders()
jwt_headers and jwt_params define where to extract the JWT from an HTTP request.



List<String>
getJwtParams()
This field is set if JWT is sent in a query parameter.



Jwt
set(String fieldName,
   Object value) 


Jwt
setAudiences(List<String> audiences)
A JWT containing any of these audiences will be accepted.



Jwt
setIssuer(String issuer)
Identifies the issuer that issued the JWT, which is usually a URL or an email address.



Jwt
setJwksPublicKeys(String jwksPublicKeys)
The provider's public key set to validate the signature of the JWT.



Jwt
setJwtHeaders(List<JwtHeader> jwtHeaders)
jwt_headers and jwt_params define where to extract the JWT from an HTTP request.



Jwt
setJwtParams(List<String> jwtParams)
This field is set if JWT is sent in a query parameter.







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














Constructor Detail





Jwt
public Jwt()









Method Detail





getAudiences
public List<String> getAudiences()
A JWT containing any of these audiences will be accepted. The service name will be accepted if
 audiences is empty. Examples: bookstore_android.apps.googleusercontent.com,
 bookstore_web.apps.googleusercontent.com

Returns:
value or null for none








setAudiences
public Jwt setAudiences(List<String> audiences)
A JWT containing any of these audiences will be accepted. The service name will be accepted if
 audiences is empty. Examples: bookstore_android.apps.googleusercontent.com,
 bookstore_web.apps.googleusercontent.com

Parameters:
audiences - audiences or null for none








getIssuer
public String getIssuer()
Identifies the issuer that issued the JWT, which is usually a URL or an email address.
 Examples: https://securetoken.google.com, [email protected]

Returns:
value or null for none








setIssuer
public Jwt setIssuer(String issuer)
Identifies the issuer that issued the JWT, which is usually a URL or an email address.
 Examples: https://securetoken.google.com, [email protected]

Parameters:
issuer - issuer or null for none








getJwksPublicKeys
public String getJwksPublicKeys()
The provider's public key set to validate the signature of the JWT.

Returns:
value or null for none








setJwksPublicKeys
public Jwt setJwksPublicKeys(String jwksPublicKeys)
The provider's public key set to validate the signature of the JWT.

Parameters:
jwksPublicKeys - jwksPublicKeys or null for none








getJwtHeaders
public List<JwtHeader> getJwtHeaders()
jwt_headers and jwt_params define where to extract the JWT from an HTTP request. If no explicit
 location is specified, the following default locations are tried in order:

 1. The Authorization header using the Bearer schema. See `here `_. Example:

 Authorization: Bearer .

 2. `access_token` query parameter. See `this `_

 Multiple JWTs can be verified for a request. Each JWT has to be extracted from the locations
 its issuer specified or from the default locations.

 This field is set if JWT is sent in a request header. This field specifies the header name. For
 example, if `header=x-goog-iap-jwt-assertion`, the header format will be x-goog-iap-jwt-
 assertion: .

Returns:
value or null for none








setJwtHeaders
public Jwt setJwtHeaders(List<JwtHeader> jwtHeaders)
jwt_headers and jwt_params define where to extract the JWT from an HTTP request. If no explicit
 location is specified, the following default locations are tried in order:

 1. The Authorization header using the Bearer schema. See `here `_. Example:

 Authorization: Bearer .

 2. `access_token` query parameter. See `this `_

 Multiple JWTs can be verified for a request. Each JWT has to be extracted from the locations
 its issuer specified or from the default locations.

 This field is set if JWT is sent in a request header. This field specifies the header name. For
 example, if `header=x-goog-iap-jwt-assertion`, the header format will be x-goog-iap-jwt-
 assertion: .

Parameters:
jwtHeaders - jwtHeaders or null for none








getJwtParams
public List<String> getJwtParams()
This field is set if JWT is sent in a query parameter. This field specifies the query parameter
 name. For example, if jwt_params[0] is jwt_token, the JWT format in the query parameter is
 /path?jwt_token=.

Returns:
value or null for none








setJwtParams
public Jwt setJwtParams(List<String> jwtParams)
This field is set if JWT is sent in a query parameter. This field specifies the query parameter
 name. For example, if jwt_params[0] is jwt_token, the JWT format in the query parameter is
 /path?jwt_token=.

Parameters:
jwtParams - jwtParams or null for none








set
public Jwt set(String fieldName,
               Object value)

Overrides:
set in class GenericJson








clone
public Jwt clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.

Modifier and Type	Method and Description
`Jwt`	`clone()`
`List<String>`	`getAudiences()` A JWT containing any of these audiences will be accepted.
`String`	`getIssuer()` Identifies the issuer that issued the JWT, which is usually a URL or an email address.
`String`	`getJwksPublicKeys()` The provider's public key set to validate the signature of the JWT.
`List<JwtHeader>`	`getJwtHeaders()` jwt_headers and jwt_params define where to extract the JWT from an HTTP request.
`List<String>`	`getJwtParams()` This field is set if JWT is sent in a query parameter.
`Jwt`	`set(String fieldName, Object value)`
`Jwt`	`setAudiences(List<String> audiences)` A JWT containing any of these audiences will be accepted.
`Jwt`	`setIssuer(String issuer)` Identifies the issuer that issued the JWT, which is usually a URL or an email address.
`Jwt`	`setJwksPublicKeys(String jwksPublicKeys)` The provider's public key set to validate the signature of the JWT.
`Jwt`	`setJwtHeaders(List<JwtHeader> jwtHeaders)` jwt_headers and jwt_params define where to extract the JWT from an HTTP request.
`Jwt`	`setJwtParams(List<String> jwtParams)` This field is set if JWT is sent in a query parameter.