Class Document.AclInfo.AccessRestriction.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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
Modifier and TypeMethodDescriptionaddAllPrincipals(Iterable<? extends Principal> values) List of principals.addPrincipals(int index, Principal value) List of principals.addPrincipals(int index, Principal.Builder builderForValue) List of principals.addPrincipals(Principal value) List of principals.addPrincipals(Principal.Builder builderForValue) List of principals.List of principals.addPrincipalsBuilder(int index) List of principals.build()clear()All users within the Identity Provider.List of principals.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorbooleanAll users within the Identity Provider.getPrincipals(int index) List of principals.getPrincipalsBuilder(int index) List of principals.List of principals.intList of principals.List of principals.getPrincipalsOrBuilder(int index) List of principals.List<? extends PrincipalOrBuilder>List of principals.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) removePrincipals(int index) List of principals.setIdpWide(boolean value) All users within the Identity Provider.setPrincipals(int index, Principal value) List of principals.setPrincipals(int index, Principal.Builder builderForValue) List of principals.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<Document.AclInfo.AccessRestriction.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<Document.AclInfo.AccessRestriction.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<Document.AclInfo.AccessRestriction.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.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:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.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:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<Document.AclInfo.AccessRestriction.Builder>- Throws:
IOException
-
getPrincipalsList
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;- Specified by:
getPrincipalsListin interfaceDocument.AclInfo.AccessRestrictionOrBuilder
-
getPrincipalsCount
public int getPrincipalsCount()List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;- Specified by:
getPrincipalsCountin interfaceDocument.AclInfo.AccessRestrictionOrBuilder
-
getPrincipals
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;- Specified by:
getPrincipalsin interfaceDocument.AclInfo.AccessRestrictionOrBuilder
-
setPrincipals
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
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1; -
addPrincipals
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1; -
addPrincipals
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
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1; -
removePrincipals
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1; -
getPrincipalsBuilder
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1; -
getPrincipalsOrBuilder
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;- Specified by:
getPrincipalsOrBuilderin interfaceDocument.AclInfo.AccessRestrictionOrBuilder
-
getPrincipalsOrBuilderList
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1;- Specified by:
getPrincipalsOrBuilderListin interfaceDocument.AclInfo.AccessRestrictionOrBuilder
-
addPrincipalsBuilder
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1; -
addPrincipalsBuilder
List of principals.
repeated .google.cloud.discoveryengine.v1alpha.Principal principals = 1; -
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:
getIdpWidein interfaceDocument.AclInfo.AccessRestrictionOrBuilder- Returns:
- The idpWide.
-
setIdpWide
All users within the Identity Provider.
bool idp_wide = 2;- Parameters:
value- The idpWide to set.- Returns:
- This builder for chaining.
-
clearIdpWide
All users within the Identity Provider.
bool idp_wide = 2;- Returns:
- This builder for chaining.
-