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 com.google.api.client.json.GenericJson

An IAM service account. A service account is an account for an application or a virtual machine (VM) instance, not a person. You can use a service account to call Google APIs. To learn more, read the [overview of service accounts](https://cloud.google.com/iam/help/service- accounts/overview). When you create a service account, you specify the project ID that owns the service account, as well as a name that must be unique within the project. IAM uses these values to create an email address that identifies the service //

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

Method Summary

Modifier and Type	Method and Description
ServiceAccount	clone()
byte[]	decodeEtag() Deprecated.
ServiceAccount	encodeEtag(byte[] etag) Deprecated.
String	getDescription() Optional.
Boolean	getDisabled() Output only.
String	getDisplayName() Optional.
String	getEmail() Output only.
String	getEtag() Deprecated.
String	getName() The resource name of the service account.
String	getOauth2ClientId() Output only.
String	getProjectId() Output only.
String	getUniqueId() Output only.
ServiceAccount	set(String fieldName, Object value)
ServiceAccount	setDescription(String description) Optional.
ServiceAccount	setDisabled(Boolean disabled) Output only.
ServiceAccount	setDisplayName(String displayName) Optional.
ServiceAccount	setEmail(String email) Output only.
ServiceAccount	setEtag(String etag) Deprecated.
ServiceAccount	setName(String name) The resource name of the service account.
ServiceAccount	setOauth2ClientId(String oauth2ClientId) Output only.
ServiceAccount	setProjectId(String projectId) Output only.
ServiceAccount	setUniqueId(String uniqueId) 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

ServiceAccount

public ServiceAccount()

Method Detail

getDescription

public String getDescription()

Optional. A user-specified, human-readable description of the service account. The maximum length is 256 UTF-8 bytes.

Returns:

value or null for none

setDescription

public ServiceAccount setDescription(String description)

Optional. A user-specified, human-readable description of the service account. The maximum length is 256 UTF-8 bytes.

Parameters:

description - description or null for none

getDisabled

public Boolean getDisabled()

Output only. Whether the service account is disabled.

Returns:

value or null for none

setDisabled

public ServiceAccount setDisabled(Boolean disabled)

Output only. Whether the service account is disabled.

Parameters:

disabled - disabled or null for none

getDisplayName

public String getDisplayName()

Optional. A user-specified, human-readable name for the service account. The maximum length is 100 UTF-8 bytes.

Returns:

value or null for none

setDisplayName

public ServiceAccount setDisplayName(String displayName)

Optional. A user-specified, human-readable name for the service account. The maximum length is 100 UTF-8 bytes.

Parameters:

displayName - displayName or null for none

getEmail

public String getEmail()

Output only. The email address of the service account.

Returns:

value or null for none

setEmail

public ServiceAccount setEmail(String email)

Output only. The email address of the service account.

Parameters:

email - email or null for none

getEtag

public String getEtag()

Deprecated. Do not use.

Returns:

value or null for none

See Also:

decodeEtag()

decodeEtag

public byte[] decodeEtag()

Deprecated. Do not use.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getEtag()

setEtag

public ServiceAccount setEtag(String etag)

Deprecated. Do not use.

Parameters:

etag - etag or null for none

See Also:

#encodeEtag()

encodeEtag

public ServiceAccount encodeEtag(byte[] etag)

Deprecated. Do not use.

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. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * `projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the `-` wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account `projects/-/serviceAccounts/fake@example.com`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

Returns:

value or null for none

setName

public ServiceAccount setName(String name)

The resource name of the service account. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * `projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the `-` wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account `projects/-/serviceAccounts/fake@example.com`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error.

Parameters:

name - name or null for none

getOauth2ClientId

public String getOauth2ClientId()

Output only. The OAuth 2.0 client ID for the service account.

Returns:

value or null for none

setOauth2ClientId

public ServiceAccount setOauth2ClientId(String oauth2ClientId)

Output only. The OAuth 2.0 client ID for the service account.

Parameters:

oauth2ClientId - oauth2ClientId or null for none

getProjectId

public String getProjectId()

Output only. The ID of the project that owns the service account.

Returns:

value or null for none

setProjectId

public ServiceAccount setProjectId(String projectId)

Output only. The ID of the project that owns the service account.

Parameters:

projectId - projectId or null for none

getUniqueId

public String getUniqueId()

Output only. The unique, stable numeric ID for the service account. Each service account retains its unique ID even if you delete the service account. For example, if you delete a service account, then create a new service account with the same name, the new service account has a different unique ID than the deleted service account.

Returns:

value or null for none

setUniqueId

public ServiceAccount setUniqueId(String uniqueId)

Output only. The unique, stable numeric ID for the service account. Each service account retains its unique ID even if you delete the service account. For example, if you delete a service account, then create a new service account with the same name, the new service account has a different unique ID than the deleted service account.

Parameters:

uniqueId - uniqueId or null for none

set

public ServiceAccount set(String fieldName,
                          Object value)

Overrides:

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

clone

public ServiceAccount clone()

Overrides:

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