AclInheritanceMapping

Declares which document field holds the parent item reference used for Google Cloud Search ACL inheritance.

committer/googlecloudsearchJavadoc: AclInheritanceMapping

Notes

Lets an item inherit access rules from a parent instead of carrying the whole set itself — a file inheriting from its folder, a page from its site. The parent is identified by a reference stored on the document, and the inheritance type decides who wins when parent and child disagree.

Examples

Inherits access from the folder named in a parent_folder field, with the parent's rules taking precedence.

YAML

aclInheritanceMapping:
  fromField: parent_folder
  aclInheritanceType: PARENT_OVERRIDE

JSON

{
  "aclInheritanceMapping": {
    "fromField": "parent_folder",
    "aclInheritanceType": "PARENT_OVERRIDE"
  }
}

XML

<aclInheritanceMapping>
  <fromField>parent_folder</fromField>
  <aclInheritanceType>PARENT_OVERRIDE</aclInheritanceType>
</aclInheritanceMapping>

Usage

Full configuration skeleton, with every option and its default

YAML

aclInheritanceType: NOT_APPLICABLE
fromField: string

JSON

{
  "aclInheritanceType": "NOT_APPLICABLE",
  "fromField": "string"
}

XML

<aclInheritance>
  <aclInheritanceType>NOT_APPLICABLE</aclInheritanceType>
  <fromField>string</fromField>
</aclInheritance>

Properties

Property	Type	Required	Default
aclInheritanceType	enum	No	NOT_APPLICABLE
fromField	string	No	-

Property Details

aclInheritanceType

How the child's own ACLs combine with the parent's:

Value	Effect
NOT_APPLICABLE	No inheritance; the item's own ACLs decide. The default.
CHILD_OVERRIDE	The child's ACLs win where the two conflict.
PARENT_OVERRIDE	The parent's ACLs win where the two conflict.
BOTH_PERMIT	Access requires both parent and child to permit it.

Allowed Values

• NOT_APPLICABLE
• CHILD_OVERRIDE
• PARENT_OVERRIDE
• BOTH_PERMIT

fromField

Document field holding the reference of the parent item to inherit from. The value must match the parent's item reference as committed.