Class Document.AclInfo.AccessRestriction (0.42.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
Type Description
int

Static Methods

getDefaultInstance()

public static Document.AclInfo.AccessRestriction getDefaultInstance()
Returns
Type Description
Document.AclInfo.AccessRestriction

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Document.AclInfo.AccessRestriction.Builder newBuilder()
Returns
Type Description
Document.AclInfo.AccessRestriction.Builder

newBuilder(Document.AclInfo.AccessRestriction prototype)

public static Document.AclInfo.AccessRestriction.Builder newBuilder(Document.AclInfo.AccessRestriction prototype)
Parameter
Name Description
prototype Document.AclInfo.AccessRestriction
Returns
Type Description
Document.AclInfo.AccessRestriction.Builder

parseDelimitedFrom(InputStream input)

public static Document.AclInfo.AccessRestriction parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.AclInfo.AccessRestriction
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.AclInfo.AccessRestriction parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.AclInfo.AccessRestriction
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Document.AclInfo.AccessRestriction parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Document.AclInfo.AccessRestriction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.AclInfo.AccessRestriction parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.AclInfo.AccessRestriction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.AclInfo.AccessRestriction parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Document.AclInfo.AccessRestriction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.AclInfo.AccessRestriction parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.AclInfo.AccessRestriction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.AclInfo.AccessRestriction parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Document.AclInfo.AccessRestriction
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.AclInfo.AccessRestriction parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.AclInfo.AccessRestriction
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Document.AclInfo.AccessRestriction parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.AclInfo.AccessRestriction
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.AclInfo.AccessRestriction parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.AclInfo.AccessRestriction
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Document.AclInfo.AccessRestriction parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Document.AclInfo.AccessRestriction
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.AclInfo.AccessRestriction parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.AclInfo.AccessRestriction
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Document.AclInfo.AccessRestriction getDefaultInstanceForType()
Returns
Type Description
Document.AclInfo.AccessRestriction

getParserForType()

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

getPrincipals(int index)

public Principal getPrincipals(int index)

List of principals.

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

Parameter
Name Description
index int
Returns
Type Description
Principal

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;

Returns
Type Description
List<Principal>

getPrincipalsOrBuilder(int index)

public PrincipalOrBuilder getPrincipalsOrBuilder(int index)

List of principals.

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

Parameter
Name Description
index int
Returns
Type Description
PrincipalOrBuilder

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>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Document.AclInfo.AccessRestriction.Builder newBuilderForType()
Returns
Type Description
Document.AclInfo.AccessRestriction.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.AclInfo.AccessRestriction.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Document.AclInfo.AccessRestriction.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Document.AclInfo.AccessRestriction.Builder toBuilder()
Returns
Type Description
Document.AclInfo.AccessRestriction.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException