Policy (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.iam.v1.Policy

All Implemented Interfaces:: PolicyOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class Policy
extends GeneratedMessageV3
implements PolicyOrBuilder

 Defines an Identity and Access Management (IAM) policy. It is used to
 specify access control policies for Cloud Platform resources.
 A `Policy` is a collection of `bindings`. A `binding` binds one or more
 `members` to a single `role`. Members can be user accounts, service accounts,
 Google groups, and domains (such as G Suite). A `role` is a named list of
 permissions (defined by IAM or configured by users). A `binding` can
 optionally specify a `condition`, which is a logic expression that further
 constrains the role binding based on attributes about the request and/or
 target resource.
 **JSON Example**
     {
       "bindings": [
         {
           "role": "roles/resourcemanager.organizationAdmin",
           "members": [
             "user:mike@example.com",
             "group:admins@example.com",
             "domain:google.com",
             "serviceAccount:my-project-id@appspot.gserviceaccount.com"
           ]
         },
         {
           "role": "roles/resourcemanager.organizationViewer",
           "members": ["user:eve@example.com"],
           "condition": {
             "title": "expirable access",
             "description": "Does not grant access after Sep 2020",
             "expression": "request.time <
             timestamp('2020-10-01T00:00:00.000Z')",
           }
         }
       ]
     }
 **YAML Example**
     bindings:
     - members:
       - user:mike@example.com
       - group:admins@example.com
       - domain:google.com
       - serviceAccount:my-project-id@appspot.gserviceaccount.com
       role: roles/resourcemanager.organizationAdmin
     - members:
       - user:eve@example.com
       role: roles/resourcemanager.organizationViewer
       condition:
         title: expirable access
         description: Does not grant access after Sep 2020
         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
 For a description of IAM and its features, see the
 [IAM developer's guide](https://cloud.google.com/iam/docs).

Protobuf type google.iam.v1.Policy

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Policy.Builder
Defines an Identity and Access Management (IAM) policy.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Nested Classes
Modifier and Type	Class and Description
`static class`	`Policy.Builder` Defines an Identity and Access Management (IAM) policy.

Field Summary

Fields
Modifier and Type Field and Description

static int BINDINGS_FIELD_NUMBER

static int ETAG_FIELD_NUMBER

static int VERSION_FIELD_NUMBER
- Fields inherited from class com.google.protobuf.GeneratedMessageV3
  alwaysUseFieldBuilders, unknownFields
- Fields inherited from class com.google.protobuf.AbstractMessage
  memoizedSize
- Fields inherited from class com.google.protobuf.AbstractMessageLite
  memoizedHashCode

Fields
Modifier and Type	Field and Description
`static int`	`BINDINGS_FIELD_NUMBER`
`static int`	`ETAG_FIELD_NUMBER`
`static int`	`VERSION_FIELD_NUMBER`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`Binding`	`getBindings(int index)` Associates a list of `members` to a `role`.
`int`	`getBindingsCount()` Associates a list of `members` to a `role`.
`java.util.List<Binding>`	`getBindingsList()` Associates a list of `members` to a `role`.
`BindingOrBuilder`	`getBindingsOrBuilder(int index)` Associates a list of `members` to a `role`.
`java.util.List<? extends BindingOrBuilder>`	`getBindingsOrBuilderList()` Associates a list of `members` to a `role`.
`static Policy`	`getDefaultInstance()`
`Policy`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`ByteString`	`getEtag()` `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.
`Parser<Policy>`	`getParserForType()`
`int`	`getSerializedSize()`
`UnknownFieldSet`	`getUnknownFields()`
`int`	`getVersion()` Specifies the format of the policy.
`int`	`hashCode()`
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Policy.Builder`	`newBuilder()`
`static Policy.Builder`	`newBuilder(Policy prototype)`
`Policy.Builder`	`newBuilderForType()`
`protected Policy.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`static Policy`	`parseDelimitedFrom(java.io.InputStream input)`
`static Policy`	`parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Policy`	`parseFrom(byte[] data)`
`static Policy`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static Policy`	`parseFrom(java.nio.ByteBuffer data)`
`static Policy`	`parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static Policy`	`parseFrom(ByteString data)`
`static Policy`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static Policy`	`parseFrom(CodedInputStream input)`
`static Policy`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static Policy`	`parseFrom(java.io.InputStream input)`
`static Policy`	`parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<Policy>`	`parser()`
`Policy.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- VERSION_FIELD_NUMBER
```
public static final int VERSION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BINDINGS_FIELD_NUMBER
```
public static final int BINDINGS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ETAG_FIELD_NUMBER
```
public static final int ETAG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getVersion

public int getVersion()

 Specifies the format of the policy.
 Valid values are 0, 1, and 3. Requests specifying an invalid value will be
 rejected.
 Operations affecting conditional bindings must specify version 3. This can
 be either setting a conditional policy, modifying a conditional binding,
 or removing a conditional binding from the stored conditional policy.
 Operations on non-conditional policies may specify any valid value or
 leave the field unset.
 If no etag is provided in the call to `setIamPolicy`, any version
 compliance checks on the incoming and/or stored policy is skipped.

int32 version = 1;

Specified by:: getVersion in interface PolicyOrBuilder