public class

UserConfig

extends NamespacedConfig
java.lang.Object
   ↳ org.apache.helix.ZNRecord
     ↳ org.apache.helix.api.config.NamespacedConfig
       ↳ org.apache.helix.api.config.UserConfig

Class Overview

Generic user-defined configuration of Helix components

Summary

[Expand]
Inherited Constants
From class org.apache.helix.api.config.NamespacedConfig
From class org.apache.helix.ZNRecord
Public Constructors
UserConfig(Scope<?> scope)
Instantiate a UserConfig.
Public Methods
static UserConfig from(HelixProperty property)
Get a UserConfig that filters out the user-specific configurations in a property
[Expand]
Inherited Methods
From class org.apache.helix.api.config.NamespacedConfig
From class org.apache.helix.ZNRecord
From class java.lang.Object

Public Constructors

public UserConfig (Scope<?> scope)

Instantiate a UserConfig. It is intended for use only by entities that can be identified

Parameters
scope scope of the configuration, e.g. cluster, resource, partition, participant, etc

Public Methods

public static UserConfig from (HelixProperty property)

Get a UserConfig that filters out the user-specific configurations in a property

Parameters
property the property to extract from
Returns
  • UserConfig