Send feedback
Class Document.AclInfo.AccessRestriction.Builder (0.52.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latest keyboard_arrow_down
public static final class Document . AclInfo . AccessRestriction . Builder extends 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addAllPrincipals(Iterable<? extends Principal> values)
public Document . AclInfo . AccessRestriction . Builder addAllPrincipals ( Iterable <? extends Principal > values )
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
Parameter
Name Description
valuesIterable <? extends com.google.cloud.discoveryengine.v1alpha.Principal >
addPrincipals(Principal value)
public Document . AclInfo . AccessRestriction . Builder addPrincipals ( Principal value )
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
addPrincipals(Principal.Builder builderForValue)
public Document . AclInfo . AccessRestriction . Builder addPrincipals ( Principal . Builder builderForValue )
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
addPrincipals(int index, Principal value)
public Document . AclInfo . AccessRestriction . Builder addPrincipals ( int index , Principal value )
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
addPrincipals(int index, Principal.Builder builderForValue)
public Document . AclInfo . AccessRestriction . Builder addPrincipals ( int index , Principal . Builder builderForValue )
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
addPrincipalsBuilder()
public Principal . Builder addPrincipalsBuilder ()
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
addPrincipalsBuilder(int index)
public Principal . Builder addPrincipalsBuilder ( int index )
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
Parameter
Name Description
indexint
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Document . AclInfo . AccessRestriction . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public Document . AclInfo . AccessRestriction build ()
buildPartial()
public Document . AclInfo . AccessRestriction buildPartial ()
clear()
public Document . AclInfo . AccessRestriction . Builder clear ()
Overrides
clearField(Descriptors.FieldDescriptor field)
public Document . AclInfo . AccessRestriction . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
clearIdpWide()
public Document . AclInfo . AccessRestriction . Builder clearIdpWide ()
All users within the Identity Provider.
bool idp_wide = 2;
clearOneof(Descriptors.OneofDescriptor oneof)
public Document . AclInfo . AccessRestriction . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clearPrincipals()
public Document . AclInfo . AccessRestriction . Builder clearPrincipals ()
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
clone()
public Document . AclInfo . AccessRestriction . Builder clone ()
Overrides
getDefaultInstanceForType()
public Document . AclInfo . AccessRestriction getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
getIdpWide()
public boolean getIdpWide ()
All users within the Identity Provider.
bool idp_wide = 2;
Returns
Type Description
boolean The idpWide.
getPrincipals(int index)
public Principal getPrincipals ( int index )
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
Parameter
Name Description
indexint
getPrincipalsBuilder(int index)
public Principal . Builder getPrincipalsBuilder ( int index )
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
Parameter
Name Description
indexint
getPrincipalsBuilderList()
public List<Principal . Builder > getPrincipalsBuilderList ()
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
getPrincipalsCount()
public int getPrincipalsCount ()
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
Returns
Type Description
int
getPrincipalsList()
public List<Principal> getPrincipalsList ()
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
getPrincipalsOrBuilder(int index)
public PrincipalOrBuilder getPrincipalsOrBuilder ( int index )
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
Parameter
Name Description
indexint
getPrincipalsOrBuilderList()
public List <? extends PrincipalOrBuilder > getPrincipalsOrBuilderList ()
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
Returns
Type Description
List <? extends com.google.cloud.discoveryengine.v1alpha.PrincipalOrBuilder >
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(Document.AclInfo.AccessRestriction other)
public Document . AclInfo . AccessRestriction . Builder mergeFrom ( Document . AclInfo . AccessRestriction other )
public Document . AclInfo . AccessRestriction . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public Document . AclInfo . AccessRestriction . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Document . AclInfo . AccessRestriction . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
removePrincipals(int index)
public Document . AclInfo . AccessRestriction . Builder removePrincipals ( int index )
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
Parameter
Name Description
indexint
setField(Descriptors.FieldDescriptor field, Object value)
public Document . AclInfo . AccessRestriction . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
setIdpWide(boolean value)
public Document . AclInfo . AccessRestriction . Builder setIdpWide ( boolean value )
All users within the Identity Provider.
bool idp_wide = 2;
Parameter
Name Description
valueboolean The idpWide to set.
setPrincipals(int index, Principal value)
public Document . AclInfo . AccessRestriction . Builder setPrincipals ( int index , Principal value )
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
setPrincipals(int index, Principal.Builder builderForValue)
public Document . AclInfo . AccessRestriction . Builder setPrincipals ( int index , Principal . Builder builderForValue )
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Document . AclInfo . AccessRestriction . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Document . AclInfo . AccessRestriction . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
