SetBlobVisibilityRequest.Builder

Added in 1.1.0

Kotlin |Java

public final class SetBlobVisibilityRequest.Builder

Builder for SetBlobVisibilityRequest objects.

Summary

Public constructors
`Builder()`

Public methods
`@NonNull SetBlobVisibilityRequest.Builder`	`addNamespaceVisibleToConfig( @NonNull String namespace, @NonNull SchemaVisibilityConfig visibilityConfig )` Specifies that blobs within the given `namespace` can be accessed by the caller if they meet the requirements defined in `SchemaVisibilityConfig`.
`@NonNull SetBlobVisibilityRequest`	`build()` Builds a new `SetBlobVisibilityRequest` object.
`@NonNull SetBlobVisibilityRequest.Builder`	`clearNamespaceVisibleToConfigs(@NonNull String namespace)` Clears all visibility configurations for the specified blob `namespace`.
`@NonNull SetBlobVisibilityRequest.Builder`	`setNamespaceDisplayedBySystem( @NonNull String namespace, boolean displayed )` Sets whether or not blobs in the specified `namespace` will be displayed on any system UI surface.

Public constructors

Builder

Added in 1.1.0

public Builder()

Public methods

addNamespaceVisibleToConfig

Added in 1.1.0

public @NonNull SetBlobVisibilityRequest.Builder addNamespaceVisibleToConfig(
    @NonNull String namespace,
    @NonNull SchemaVisibilityConfig visibilityConfig
)

Specifies that blobs within the given namespace can be accessed by the caller if they meet the requirements defined in SchemaVisibilityConfig.

The requirements in each SchemaVisibilityConfig have an "AND" relationship, meaning that all conditions within a configuration must be met for access. For instance, the caller may need specific permissions and belong to a specific package.

Repeated calls to this method can add multiple SchemaVisibilityConfigs to a namespace. The caller will have access if they match any of the configurations added, so the configurations form an "OR" relationship.

Parameters
`@NonNull String namespace`	The blob namespace to set visibility for.
`@NonNull SchemaVisibilityConfig visibilityConfig`	The config hold specifying visibility settings.

build

Added in 1.1.0

public @NonNull SetBlobVisibilityRequest build()

Builds a new SetBlobVisibilityRequest object.

clearNamespaceVisibleToConfigs

Added in 1.1.0

public @NonNull SetBlobVisibilityRequest.Builder clearNamespaceVisibleToConfigs(@NonNull String namespace)

Clears all visibility configurations for the specified blob namespace.

After calling this method, the specified namespace will have no visibility configurations, meaning it will only be accessible by default rules.

Parameters
`@NonNull String namespace`	The blob namespace for which visibility config should be cleared.

setNamespaceDisplayedBySystem

Added in 1.1.0

public @NonNull SetBlobVisibilityRequest.Builder setNamespaceDisplayedBySystem(
    @NonNull String namespace,
    boolean displayed
)

Sets whether or not blobs in the specified namespace will be displayed on any system UI surface.

This setting applies to the provided namespace only, all other namespaces that are not included here will be reverted to the default displayed setting.

If this method is not called, the default behavior allows blobs to be displayed on system UI surfaces.

Parameters
`@NonNull String namespace`	The name of the namespace to configure visibility for.
`boolean displayed`	If `false`, blobs in this namespace will not appear on system UI surfaces.