com.google.cloud.discoveryengine.v1

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.v1.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.v1.Document.AclInfo.AccessRestriction

Method Summary

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	build()
Document.AclInfo.AccessRestriction	buildPartial()
Document.AclInfo.AccessRestriction.Builder	clear()
Document.AclInfo.AccessRestriction.Builder	clearIdpWide() All users within the Identity Provider.
Document.AclInfo.AccessRestriction.Builder	clearPrincipals() List of principals.
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.GeneratedMessage.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	removePrincipals(int index) List of principals.
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.

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, 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, 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.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

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.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:

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.v1.Principal principals = 1;

Specified by:

getPrincipalsList in interface Document.AclInfo.AccessRestrictionOrBuilder

getPrincipalsCount

public int getPrincipalsCount()

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

Specified by:

getPrincipalsCount in interface Document.AclInfo.AccessRestrictionOrBuilder

getPrincipals

public Principal getPrincipals(int index)

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.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.v1.Principal principals = 1;

setPrincipals

public Document.AclInfo.AccessRestriction.Builder setPrincipals(int index,
                                                                Principal.Builder builderForValue)

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

addPrincipals

public Document.AclInfo.AccessRestriction.Builder addPrincipals(Principal value)

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

addPrincipals

public Document.AclInfo.AccessRestriction.Builder addPrincipals(int index,
                                                                Principal value)

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

addPrincipals

public Document.AclInfo.AccessRestriction.Builder addPrincipals(Principal.Builder builderForValue)

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

addPrincipals

public Document.AclInfo.AccessRestriction.Builder addPrincipals(int index,
                                                                Principal.Builder builderForValue)

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

addAllPrincipals

public Document.AclInfo.AccessRestriction.Builder addAllPrincipals(Iterable<? extends Principal> values)

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

clearPrincipals

public Document.AclInfo.AccessRestriction.Builder clearPrincipals()

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

removePrincipals

public Document.AclInfo.AccessRestriction.Builder removePrincipals(int index)

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

getPrincipalsBuilder

public Principal.Builder getPrincipalsBuilder(int index)

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

getPrincipalsOrBuilder

public PrincipalOrBuilder getPrincipalsOrBuilder(int index)

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

Specified by:

getPrincipalsOrBuilder in interface Document.AclInfo.AccessRestrictionOrBuilder

getPrincipalsOrBuilderList

public List<? extends PrincipalOrBuilder> getPrincipalsOrBuilderList()

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

Specified by:

getPrincipalsOrBuilderList in interface Document.AclInfo.AccessRestrictionOrBuilder

addPrincipalsBuilder

public Principal.Builder addPrincipalsBuilder()

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

addPrincipalsBuilder

public Principal.Builder addPrincipalsBuilder(int index)

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.Principal principals = 1;

getPrincipalsBuilderList

public List<Principal.Builder> getPrincipalsBuilderList()

 List of principals.
 

repeated .google.cloud.discoveryengine.v1.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.