- 0.72.0 (latest)
- 0.71.0
- 0.70.0
- 0.69.0
- 0.68.0
- 0.66.0
- 0.64.0
- 0.63.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class Document.AclInfo.AccessRestriction extends GeneratedMessageV3 implements Document.AclInfo.AccessRestrictionOrBuilderAclRestriction 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Document.AclInfo.AccessRestrictionImplements
Document.AclInfo.AccessRestrictionOrBuilderStatic Fields
IDP_WIDE_FIELD_NUMBER
public static final int IDP_WIDE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
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 |
|
getDefaultInstanceForType()
public Document.AclInfo.AccessRestriction getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Document.AclInfo.AccessRestriction |
|
getIdpWide()
public boolean getIdpWide()All users within the Identity Provider.
bool idp_wide = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
The idpWide. |
getParserForType()
public Parser<Document.AclInfo.AccessRestriction> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<AccessRestriction> |
|
getPrincipals(int index)
public Principal getPrincipals(int index)List of principals.
repeated .google.cloud.discoveryengine.v1.Principal principals = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Principal |
|
getPrincipalsCount()
public int getPrincipalsCount()List of principals.
repeated .google.cloud.discoveryengine.v1.Principal principals = 1;
| Returns | |
|---|---|
| Type | Description |
int |
|
getPrincipalsList()
public List<Principal> getPrincipalsList()List of principals.
repeated .google.cloud.discoveryengine.v1.Principal principals = 1;
| Returns | |
|---|---|
| Type | Description |
List<Principal> |
|
getPrincipalsOrBuilder(int index)
public PrincipalOrBuilder getPrincipalsOrBuilder(int index)List of principals.
repeated .google.cloud.discoveryengine.v1.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.v1.Principal principals = 1;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1.PrincipalOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
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 |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|