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

Class ServiceAccount

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ServiceAccount
extends GenericJson

A service account in the Identity and Access Management API. To create a service account, specify the `project_id` and the `account_id` for the account. The `account_id` is unique within the project, and is used to generate the service account email address and a stable `unique_id`. If the account already exists, the account's resource name is returned in the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller can use the name in other methods to access the account. All other methods can identify the service account using the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Using `-` as a wildcard for the `PROJECT_ID` will infer the project from the account. The `ACCOUNT` value can be the `email` address or the `unique_id` of the service account.

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

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
ServiceAccount()

Method Summary

Modifier and Type	Method and Description
ServiceAccount	clone()
byte[]	decodeEtag() Optional.
ServiceAccount	encodeEtag(byte[] etag) Optional.
String	getDescription() Optional.
Boolean	getDisabled()
String	getDisplayName() Optional.
String	getEmail()
String	getEtag() Optional.
String	getName() The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
String	getOauth2ClientId()
String	getProjectId()
String	getUniqueId()
ServiceAccount	set(String fieldName, Object value)
ServiceAccount	setDescription(String description) Optional.
ServiceAccount	setDisabled(Boolean disabled)
ServiceAccount	setDisplayName(String displayName) Optional.
ServiceAccount	setEmail(String email)
ServiceAccount	setEtag(String etag) Optional.
ServiceAccount	setName(String name) The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.
ServiceAccount	setOauth2ClientId(String oauth2ClientId)
ServiceAccount	setProjectId(String projectId)
ServiceAccount	setUniqueId(String uniqueId)

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, 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

ServiceAccount

public ServiceAccount()

Method Detail

getDescription

public String getDescription()

Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.

Returns:

value or null for none

setDescription

public ServiceAccount setDescription(String description)

Optional. A user-specified opaque description of the service account. Must be less than or equal to 256 UTF-8 bytes.

Parameters:

description - description or null for none

getDisabled

public Boolean getDisabled()

Returns:

value or null for none

setDisabled

public ServiceAccount setDisabled(Boolean disabled)

Parameters:

disabled - disabled or null for none

getDisplayName

public String getDisplayName()

Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.

Returns:

value or null for none

setDisplayName

public ServiceAccount setDisplayName(String displayName)

Optional. A user-specified name for the service account. Must be less than or equal to 100 UTF-8 bytes.

Parameters:

displayName - displayName or null for none

getEmail

public String getEmail()

Returns:

value or null for none

setEmail

public ServiceAccount setEmail(String email)

Parameters:

email - email or null for none

getEtag

public String getEtag()

Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.

Returns:

value or null for none

See Also:

decodeEtag()

decodeEtag

public byte[] decodeEtag()

Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getEtag()

setEtag

public ServiceAccount setEtag(String etag)

Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.

Parameters:

etag - etag or null for none

See Also:

#encodeEtag()

encodeEtag

public ServiceAccount encodeEtag(byte[] etag)

Optional. Note: `etag` is an inoperable legacy field that is only returned for backwards compatibility.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getName

public String getName()

The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as a wildcard for the `PROJECT_ID` will infer the project from the `account` and the `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.

Returns:

value or null for none

setName

public ServiceAccount setName(String name)

The resource name of the service account in the following format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. Requests using `-` as a wildcard for the `PROJECT_ID` will infer the project from the `account` and the `ACCOUNT` value can be the `email` address or the `unique_id` of the service account. In responses the resource name will always be in the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.

Parameters:

name - name or null for none

getOauth2ClientId

public String getOauth2ClientId()

Returns:

value or null for none

setOauth2ClientId

public ServiceAccount setOauth2ClientId(String oauth2ClientId)

Parameters:

oauth2ClientId - oauth2ClientId or null for none

getProjectId

public String getProjectId()

Returns:

value or null for none

setProjectId

public ServiceAccount setProjectId(String projectId)

Parameters:

projectId - projectId or null for none

getUniqueId

public String getUniqueId()

Returns:

value or null for none

setUniqueId

public ServiceAccount setUniqueId(String uniqueId)

Parameters:

uniqueId - uniqueId or null for none

set

public ServiceAccount set(String fieldName,
                          Object value)

Overrides:

set in class GenericJson

clone

public ServiceAccount clone()

Overrides:

clone in class GenericJson