Class Policy (2.39.0)
- 2.64.0 (latest)
- 2.63.1
- 2.62.2
- 2.61.0
- 2.60.3
- 2.59.0
- 2.58.2
- 2.57.0
- 2.56.0
- 2.55.0
- 2.53.1
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.1
- 2.48.0
- 2.47.0
- 2.45.0
- 2.44.1
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.1
- 2.37.0
- 2.36.1
- 2.35.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.1
- 2.23.0
- 2.22.1
- 2.21.1
- 2.20.1
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.4
- 2.8.27
- 2.7.1
- 2.6.1
- 2.5.11
- 2.4.0
- 2.3.5
publicfinalclassPolicyimplementsSerializableClass for Identity and Access Management (IAM) policies. IAM policies are used to specify access settings for Cloud Platform resources. A policy is a list of bindings. A binding assigns a set of identities to a role, where the identities can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.See Also:Policy
Implements
SerializableInherited Members
Static Methods
newBuilder()
publicstaticPolicy.BuildernewBuilder()Returns a builder forPolicy objects.
| Returns | |
|---|---|
| Type | Description |
Policy.Builder | |
Methods
equals(Object obj)
publicbooleanequals(Objectobj)| Parameter | |
|---|---|
| Name | Description |
obj | Object |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getBindings()
publicMap<Role,Set<Identity>>getBindings()Returns the map of bindings that comprises the policy.
| Returns | |
|---|---|
| Type | Description |
Map<Role,Set<Identity>> | |
getBindingsList()
publicImmutableList<Binding>getBindingsList()Returns the list of bindings that comprises the policy for version 3.
| Returns | |
|---|---|
| Type | Description |
com.google.common.collect.ImmutableList<Binding> | |
getEtag()
publicStringgetEtag()Returns the policy's etag.
Etags are used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions. An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.
| Returns | |
|---|---|
| Type | Description |
String | |
getVersion()
publicintgetVersion()Returns the version of the policy. The default version is 0, meaning only the "owner", "editor", and "viewer" roles are permitted. If the version is 1, you may also use other roles.
| Returns | |
|---|---|
| Type | Description |
int | |
hashCode()
publicinthashCode()| Returns | |
|---|---|
| Type | Description |
int | |
toBuilder()
publicPolicy.BuildertoBuilder()Returns a builder containing the properties of this IAM Policy.
| Returns | |
|---|---|
| Type | Description |
Policy.Builder | |
toString()
publicStringtoString()| Returns | |
|---|---|
| Type | Description |
String | |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-31 UTC.