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

Class Role

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Role
extends GenericJson

A role in the Identity and Access Management API.

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

Method Summary

Modifier and Type	Method and Description
Role	clone()
byte[]	decodeEtag() Used to perform a consistent read-modify-write.
Role	encodeEtag(byte[] etag) Used to perform a consistent read-modify-write.
Boolean	getDeleted() The current deleted state of the role.
String	getDescription() Optional.
String	getEtag() Used to perform a consistent read-modify-write.
List<String>	getIncludedPermissions() The names of the permissions this role grants when bound in an IAM policy.
String	getName() The name of the role.
String	getStage() The current launch stage of the role.
String	getTitle() Optional.
Role	set(String fieldName, Object value)
Role	setDeleted(Boolean deleted) The current deleted state of the role.
Role	setDescription(String description) Optional.
Role	setEtag(String etag) Used to perform a consistent read-modify-write.
Role	setIncludedPermissions(List<String> includedPermissions) The names of the permissions this role grants when bound in an IAM policy.
Role	setName(String name) The name of the role.
Role	setStage(String stage) The current launch stage of the role.
Role	setTitle(String title) Optional.

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

Role

public Role()

Method Detail

getDeleted

public Boolean getDeleted()

The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.

Returns:

value or null for none

setDeleted

public Role setDeleted(Boolean deleted)

The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole.

Parameters:

deleted - deleted or null for none

getDescription

public String getDescription()

Optional. A human-readable description for the role.

Returns:

value or null for none

setDescription

public Role setDescription(String description)

Optional. A human-readable description for the role.

Parameters:

description - description or null for none

getEtag

public String getEtag()

Used to perform a consistent read-modify-write.

Returns:

value or null for none

See Also:

decodeEtag()

decodeEtag

public byte[] decodeEtag()

Used to perform a consistent read-modify-write.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getEtag()

setEtag

public Role setEtag(String etag)

Used to perform a consistent read-modify-write.

Parameters:

etag - etag or null for none

See Also:

#encodeEtag()

encodeEtag

public Role encodeEtag(byte[] etag)

Used to perform a consistent read-modify-write.

Since:

1.14

See Also:

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

getIncludedPermissions

public List<String> getIncludedPermissions()

The names of the permissions this role grants when bound in an IAM policy.

Returns:

value or null for none

setIncludedPermissions

public Role setIncludedPermissions(List<String> includedPermissions)

The names of the permissions this role grants when bound in an IAM policy.

Parameters:

includedPermissions - includedPermissions or null for none

getName

public String getName()

The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

Returns:

value or null for none

setName

public Role setName(String name)

The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.

Parameters:

name - name or null for none

getStage

public String getStage()

The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.

Returns:

value or null for none

setStage

public Role setStage(String stage)

The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role.

Parameters:

stage - stage or null for none

getTitle

public String getTitle()

Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

Returns:

value or null for none

setTitle

public Role setTitle(String title)

Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes.

Parameters:

title - title or null for none

set

public Role set(String fieldName,
                Object value)

Overrides:

set in class GenericJson

clone

public Role clone()

Overrides:

clone in class GenericJson