Policy.Builder (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Policy.Builder>
    - - com.google.iam.v1.Policy.Builder

All Implemented Interfaces:: PolicyOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:: Policy

public static final class Policy.Builder
extends GeneratedMessageV3.Builder<Policy.Builder>
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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Policy.Builder`	`addAllBindings(java.lang.Iterable<? extends Binding> values)` Associates a list of `members` to a `role`.
`Policy.Builder`	`addBindings(Binding.Builder builderForValue)` Associates a list of `members` to a `role`.
`Policy.Builder`	`addBindings(Binding value)` Associates a list of `members` to a `role`.
`Policy.Builder`	`addBindings(int index, Binding.Builder builderForValue)` Associates a list of `members` to a `role`.
`Policy.Builder`	`addBindings(int index, Binding value)` Associates a list of `members` to a `role`.
`Binding.Builder`	`addBindingsBuilder()` Associates a list of `members` to a `role`.
`Binding.Builder`	`addBindingsBuilder(int index)` Associates a list of `members` to a `role`.
`Policy.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`Policy`	`build()`
`Policy`	`buildPartial()`
`Policy.Builder`	`clear()`
`Policy.Builder`	`clearBindings()` Associates a list of `members` to a `role`.
`Policy.Builder`	`clearEtag()` `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.
`Policy.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`Policy.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`Policy.Builder`	`clearVersion()` Specifies the format of the policy.
`Policy.Builder`	`clone()`
`Binding`	`getBindings(int index)` Associates a list of `members` to a `role`.
`Binding.Builder`	`getBindingsBuilder(int index)` Associates a list of `members` to a `role`.
`java.util.List<Binding.Builder>`	`getBindingsBuilderList()` 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`.
`Policy`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`ByteString`	`getEtag()` `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.
`int`	`getVersion()` Specifies the format of the policy.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Policy.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`Policy.Builder`	`mergeFrom(Message other)`
`Policy.Builder`	`mergeFrom(Policy other)`
`Policy.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`Policy.Builder`	`removeBindings(int index)` Associates a list of `members` to a `role`.
`Policy.Builder`	`setBindings(int index, Binding.Builder builderForValue)` Associates a list of `members` to a `role`.
`Policy.Builder`	`setBindings(int index, Binding value)` Associates a list of `members` to a `role`.
`Policy.Builder`	`setEtag(ByteString value)` `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other.
`Policy.Builder`	`setField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`Policy.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`Policy.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`
`Policy.Builder`	`setVersion(int value)` Specifies the format of the policy.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

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

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

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

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Policy.Builder>

clear
```
public Policy.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<Policy.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<Policy.Builder>

getDefaultInstanceForType
```
public Policy getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public Policy build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public Policy buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public Policy.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<Policy.Builder>

setField

public Policy.Builder setField(Descriptors.FieldDescriptor field,
                               java.lang.Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<Policy.Builder>

clearField
```
public Policy.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<Policy.Builder>

clearOneof
```
public Policy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<Policy.Builder>

setRepeatedField

public Policy.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                       int index,
                                       java.lang.Object value)

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<Policy.Builder>

addRepeatedField
```
public Policy.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                       java.lang.Object value)
```
Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<Policy.Builder>

mergeFrom
```
public Policy.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Policy.Builder>

mergeFrom

public Policy.Builder mergeFrom(Policy other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<Policy.Builder>

mergeFrom

public Policy.Builder mergeFrom(CodedInputStream input,
                                ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<Policy.Builder>
Throws:: java.io.IOException

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

setVersion

public Policy.Builder setVersion(int value)

 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;

clearVersion

public Policy.Builder clearVersion()

 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;