Policy (Compute Engine API v1-rev20190825-1.28.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.compute.model.Policy

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Policy
extends GenericJson
```
Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **JSON Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other- app@appspot.gserviceaccount.com" ] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } **YAML Example** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-other-app@appspot.gserviceaccount.com role: roles/owner - members: - user:sean@example.com role: roles/viewer For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam/docs).
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 Compute Engine 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

Policy()

Constructors
Constructor and Description
`Policy()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Policy`	`clone()`
`byte[]`	`decodeEtag()` `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.
`Policy`	`encodeEtag(byte[] etag)` `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.
`List<AuditConfig>`	`getAuditConfigs()` Specifies cloud audit logging configuration for this policy.
`List<Binding>`	`getBindings()` Associates a list of `members` to a `role`.
`String`	`getEtag()` `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.
`Boolean`	`getIamOwned()`
`List<Rule>`	`getRules()` If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied.
`Integer`	`getVersion()` Deprecated.
`Policy`	`set(String fieldName, Object value)`
`Policy`	`setAuditConfigs(List<AuditConfig> auditConfigs)` Specifies cloud audit logging configuration for this policy.
`Policy`	`setBindings(List<Binding> bindings)` Associates a list of `members` to a `role`.
`Policy`	`setEtag(String etag)` `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.
`Policy`	`setIamOwned(Boolean iamOwned)`
`Policy`	`setRules(List<Rule> rules)` If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied.
`Policy`	`setVersion(Integer version)` Deprecated.

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
  - Policy
```
public Policy()
```
- Method Detail
  - getAuditConfigs
```
public List<AuditConfig> getAuditConfigs()
```
    Specifies cloud audit logging configuration for this policy.
    
    Returns:
    
    value or null for none
  - setAuditConfigs
```
public Policy setAuditConfigs(List<AuditConfig> auditConfigs)
```
    Specifies cloud audit logging configuration for this policy.
    
    Parameters:
    
    auditConfigs - auditConfigs or null for none
  - getBindings
```
public List<Binding> getBindings()
```
    Associates a list of `members` to a `role`. `bindings` with no members will result in an error.
    
    Returns:
    
    value or null for none
  - setBindings
```
public Policy setBindings(List<Binding> bindings)
```
    Associates a list of `members` to a `role`. `bindings` with no members will result in an error.
    
    Parameters:
    
    bindings - bindings or null for none
  - getEtag
```
public String getEtag()
```
    `etag` is 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.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeEtag()
  - decodeEtag
```
public byte[] decodeEtag()
```
    `etag` is 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.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getEtag()
  - setEtag
```
public Policy setEtag(String etag)
```
    `etag` is 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.
    
    Parameters:
    
    etag - etag or null for none
    
    See Also:
    
    #encodeEtag()
  - encodeEtag
```
public Policy encodeEtag(byte[] etag)
```
    `etag` is 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.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getIamOwned
```
public Boolean getIamOwned()
```
    Returns:
    
    value or null for none
  - setIamOwned
```
public Policy setIamOwned(Boolean iamOwned)
```
    Parameters:
    
    iamOwned - iamOwned or null for none
  - getRules
```
public List<Rule> getRules()
```
    If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
    
    Returns:
    
    value or null for none
  - setRules
```
public Policy setRules(List<Rule> rules)
```
    If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
    
    Parameters:
    
    rules - rules or null for none
  - getVersion
```
public Integer getVersion()
```
    Deprecated.
    
    Returns:
    
    value or null for none
  - setVersion
```
public Policy setVersion(Integer version)
```
    Deprecated.
    
    Parameters:
    
    version - version or null for none
  - set
```
public Policy set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Policy clone()
```
    Overrides:
    
    clone in class GenericJson

Class Policy

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

Policy

Method Detail

getAuditConfigs

setAuditConfigs

getBindings

setBindings

getEtag

decodeEtag

setEtag

encodeEtag

getIamOwned

setIamOwned

getRules

setRules

getVersion

setVersion

set

clone