Policy (proto-google-iam-v1 1.3.4 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, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Policy
extends com.google.protobuf.GeneratedMessageV3
implements PolicyOrBuilder

 An Identity and Access Management (IAM) policy, which specifies access
 controls for Google Cloud resources.
 A `Policy` is a collection of `bindings`. A `binding` binds one or more
 `members`, or principals, to a single `role`. Principals can be user
 accounts, service accounts, Google groups, and domains (such as G Suite). A
 `role` is a named list of permissions; each `role` can be an IAM predefined
 role or a user-created custom role.
 For some types of Google Cloud resources, a `binding` can also specify a
 `condition`, which is a logical expression that allows access to a resource
 only if the expression evaluates to `true`. A condition can add constraints
 based on attributes of the request, the resource, or both. To learn which
 resources support conditions in their IAM policies, see the
 [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
 **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')",
           }
         }
       ],
       "etag": "BwWWja0YfJA=",
       "version": 3
     }
 **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')
     etag: BwWWja0YfJA=
     version: 3
 For a description of IAM and its features, see the
 [IAM documentation](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` An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type Field and Description

static int AUDIT_CONFIGS_FIELD_NUMBER

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`	`AUDIT_CONFIGS_FIELD_NUMBER`
`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(Object obj)`
`AuditConfig`	`getAuditConfigs(int index)` Specifies cloud audit logging configuration for this policy.
`int`	`getAuditConfigsCount()` Specifies cloud audit logging configuration for this policy.
`List<AuditConfig>`	`getAuditConfigsList()` Specifies cloud audit logging configuration for this policy.
`AuditConfigOrBuilder`	`getAuditConfigsOrBuilder(int index)` Specifies cloud audit logging configuration for this policy.
`List<? extends AuditConfigOrBuilder>`	`getAuditConfigsOrBuilderList()` Specifies cloud audit logging configuration for this policy.
`Binding`	`getBindings(int index)` Associates a list of `members`, or principals, with a `role`.
`int`	`getBindingsCount()` Associates a list of `members`, or principals, with a `role`.
`List<Binding>`	`getBindingsList()` Associates a list of `members`, or principals, with a `role`.
`BindingOrBuilder`	`getBindingsOrBuilder(int index)` Associates a list of `members`, or principals, with a `role`.
`List<? extends BindingOrBuilder>`	`getBindingsOrBuilderList()` Associates a list of `members`, or principals, with a `role`.
`static Policy`	`getDefaultInstance()`
`Policy`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.ByteString`	`getEtag()` `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.
`com.google.protobuf.Parser<Policy>`	`getParserForType()`
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`getVersion()` Specifies the format of the policy.
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Policy.Builder`	`newBuilder()`
`static Policy.Builder`	`newBuilder(Policy prototype)`
`Policy.Builder`	`newBuilderForType()`
`protected Policy.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Policy`	`parseDelimitedFrom(InputStream input)`
`static Policy`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Policy`	`parseFrom(byte[] data)`
`static Policy`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Policy`	`parseFrom(ByteBuffer data)`
`static Policy`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Policy`	`parseFrom(com.google.protobuf.ByteString data)`
`static Policy`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Policy`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Policy`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Policy`	`parseFrom(InputStream input)`
`static Policy`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Policy>`	`parser()`
`Policy.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.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, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, 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
- AUDIT_CONFIGS_FIELD_NUMBER
```
public static final int AUDIT_CONFIGS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ETAG_FIELD_NUMBER
```
public static final int ETAG_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getVersion

public int getVersion()

 Specifies the format of the policy.
 Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
 are rejected.
 Any operation that affects conditional role bindings must specify version
 `3`. This requirement applies to the following operations:
 * Getting a policy that includes a conditional role binding
 * Adding a conditional role binding to a policy
 * Changing a conditional role binding in a policy
 * Removing any role binding, with or without a condition, from a policy
   that includes conditions
 **Important:** If you use IAM Conditions, you must include the `etag` field
 whenever you call `setIamPolicy`. If you omit this field, then IAM allows
 you to overwrite a version `3` policy with a version `1` policy, and all of
 the conditions in the version `3` policy are lost.
 If a policy does not include any conditions, operations on that policy may
 specify any valid version or leave the field unset.
 To learn which resources support conditions in their IAM policies, see the
 [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

int32 version = 1;

Specified by:: getVersion in interface PolicyOrBuilder
Returns:: The version.