target.apidocs.com.google.api.services.pubsub.model.OidcToken.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-pubsub Show documentation

There is a newer version: v1-rev20240730-2.0.0

Show newest version







OidcToken (Cloud Pub/Sub API v1-rev20240918-2.0.0)











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.pubsub.model
Class OidcToken



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.pubsub.model.OidcToken













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




public final class OidcToken
extends com.google.api.client.json.GenericJson
Contains information needed for generating an [OpenID Connect
 token](https://developers.google.com/identity/protocols/OpenIDConnect).

  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 Cloud Pub/Sub 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>





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








Constructor Summary

Constructors 

Constructor and Description


OidcToken() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


OidcToken
clone() 


String
getAudience()
Optional.



String
getServiceAccountEmail()
Optional.



OidcToken
set(String fieldName,
   Object value) 


OidcToken
setAudience(String audience)
Optional.



OidcToken
setServiceAccountEmail(String serviceAccountEmail)
Optional.







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





OidcToken
public OidcToken()









Method Detail





getAudience
public String getAudience()
Optional. Audience to be used when generating OIDC token. The audience claim identifies the
 recipients that the JWT is intended for. The audience value is a single case-sensitive string.
 Having multiple values (array) for the audience field is not supported. More info about the
 OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not
 specified, the Push endpoint URL will be used.

Returns:
value or null for none








setAudience
public OidcToken setAudience(String audience)
Optional. Audience to be used when generating OIDC token. The audience claim identifies the
 recipients that the JWT is intended for. The audience value is a single case-sensitive string.
 Having multiple values (array) for the audience field is not supported. More info about the
 OIDC JWT token audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if not
 specified, the Push endpoint URL will be used.

Parameters:
audience - audience or null for none








getServiceAccountEmail
public String getServiceAccountEmail()
Optional. [Service account email](https://cloud.google.com/iam/docs/service-accounts) used for
 generating the OIDC token. For more information on setting up authentication, see [Push
 subscriptions](https://cloud.google.com/pubsub/docs/push).

Returns:
value or null for none








setServiceAccountEmail
public OidcToken setServiceAccountEmail(String serviceAccountEmail)
Optional. [Service account email](https://cloud.google.com/iam/docs/service-accounts) used for
 generating the OIDC token. For more information on setting up authentication, see [Push
 subscriptions](https://cloud.google.com/pubsub/docs/push).

Parameters:
serviceAccountEmail - serviceAccountEmail or null for none








set
public OidcToken set(String fieldName,
                     Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public OidcToken clone()

Overrides:
clone in class com.google.api.client.json.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–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`OidcToken`	`clone()`
`String`	`getAudience()` Optional.
`String`	`getServiceAccountEmail()` Optional.
`OidcToken`	`set(String fieldName, Object value)`
`OidcToken`	`setAudience(String audience)` Optional.
`OidcToken`	`setServiceAccountEmail(String serviceAccountEmail)` Optional.