Class Document.AclInfo.AccessRestriction (0.35.0)

public static final class Document.AclInfo.AccessRestriction extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Document.AclInfo.AccessRestriction

Static Fields

PRINCIPALS_FIELD_NUMBER

public static final int PRINCIPALS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Document.AclInfo.AccessRestriction getDefaultInstance()
Returns
TypeDescription
Document.AclInfo.AccessRestriction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Document.AclInfo.AccessRestriction.Builder newBuilder()
Returns
TypeDescription
Document.AclInfo.AccessRestriction.Builder

newBuilder(Document.AclInfo.AccessRestriction prototype)

public static Document.AclInfo.AccessRestriction.Builder newBuilder(Document.AclInfo.AccessRestriction prototype)
Parameter
NameDescription
prototypeDocument.AclInfo.AccessRestriction
Returns
TypeDescription
Document.AclInfo.AccessRestriction.Builder

parseDelimitedFrom(InputStream input)

public static Document.AclInfo.AccessRestriction parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.AclInfo.AccessRestriction
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.AclInfo.AccessRestriction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.AclInfo.AccessRestriction
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Document.AclInfo.AccessRestriction parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Document.AclInfo.AccessRestriction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.AclInfo.AccessRestriction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.AclInfo.AccessRestriction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.AclInfo.AccessRestriction parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Document.AclInfo.AccessRestriction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.AclInfo.AccessRestriction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.AclInfo.AccessRestriction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.AclInfo.AccessRestriction parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Document.AclInfo.AccessRestriction
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.AclInfo.AccessRestriction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.AclInfo.AccessRestriction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Document.AclInfo.AccessRestriction parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.AclInfo.AccessRestriction
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.AclInfo.AccessRestriction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.AclInfo.AccessRestriction
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Document.AclInfo.AccessRestriction parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Document.AclInfo.AccessRestriction
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.AclInfo.AccessRestriction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.AclInfo.AccessRestriction
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Document.AclInfo.AccessRestriction> parser()
Returns
TypeDescription
Parser<AccessRestriction>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Document.AclInfo.AccessRestriction getDefaultInstanceForType()
Returns
TypeDescription
Document.AclInfo.AccessRestriction

getParserForType()

public Parser<Document.AclInfo.AccessRestriction> getParserForType()
Returns
TypeDescription
Parser<AccessRestriction>
Overrides

getPrincipals(int index)

public Principal getPrincipals(int index)

List of principals.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Principal

getPrincipalsCount()

public int getPrincipalsCount()

List of principals.

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

Returns
TypeDescription
int

getPrincipalsList()

public List<Principal> getPrincipalsList()

List of principals.

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

Returns
TypeDescription
List<Principal>

getPrincipalsOrBuilder(int index)

public PrincipalOrBuilder getPrincipalsOrBuilder(int index)

List of principals.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
PrincipalOrBuilder

getPrincipalsOrBuilderList()

public List<? extends PrincipalOrBuilder> getPrincipalsOrBuilderList()

List of principals.

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

Returns
TypeDescription
List<? extends com.google.cloud.discoveryengine.v1alpha.PrincipalOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Document.AclInfo.AccessRestriction.Builder newBuilderForType()
Returns
TypeDescription
Document.AclInfo.AccessRestriction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.AclInfo.AccessRestriction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Document.AclInfo.AccessRestriction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Document.AclInfo.AccessRestriction.Builder toBuilder()
Returns
TypeDescription
Document.AclInfo.AccessRestriction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException