com.google.api.services.iamcredentials.v1.model

Class GenerateAccessTokenRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.iamcredentials.v1.model.GenerateAccessTokenRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GenerateAccessTokenRequest
extends com.google.api.client.json.GenericJson

Model definition for GenerateAccessTokenRequest.

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 IAM Service Account Credentials 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
GenerateAccessTokenRequest()

Method Summary

Modifier and Type	Method and Description
GenerateAccessTokenRequest	clone()
List<String>	getDelegates() The sequence of service accounts in a delegation chain.
String	getLifetime() The desired lifetime duration of the access token in seconds.
List<String>	getScope() Required.
GenerateAccessTokenRequest	set(String fieldName, Object value)
GenerateAccessTokenRequest	setDelegates(List<String> delegates) The sequence of service accounts in a delegation chain.
GenerateAccessTokenRequest	setLifetime(String lifetime) The desired lifetime duration of the access token in seconds.
GenerateAccessTokenRequest	setScope(List<String> scope) Required.

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

GenerateAccessTokenRequest

public GenerateAccessTokenRequest()

Method Detail

getDelegates

public List<String> getDelegates()

The sequence of service accounts in a delegation chain. This field is required for [delegated requests](https://cloud.google.com/iam/help/credentials/delegated-request). For [direct requests](https://cloud.google.com/iam/help/credentials/direct-request), which are more common, do not specify this field. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid.

Returns:

value or null for none

setDelegates

public GenerateAccessTokenRequest setDelegates(List<String> delegates)

The sequence of service accounts in a delegation chain. This field is required for [delegated requests](https://cloud.google.com/iam/help/credentials/delegated-request). For [direct requests](https://cloud.google.com/iam/help/credentials/direct-request), which are more common, do not specify this field. Each service account must be granted the `roles/iam.serviceAccountTokenCreator` role on its next service account in the chain. The last service account in the chain must be granted the `roles/iam.serviceAccountTokenCreator` role on the service account that is specified in the `name` field of the request. The delegates must have the following format: `projects/-/serviceAccounts/{ACCOUNT_EMAIL_OR_UNIQUEID}`. The `-` wildcard character is required; replacing it with a project ID is invalid.

Parameters:

delegates - delegates or null for none

getLifetime

public String getLifetime()

The desired lifetime duration of the access token in seconds. By default, the maximum allowed value is 1 hour. To set a lifetime of up to 12 hours, you can add the service account as an allowed value in an Organization Policy that enforces the `constraints/iam.allowServiceAccountCredentialLifetimeExtension` constraint. See detailed instructions at https://cloud.google.com/iam/help/credentials/lifetime If a value is not specified, the token's lifetime will be set to a default value of 1 hour.

Returns:

value or null for none

setLifetime

public GenerateAccessTokenRequest setLifetime(String lifetime)

The desired lifetime duration of the access token in seconds. By default, the maximum allowed value is 1 hour. To set a lifetime of up to 12 hours, you can add the service account as an allowed value in an Organization Policy that enforces the `constraints/iam.allowServiceAccountCredentialLifetimeExtension` constraint. See detailed instructions at https://cloud.google.com/iam/help/credentials/lifetime If a value is not specified, the token's lifetime will be set to a default value of 1 hour.

Parameters:

lifetime - lifetime or null for none

getScope

public List<String> getScope()

Required. Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required.

Returns:

value or null for none

setScope

public GenerateAccessTokenRequest setScope(List<String> scope)

Required. Code to identify the scopes to be included in the OAuth 2.0 access token. See https://developers.google.com/identity/protocols/googlescopes for more information. At least one value required.

Parameters:

scope - scope or null for none

set

public GenerateAccessTokenRequest set(String fieldName,
                                      Object value)

Overrides:

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

clone

public GenerateAccessTokenRequest clone()

Overrides:

clone in class com.google.api.client.json.GenericJson