OauthClient (Identity and Access Management (IAM) API v1-rev20241114-2.0.0)

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.OauthClient

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class OauthClient
extends com.google.api.client.json.GenericJson
```
Represents an OauthClient. Used to access Google Cloud resources on behalf of a Workforce Identity Federation user by using OAuth 2.0 Protocol to obtain an access token from Google Cloud.
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

OauthClient()

Constructors
Constructor and Description
`OauthClient()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OauthClient`	`clone()`
`List<String>`	`getAllowedGrantTypes()` Required.
`List<String>`	`getAllowedRedirectUris()` Required.
`List<String>`	`getAllowedScopes()` Required.
`String`	`getClientId()` Output only.
`String`	`getClientType()` Immutable.
`String`	`getDescription()` Optional.
`Boolean`	`getDisabled()` Optional.
`String`	`getDisplayName()` Optional.
`String`	`getExpireTime()` Output only.
`String`	`getName()` Immutable.
`String`	`getState()` Output only.
`OauthClient`	`set(String fieldName, Object value)`
`OauthClient`	`setAllowedGrantTypes(List<String> allowedGrantTypes)` Required.
`OauthClient`	`setAllowedRedirectUris(List<String> allowedRedirectUris)` Required.
`OauthClient`	`setAllowedScopes(List<String> allowedScopes)` Required.
`OauthClient`	`setClientId(String clientId)` Output only.
`OauthClient`	`setClientType(String clientType)` Immutable.
`OauthClient`	`setDescription(String description)` Optional.
`OauthClient`	`setDisabled(Boolean disabled)` Optional.
`OauthClient`	`setDisplayName(String displayName)` Optional.
`OauthClient`	`setExpireTime(String expireTime)` Output only.
`OauthClient`	`setName(String name)` Immutable.
`OauthClient`	`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
  - OauthClient
```
public OauthClient()
```
- Method Detail
  - getAllowedGrantTypes
```
public List<String> getAllowedGrantTypes()
```
    Required. The list of OAuth grant types is allowed for the OauthClient.
    
    Returns:
    
    value or null for none
  - setAllowedGrantTypes
```
public OauthClient setAllowedGrantTypes(List<String> allowedGrantTypes)
```
    Required. The list of OAuth grant types is allowed for the OauthClient.
    
    Parameters:
    
    allowedGrantTypes - allowedGrantTypes or null for none
  - getAllowedRedirectUris
```
public List<String> getAllowedRedirectUris()
```
    Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
    
    Returns:
    
    value or null for none
  - setAllowedRedirectUris
```
public OauthClient setAllowedRedirectUris(List<String> allowedRedirectUris)
```
    Required. The list of redirect uris that is allowed to redirect back when authorization process is completed.
    
    Parameters:
    
    allowedRedirectUris - allowedRedirectUris or null for none
  - getAllowedScopes
```
public List<String> getAllowedScopes()
```
    Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
    
    Returns:
    
    value or null for none
  - setAllowedScopes
```
public OauthClient setAllowedScopes(List<String> allowedScopes)
```
    Required. The list of scopes that the OauthClient is allowed to request during OAuth flows. The following scopes are supported: * `https://www.googleapis.com/auth/cloud-platform`: See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
    
    Parameters:
    
    allowedScopes - allowedScopes or null for none
  - getClientId
```
public String getClientId()
```
    Output only. The system-generated OauthClient id.
    
    Returns:
    
    value or null for none
  - setClientId
```
public OauthClient setClientId(String clientId)
```
    Output only. The system-generated OauthClient id.
    
    Parameters:
    
    clientId - clientId or null for none
  - getClientType
```
public String getClientType()
```
    Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
    
    Returns:
    
    value or null for none
  - setClientType
```
public OauthClient setClientType(String clientType)
```
    Immutable. The type of OauthClient. Either public or private. For private clients, the client secret can be managed using the dedicated OauthClientCredential resource.
    
    Parameters:
    
    clientType - clientType or null for none
  - getDescription
```
public String getDescription()
```
    Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
    
    Returns:
    
    value or null for none
  - setDescription
```
public OauthClient setDescription(String description)
```
    Optional. A user-specified description of the OauthClient. Cannot exceed 256 characters.
    
    Parameters:
    
    description - description or null for none
  - getDisabled
```
public Boolean getDisabled()
```
    Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
    
    Returns:
    
    value or null for none
  - setDisabled
```
public OauthClient setDisabled(Boolean disabled)
```
    Optional. Whether the OauthClient is disabled. You cannot use a disabled OAuth client.
    
    Parameters:
    
    disabled - disabled or null for none
  - getDisplayName
```
public String getDisplayName()
```
    Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public OauthClient setDisplayName(String displayName)
```
    Optional. A user-specified display name of the OauthClient. Cannot exceed 32 characters.
    
    Parameters:
    
    displayName - displayName or null for none
  - getExpireTime
```
public String getExpireTime()
```
    Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
    
    Returns:
    
    value or null for none
  - setExpireTime
```
public OauthClient setExpireTime(String expireTime)
```
    Output only. Time after which the OauthClient will be permanently purged and cannot be recovered.
    
    Parameters:
    
    expireTime - expireTime or null for none
  - getName
```
public String getName()
```
    Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
    
    Returns:
    
    value or null for none
  - setName
```
public OauthClient setName(String name)
```
    Immutable. Identifier. The resource name of the OauthClient. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.
    
    Parameters:
    
    name - name or null for none
  - getState
```
public String getState()
```
    Output only. The state of the OauthClient.
    
    Returns:
    
    value or null for none
  - setState
```
public OauthClient setState(String state)
```
    Output only. The state of the OauthClient.
    
    Parameters:
    
    state - state or null for none
  - set
```
public OauthClient set(String fieldName,
                       Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public OauthClient clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class OauthClient

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

OauthClient

Method Detail

getAllowedGrantTypes

setAllowedGrantTypes

getAllowedRedirectUris

setAllowedRedirectUris

getAllowedScopes

setAllowedScopes

getClientId

setClientId

getClientType

setClientType

getDescription

setDescription

getDisabled

setDisabled

getDisplayName

setDisplayName

getExpireTime

setExpireTime

getName

setName

getState

setState

set

clone