SetBlobVisibilityRequest


@ExperimentalAppSearchApi
class SetBlobVisibilityRequest


Request to configure the visibility settings of blobs in AppSearch.

Used with setBlobVisibilityAsync to specify visibility and display properties for blob namespaces. You can control which blob namespaces are displayed on system UI surfaces and which are accessible based on specific visibility configurations.

Summary

Nested types

Builder for SetBlobVisibilityRequest objects.

Public functions

(Mutable)Set<String!>

Returns all the blob namespaces that are opted out of being displayed and visible on any system UI surface.

(Mutable)Map<String!, (Mutable)Set<SchemaVisibilityConfig!>!>

Returns a mapping of blob namespaces to the set of SchemaVisibilityConfigs that have access to that namespace.

Public functions

getNamespacesNotDisplayedBySystem

Added in 1.1.0-alpha07
fun getNamespacesNotDisplayedBySystem(): (Mutable)Set<String!>

Returns all the blob namespaces that are opted out of being displayed and visible on any system UI surface.

getNamespacesVisibleToConfigs

Added in 1.1.0-alpha07
fun getNamespacesVisibleToConfigs(): (Mutable)Map<String!, (Mutable)Set<SchemaVisibilityConfig!>!>

Returns a mapping of blob namespaces to the set of SchemaVisibilityConfigs that have access to that namespace.

All conditions in a single SchemaVisibilityConfig are "AND" relationship. A caller must match all conditions to have the access. All SchemaVisibilityConfigs in the set of a blob namespace are "OR" relationship. A caller could have access if they matches any SchemaVisibilityConfig in the set.

This method provides the set of SchemaVisibilityConfig for all blob namespaces.