Google Cloud Discovery Engine V1 Client - Class AccessRestriction (1.6.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class AccessRestriction.

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" } ], } ] } }

Generated from protobuf message google.cloud.discoveryengine.v1.Document.AclInfo.AccessRestriction

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ Document \ AclInfo

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ principals array<Google\Cloud\DiscoveryEngine\V1\Principal>

List of principals.

↳ idp_wide bool

All users within the Identity Provider.

getPrincipals

List of principals.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPrincipals

List of principals.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\Principal>
Returns
Type Description
$this

getIdpWide

All users within the Identity Provider.

Returns
Type Description
bool

setIdpWide

All users within the Identity Provider.

Parameter
Name Description
var bool
Returns
Type Description
$this