Document.AclInfo.AccessRestriction.Builder (proto-google-cloud-discoveryengine-v1alpha 0.45.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Document.AclInfo.AccessRestriction.Builder>
    - - com.google.cloud.discoveryengine.v1alpha.Document.AclInfo.AccessRestriction.Builder

All Implemented Interfaces:: Document.AclInfo.AccessRestrictionOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:: Document.AclInfo.AccessRestriction

public static final class Document.AclInfo.AccessRestriction.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Document.AclInfo.AccessRestriction.Builder>
implements Document.AclInfo.AccessRestrictionOrBuilder

 AclRestriction to model complex inheritance restrictions.

 Example: Modeling a "Both Permit" inheritance, where to access a
 child document, user needs to have access to parent document.

 Document Hierarchy - Space_S --> Page_P.

 Readers:
   Space_S: group_1, user_1
   Page_P: group_2, group_3, user_2

 Space_S ACL Restriction -
 {
   "acl_info": {
     "readers": [
       {
         "principals": [
           {
             "group_id": "group_1"
           },
           {
             "user_id": "user_1"
           }
         ]
       }
     ]
   }
 }

 Page_P ACL Restriction.
 {
   "acl_info": {
     "readers": [
       {
         "principals": [
           {
             "group_id": "group_2"
           },
           {
             "group_id": "group_3"
           },
           {
             "user_id": "user_2"
           }
         ],
       },
       {
         "principals": [
           {
             "group_id": "group_1"
           },
           {
             "user_id": "user_1"
           }
         ],
       }
     ]
   }
 }

Protobuf type google.cloud.discoveryengine.v1alpha.Document.AclInfo.AccessRestriction

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Document.AclInfo.AccessRestriction.Builder`	`addAllPrincipals(Iterable<? extends Principal> values)` List of principals.
`Document.AclInfo.AccessRestriction.Builder`	`addPrincipals(int index, Principal.Builder builderForValue)` List of principals.
`Document.AclInfo.AccessRestriction.Builder`	`addPrincipals(int index, Principal value)` List of principals.
`Document.AclInfo.AccessRestriction.Builder`	`addPrincipals(Principal.Builder builderForValue)` List of principals.
`Document.AclInfo.AccessRestriction.Builder`	`addPrincipals(Principal value)` List of principals.
`Principal.Builder`	`addPrincipalsBuilder()` List of principals.
`Principal.Builder`	`addPrincipalsBuilder(int index)` List of principals.
`Document.AclInfo.AccessRestriction.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Document.AclInfo.AccessRestriction`	`build()`
`Document.AclInfo.AccessRestriction`	`buildPartial()`
`Document.AclInfo.AccessRestriction.Builder`	`clear()`
`Document.AclInfo.AccessRestriction.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Document.AclInfo.AccessRestriction.Builder`	`clearIdpWide()` All users within the Identity Provider.
`Document.AclInfo.AccessRestriction.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Document.AclInfo.AccessRestriction.Builder`	`clearPrincipals()` List of principals.
`Document.AclInfo.AccessRestriction.Builder`	`clone()`
`Document.AclInfo.AccessRestriction`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`boolean`	`getIdpWide()` All users within the Identity Provider.
`Principal`	`getPrincipals(int index)` List of principals.
`Principal.Builder`	`getPrincipalsBuilder(int index)` List of principals.
`List<Principal.Builder>`	`getPrincipalsBuilderList()` List of principals.
`int`	`getPrincipalsCount()` List of principals.
`List<Principal>`	`getPrincipalsList()` List of principals.
`PrincipalOrBuilder`	`getPrincipalsOrBuilder(int index)` List of principals.
`List<? extends PrincipalOrBuilder>`	`getPrincipalsOrBuilderList()` List of principals.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Document.AclInfo.AccessRestriction.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Document.AclInfo.AccessRestriction.Builder`	`mergeFrom(Document.AclInfo.AccessRestriction other)`
`Document.AclInfo.AccessRestriction.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Document.AclInfo.AccessRestriction.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Document.AclInfo.AccessRestriction.Builder`	`removePrincipals(int index)` List of principals.
`Document.AclInfo.AccessRestriction.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Document.AclInfo.AccessRestriction.Builder`	`setIdpWide(boolean value)` All users within the Identity Provider.
`Document.AclInfo.AccessRestriction.Builder`	`setPrincipals(int index, Principal.Builder builderForValue)` List of principals.
`Document.AclInfo.AccessRestriction.Builder`	`setPrincipals(int index, Principal value)` List of principals.
`Document.AclInfo.AccessRestriction.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Document.AclInfo.AccessRestriction.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

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

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

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - 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.Builder<Document.AclInfo.AccessRestriction.Builder>
  - clear
```
public Document.AclInfo.AccessRestriction.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<Document.AclInfo.AccessRestriction.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Document.AclInfo.AccessRestriction.Builder>
  - getDefaultInstanceForType
```
public Document.AclInfo.AccessRestriction getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Document.AclInfo.AccessRestriction build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Document.AclInfo.AccessRestriction buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Document.AclInfo.AccessRestriction.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<Document.AclInfo.AccessRestriction.Builder>
  - setField
```
public Document.AclInfo.AccessRestriction.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                           Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.AclInfo.AccessRestriction.Builder>
  - clearField
```
public Document.AclInfo.AccessRestriction.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.AclInfo.AccessRestriction.Builder>
  - clearOneof
```
public Document.AclInfo.AccessRestriction.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Document.AclInfo.AccessRestriction.Builder>
  - setRepeatedField
```
public Document.AclInfo.AccessRestriction.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                   int index,
                                                                   Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.AclInfo.AccessRestriction.Builder>
  - addRepeatedField
```
public Document.AclInfo.AccessRestriction.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                   Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.AclInfo.AccessRestriction.Builder>
  - mergeFrom
```
public Document.AclInfo.AccessRestriction.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.AclInfo.AccessRestriction.Builder>
  - mergeFrom
```
public Document.AclInfo.AccessRestriction.Builder mergeFrom(Document.AclInfo.AccessRestriction other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Document.AclInfo.AccessRestriction.Builder>
  - mergeFrom
```
public Document.AclInfo.AccessRestriction.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                     throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.AclInfo.AccessRestriction.Builder>
    
    Throws:
    
    IOException
  - getPrincipalsList
```
public List<Principal> getPrincipalsList()
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
    Specified by:
    
    getPrincipalsList in interface Document.AclInfo.AccessRestrictionOrBuilder
  - getPrincipalsCount
```
public int getPrincipalsCount()
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
    Specified by:
    
    getPrincipalsCount in interface Document.AclInfo.AccessRestrictionOrBuilder
  - getPrincipals
```
public Principal getPrincipals(int index)
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
    Specified by:
    
    getPrincipals in interface Document.AclInfo.AccessRestrictionOrBuilder
  - setPrincipals
```
public Document.AclInfo.AccessRestriction.Builder setPrincipals(int index,
                                                                Principal value)
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
  - setPrincipals
```
public Document.AclInfo.AccessRestriction.Builder setPrincipals(int index,
                                                                Principal.Builder builderForValue)
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
  - addPrincipals
```
public Document.AclInfo.AccessRestriction.Builder addPrincipals(Principal value)
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
  - addPrincipals
```
public Document.AclInfo.AccessRestriction.Builder addPrincipals(int index,
                                                                Principal value)
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
  - addPrincipals
```
public Document.AclInfo.AccessRestriction.Builder addPrincipals(Principal.Builder builderForValue)
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
  - addPrincipals
```
public Document.AclInfo.AccessRestriction.Builder addPrincipals(int index,
                                                                Principal.Builder builderForValue)
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
  - addAllPrincipals
```
public Document.AclInfo.AccessRestriction.Builder addAllPrincipals(Iterable<? extends Principal> values)
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
  - clearPrincipals
```
public Document.AclInfo.AccessRestriction.Builder clearPrincipals()
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
  - removePrincipals
```
public Document.AclInfo.AccessRestriction.Builder removePrincipals(int index)
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
  - getPrincipalsBuilder
```
public Principal.Builder getPrincipalsBuilder(int index)
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
  - getPrincipalsOrBuilder
```
public PrincipalOrBuilder getPrincipalsOrBuilder(int index)
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
    Specified by:
    
    getPrincipalsOrBuilder in interface Document.AclInfo.AccessRestrictionOrBuilder
  - getPrincipalsOrBuilderList
```
public List<? extends PrincipalOrBuilder> getPrincipalsOrBuilderList()
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
    Specified by:
    
    getPrincipalsOrBuilderList in interface Document.AclInfo.AccessRestrictionOrBuilder
  - addPrincipalsBuilder
```
public Principal.Builder addPrincipalsBuilder()
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
  - addPrincipalsBuilder
```
public Principal.Builder addPrincipalsBuilder(int index)
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
  - getPrincipalsBuilderList
```
public List<Principal.Builder> getPrincipalsBuilderList()
```
```
 List of principals.
 
```
    repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
  - getIdpWide
```
public boolean getIdpWide()
```
```
 All users within the Identity Provider.
 
```
    bool idp_wide = 2;
    Specified by:
    
    getIdpWide in interface Document.AclInfo.AccessRestrictionOrBuilder
    
    Returns:
    
    The idpWide.
  - setIdpWide
```
public Document.AclInfo.AccessRestriction.Builder setIdpWide(boolean value)
```
```
 All users within the Identity Provider.
 
```
    bool idp_wide = 2;
    Parameters:
    
    value - The idpWide to set.
    
    Returns:
    
    This builder for chaining.
  - clearIdpWide
```
public Document.AclInfo.AccessRestriction.Builder clearIdpWide()
```
```
 All users within the Identity Provider.
 
```
    bool idp_wide = 2;
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final Document.AclInfo.AccessRestriction.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.AclInfo.AccessRestriction.Builder>
  - mergeUnknownFields
```
public final Document.AclInfo.AccessRestriction.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.AclInfo.AccessRestriction.Builder>

Class Document.AclInfo.AccessRestriction.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getPrincipalsList

getPrincipalsCount

getPrincipals

setPrincipals

setPrincipals

addPrincipals

addPrincipals

addPrincipals

addPrincipals

addAllPrincipals

clearPrincipals

removePrincipals

getPrincipalsBuilder

getPrincipalsOrBuilder

getPrincipalsOrBuilderList

addPrincipalsBuilder

addPrincipalsBuilder

getPrincipalsBuilderList

getIdpWide

setIdpWide

clearIdpWide

setUnknownFields

mergeUnknownFields