com.google.cloud.discoveryengine.v1alpha

Class Document.AclInfo.AccessRestriction

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.Document.AclInfo.AccessRestriction

All Implemented Interfaces:

Document.AclInfo.AccessRestrictionOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Document.AclInfo

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document.AclInfo.AccessRestriction.Builder AclRestriction to model complex inheritance restrictions.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	IDP_WIDE_FIELD_NUMBER
static int	PRINCIPALS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Document.AclInfo.AccessRestriction	getDefaultInstance()
Document.AclInfo.AccessRestriction	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getIdpWide() All users within the Identity Provider.
com.google.protobuf.Parser<Document.AclInfo.AccessRestriction>	getParserForType()
Principal	getPrincipals(int index) 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.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Document.AclInfo.AccessRestriction.Builder	newBuilder()
static Document.AclInfo.AccessRestriction.Builder	newBuilder(Document.AclInfo.AccessRestriction prototype)
Document.AclInfo.AccessRestriction.Builder	newBuilderForType()
protected Document.AclInfo.AccessRestriction.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Document.AclInfo.AccessRestriction	parseDelimitedFrom(InputStream input)
static Document.AclInfo.AccessRestriction	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.AclInfo.AccessRestriction	parseFrom(byte[] data)
static Document.AclInfo.AccessRestriction	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.AclInfo.AccessRestriction	parseFrom(ByteBuffer data)
static Document.AclInfo.AccessRestriction	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.AclInfo.AccessRestriction	parseFrom(com.google.protobuf.ByteString data)
static Document.AclInfo.AccessRestriction	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.AclInfo.AccessRestriction	parseFrom(com.google.protobuf.CodedInputStream input)
static Document.AclInfo.AccessRestriction	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.AclInfo.AccessRestriction	parseFrom(InputStream input)
static Document.AclInfo.AccessRestriction	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Document.AclInfo.AccessRestriction>	parser()
Document.AclInfo.AccessRestriction.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PRINCIPALS_FIELD_NUMBER

public static final int PRINCIPALS_FIELD_NUMBER

See Also:

Constant Field Values

IDP_WIDE_FIELD_NUMBER

public static final int IDP_WIDE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getPrincipalsList

public List<Principal> getPrincipalsList()

 List of principals.
 

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

Specified by:

getPrincipalsList in interface Document.AclInfo.AccessRestrictionOrBuilder

getPrincipalsOrBuilderList

public List<? extends PrincipalOrBuilder> getPrincipalsOrBuilderList()

 List of principals.
 

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

Specified by:

getPrincipalsOrBuilderList in interface Document.AclInfo.AccessRestrictionOrBuilder

getPrincipalsCount

public int getPrincipalsCount()

 List of principals.
 

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

Specified by:

getPrincipalsCount in interface Document.AclInfo.AccessRestrictionOrBuilder

getPrincipals

public Principal getPrincipals(int index)

 List of principals.
 

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

Specified by:

getPrincipals in interface Document.AclInfo.AccessRestrictionOrBuilder

getPrincipalsOrBuilder

public PrincipalOrBuilder getPrincipalsOrBuilder(int index)

 List of principals.
 

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

Specified by:

getPrincipalsOrBuilder in interface Document.AclInfo.AccessRestrictionOrBuilder

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Document.AclInfo.AccessRestriction parseFrom(ByteBuffer data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.AclInfo.AccessRestriction parseFrom(ByteBuffer data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.AclInfo.AccessRestriction parseFrom(com.google.protobuf.ByteString data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.AclInfo.AccessRestriction parseFrom(com.google.protobuf.ByteString data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.AclInfo.AccessRestriction parseFrom(byte[] data)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.AclInfo.AccessRestriction parseFrom(byte[] data,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.AclInfo.AccessRestriction parseFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

public static Document.AclInfo.AccessRestriction parseFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static Document.AclInfo.AccessRestriction parseDelimitedFrom(InputStream input)
                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static Document.AclInfo.AccessRestriction parseDelimitedFrom(InputStream input,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

parseFrom

public static Document.AclInfo.AccessRestriction parseFrom(com.google.protobuf.CodedInputStream input)
                                                    throws IOException

Throws:

IOException

parseFrom

public static Document.AclInfo.AccessRestriction parseFrom(com.google.protobuf.CodedInputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

newBuilderForType

public Document.AclInfo.AccessRestriction.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

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

newBuilder

public static Document.AclInfo.AccessRestriction.Builder newBuilder(Document.AclInfo.AccessRestriction prototype)

toBuilder

public Document.AclInfo.AccessRestriction.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Document.AclInfo.AccessRestriction.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Document.AclInfo.AccessRestriction getDefaultInstance()

parser

public static com.google.protobuf.Parser<Document.AclInfo.AccessRestriction> parser()

getParserForType

public com.google.protobuf.Parser<Document.AclInfo.AccessRestriction> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Document.AclInfo.AccessRestriction getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder