com.google.api.services.iam.v1.model

Class WorkforcePool

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.iam.v1.model.WorkforcePool

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Represents a collection of external workforces. Provides namespaces for federated users that can be referenced in IAM policies.

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 Identity and Access Management (IAM) 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
WorkforcePool()

Method Summary

Modifier and Type	Method and Description
WorkforcePool	clone()
String	getDescription() A user-specified description of the pool.
Boolean	getDisabled() Disables the workforce pool.
String	getDisplayName() A user-specified display name of the pool in Google Cloud Console.
String	getName() Output only.
String	getParent() Immutable.
String	getSessionDuration() Duration that the Google Cloud access tokens, console sign-in sessions, and `gcloud` sign-in sessions from this pool are valid.
String	getState() Output only.
WorkforcePool	set(String fieldName, Object value)
WorkforcePool	setDescription(String description) A user-specified description of the pool.
WorkforcePool	setDisabled(Boolean disabled) Disables the workforce pool.
WorkforcePool	setDisplayName(String displayName) A user-specified display name of the pool in Google Cloud Console.
WorkforcePool	setName(String name) Output only.
WorkforcePool	setParent(String parent) Immutable.
WorkforcePool	setSessionDuration(String sessionDuration) Duration that the Google Cloud access tokens, console sign-in sessions, and `gcloud` sign-in sessions from this pool are valid.
WorkforcePool	setState(String state) Output only.

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

WorkforcePool

public WorkforcePool()

Method Detail

getDescription

public String getDescription()

A user-specified description of the pool. Cannot exceed 256 characters.

Returns:

value or null for none

setDescription

public WorkforcePool setDescription(String description)

A user-specified description of the pool. Cannot exceed 256 characters.

Parameters:

description - description or null for none

getDisabled

public Boolean getDisabled()

Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.

Returns:

value or null for none

setDisabled

public WorkforcePool setDisabled(Boolean disabled)

Disables the workforce pool. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again.

Parameters:

disabled - disabled or null for none

getDisplayName

public String getDisplayName()

A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.

Returns:

value or null for none

setDisplayName

public WorkforcePool setDisplayName(String displayName)

A user-specified display name of the pool in Google Cloud Console. Cannot exceed 32 characters.

Parameters:

displayName - displayName or null for none

getName

public String getName()

Output only. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`

Returns:

value or null for none

setName

public WorkforcePool setName(String name)

Output only. The resource name of the pool. Format: `locations/{location}/workforcePools/{workforce_pool_id}`

Parameters:

name - name or null for none

getParent

public String getParent()

Immutable. The resource name of the parent. Format: `organizations/{org-id}`.

Returns:

value or null for none

setParent

public WorkforcePool setParent(String parent)

Immutable. The resource name of the parent. Format: `organizations/{org-id}`.

Parameters:

parent - parent or null for none

getSessionDuration

public String getSessionDuration()

Duration that the Google Cloud access tokens, console sign-in sessions, and `gcloud` sign-in sessions from this pool are valid. Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If `session_duration` is not configured, minted credentials have a default duration of one hour (3600s). For SAML providers, the lifetime of the token is the minimum of the `session_duration` and the `SessionNotOnOrAfter` claim in the SAML assertion.

Returns:

value or null for none

setSessionDuration

public WorkforcePool setSessionDuration(String sessionDuration)

Duration that the Google Cloud access tokens, console sign-in sessions, and `gcloud` sign-in sessions from this pool are valid. Must be greater than 15 minutes (900s) and less than 12 hours (43200s). If `session_duration` is not configured, minted credentials have a default duration of one hour (3600s). For SAML providers, the lifetime of the token is the minimum of the `session_duration` and the `SessionNotOnOrAfter` claim in the SAML assertion.

Parameters:

sessionDuration - sessionDuration or null for none

getState

public String getState()

Output only. The state of the pool.

Returns:

value or null for none

setState

public WorkforcePool setState(String state)

Output only. The state of the pool.

Parameters:

state - state or null for none

set

public WorkforcePool set(String fieldName,
                         Object value)

Overrides:

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

clone

public WorkforcePool clone()

Overrides:

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