com.yahoo.bullet.common

Class BulletConfig

java.lang.Object

com.yahoo.bullet.common.Config

com.yahoo.bullet.common.BulletConfig

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

HTTPMetricPublisherConfig, RESTPubSubConfig, StorageConfig

public class BulletConfig
extends Config

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	AGGREGATION_COMPOSITE_FIELD_SEPARATOR
static String	AGGREGATION_DEFAULT_SIZE
static String	AGGREGATION_MAX_SIZE
static String	ALPHA_SKETCH_FAMILY
static String	COUNT_DISTINCT_AGGREGATION_SKETCH_ENTRIES
static String	COUNT_DISTINCT_AGGREGATION_SKETCH_FAMILY
static String	COUNT_DISTINCT_AGGREGATION_SKETCH_RESIZE_FACTOR
static String	COUNT_DISTINCT_AGGREGATION_SKETCH_SAMPLING
static String	DEFAULT_AGGREGATION_COMPOSITE_FIELD_SEPARATOR
static int	DEFAULT_AGGREGATION_MAX_SIZE
static int	DEFAULT_AGGREGATION_SIZE
static String	DEFAULT_CONFIGURATION_NAME
static int	DEFAULT_COUNT_DISTINCT_AGGREGATION_SKETCH_ENTRIES
static String	DEFAULT_COUNT_DISTINCT_AGGREGATION_SKETCH_FAMILY
static int	DEFAULT_COUNT_DISTINCT_AGGREGATION_SKETCH_RESIZE_FACTOR
static float	DEFAULT_COUNT_DISTINCT_AGGREGATION_SKETCH_SAMPLING
static int	DEFAULT_DISTRIBUTION_AGGREGATION_GENERATED_POINTS_ROUNDING
static int	DEFAULT_DISTRIBUTION_AGGREGATION_MAX_POINTS
static int	DEFAULT_DISTRIBUTION_AGGREGATION_SKETCH_ENTRIES
static String	DEFAULT_EQUALITY_PARTITIONER_DELIMITER
static int	DEFAULT_GROUP_AGGREGATION_MAX_SIZE
static int	DEFAULT_GROUP_AGGREGATION_SKETCH_ENTRIES
static int	DEFAULT_GROUP_AGGREGATION_SKETCH_RESIZE_FACTOR
static float	DEFAULT_GROUP_AGGREGATION_SKETCH_SAMPLING
static String	DEFAULT_PUBSUB_CLASS_NAME
static String	DEFAULT_PUBSUB_CONTEXT_NAME
static long	DEFAULT_QUERY_DURATION
static long	DEFAULT_QUERY_MAX_DURATION
static String	DEFAULT_QUERY_PARTITIONER_CLASS_NAME
static boolean	DEFAULT_QUERY_PARTITIONER_ENABLE
static boolean	DEFAULT_RATE_LIMIT_ENABLE
static long	DEFAULT_RATE_LIMIT_MAX_EMIT_COUNT
static long	DEFAULT_RATE_LIMIT_TIME_INTERVAL
static int	DEFAULT_RAW_AGGREGATION_MAX_SIZE
static String	DEFAULT_RECORD_PROVIDER_CLASS_NAME
static boolean	DEFAULT_RESULT_METADATA_ENABLE
static List<Map<String,String>>	DEFAULT_RESULT_METADATA_METRICS The mapping from Metadata concepts to the keys with which they should logged in the result metadata.
static int	DEFAULT_TOP_K_AGGREGATION_SKETCH_ENTRIES
static String	DEFAULT_TOP_K_AGGREGATION_SKETCH_ERROR_TYPE
static boolean	DEFAULT_WINDOW_DISABLE
static int	DEFAULT_WINDOW_MIN_EMIT_EVERY
static String	DISTRIBUTION_AGGREGATION_GENERATED_POINTS_ROUNDING
static String	DISTRIBUTION_AGGREGATION_MAX_POINTS
static String	DISTRIBUTION_AGGREGATION_SKETCH_ENTRIES
static String	EQUALITY_PARTITIONER_DELIMITER
static String	EQUALITY_PARTITIONER_FIELDS
static String	GROUP_AGGREGATION_MAX_SIZE
static String	GROUP_AGGREGATION_SKETCH_ENTRIES
static String	GROUP_AGGREGATION_SKETCH_RESIZE_FACTOR
static String	GROUP_AGGREGATION_SKETCH_SAMPLING
static int	MAXIMUM_EQUALITY_FIELDS
static String	METRIC_PUBLISHER_CLASS_NAME
static String	PUBSUB_CLASS_NAME
static String	PUBSUB_CONTEXT_NAME
static String	QUERY_DEFAULT_DURATION
static String	QUERY_MAX_DURATION
static String	QUERY_PARTITIONER_CLASS_NAME
static String	QUERY_PARTITIONER_ENABLE
static String	QUICKSELECT_SKETCH_FAMILY
static String	RATE_LIMIT_ENABLE
static String	RATE_LIMIT_MAX_EMIT_COUNT
static String	RATE_LIMIT_TIME_INTERVAL
static String	RAW_AGGREGATION_MAX_SIZE
static String	RECORD_PROVIDER_CLASS_NAME
static String	RECORD_SCHEMA_FILE_NAME
static String	RESULT_METADATA_ENABLE
static String	RESULT_METADATA_METRICS
static String	RESULT_METADATA_METRICS_CONCEPT_KEY
static String	RESULT_METADATA_METRICS_NAME_KEY
static String	STORAGE_CLASS_NAME
static String	TOP_K_AGGREGATION_SKETCH_ENTRIES
static String	TOP_K_AGGREGATION_SKETCH_ERROR_TYPE
static String	WINDOW_DISABLE
static String	WINDOW_MIN_EMIT_EVERY

Fields inherited from class com.yahoo.bullet.common.Config

DELIMITER

Constructor Summary

Constructors

Constructor and Description
BulletConfig() Constructor that loads just the defaults.
BulletConfig(String file) Constructor that loads specific file augmented with defaults and validates itself.

Method Summary

Modifier and Type	Method and Description
com.yahoo.bullet.record.BulletRecordProvider	getBulletRecordProvider() Get the BulletRecordProvider stored in this BulletConfig instance.
com.yahoo.bullet.typesystem.Schema	getSchema()
static Validator	getValidator() Returns a copy of the Validator used by this config.
<S> S	loadConfiguredClass(String classNameKey) This method loads a given class name (stored in this config) with the class name key and creates an instance of it by using a constructor that has a single argument for a BulletConfig.
void	merge(Config other) Merges another Config into this one.
BulletConfig	validate() Validates and fixes configuration for this config.

Methods inherited from class com.yahoo.bullet.common.Config

clear, get, getAll, getAllBut, getAllWithPrefix, getAs, getOrDefault, getOrDefaultAs, getRequiredConfigAs, readYAML, set, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

QUERY_DEFAULT_DURATION

public static final String QUERY_DEFAULT_DURATION

See Also:

Constant Field Values

QUERY_MAX_DURATION

public static final String QUERY_MAX_DURATION

See Also:

Constant Field Values

AGGREGATION_DEFAULT_SIZE

public static final String AGGREGATION_DEFAULT_SIZE

See Also:

Constant Field Values

AGGREGATION_MAX_SIZE

public static final String AGGREGATION_MAX_SIZE

See Also:

Constant Field Values

AGGREGATION_COMPOSITE_FIELD_SEPARATOR

public static final String AGGREGATION_COMPOSITE_FIELD_SEPARATOR

See Also:

Constant Field Values

RAW_AGGREGATION_MAX_SIZE

public static final String RAW_AGGREGATION_MAX_SIZE

See Also:

Constant Field Values

COUNT_DISTINCT_AGGREGATION_SKETCH_ENTRIES

public static final String COUNT_DISTINCT_AGGREGATION_SKETCH_ENTRIES

See Also:

Constant Field Values

COUNT_DISTINCT_AGGREGATION_SKETCH_SAMPLING

public static final String COUNT_DISTINCT_AGGREGATION_SKETCH_SAMPLING

See Also:

Constant Field Values

COUNT_DISTINCT_AGGREGATION_SKETCH_FAMILY

public static final String COUNT_DISTINCT_AGGREGATION_SKETCH_FAMILY

See Also:

Constant Field Values

COUNT_DISTINCT_AGGREGATION_SKETCH_RESIZE_FACTOR

public static final String COUNT_DISTINCT_AGGREGATION_SKETCH_RESIZE_FACTOR

See Also:

Constant Field Values

GROUP_AGGREGATION_SKETCH_ENTRIES

public static final String GROUP_AGGREGATION_SKETCH_ENTRIES

See Also:

Constant Field Values

GROUP_AGGREGATION_MAX_SIZE

public static final String GROUP_AGGREGATION_MAX_SIZE

See Also:

Constant Field Values

GROUP_AGGREGATION_SKETCH_SAMPLING

public static final String GROUP_AGGREGATION_SKETCH_SAMPLING

See Also:

Constant Field Values

GROUP_AGGREGATION_SKETCH_RESIZE_FACTOR

public static final String GROUP_AGGREGATION_SKETCH_RESIZE_FACTOR

See Also:

Constant Field Values

DISTRIBUTION_AGGREGATION_SKETCH_ENTRIES

public static final String DISTRIBUTION_AGGREGATION_SKETCH_ENTRIES

See Also:

Constant Field Values

DISTRIBUTION_AGGREGATION_MAX_POINTS

public static final String DISTRIBUTION_AGGREGATION_MAX_POINTS

See Also:

Constant Field Values

DISTRIBUTION_AGGREGATION_GENERATED_POINTS_ROUNDING

public static final String DISTRIBUTION_AGGREGATION_GENERATED_POINTS_ROUNDING

See Also:

Constant Field Values

TOP_K_AGGREGATION_SKETCH_ENTRIES

public static final String TOP_K_AGGREGATION_SKETCH_ENTRIES

See Also:

Constant Field Values

TOP_K_AGGREGATION_SKETCH_ERROR_TYPE

public static final String TOP_K_AGGREGATION_SKETCH_ERROR_TYPE

See Also:

Constant Field Values

RESULT_METADATA_ENABLE

public static final String RESULT_METADATA_ENABLE

See Also:

Constant Field Values

RESULT_METADATA_METRICS

public static final String RESULT_METADATA_METRICS

See Also:

Constant Field Values

RESULT_METADATA_METRICS_CONCEPT_KEY

public static final String RESULT_METADATA_METRICS_CONCEPT_KEY

See Also:

Constant Field Values

RESULT_METADATA_METRICS_NAME_KEY

public static final String RESULT_METADATA_METRICS_NAME_KEY

See Also:

Constant Field Values

WINDOW_DISABLE

public static final String WINDOW_DISABLE

See Also:

Constant Field Values

WINDOW_MIN_EMIT_EVERY

public static final String WINDOW_MIN_EMIT_EVERY

See Also:

Constant Field Values

RATE_LIMIT_ENABLE

public static final String RATE_LIMIT_ENABLE

See Also:

Constant Field Values

RATE_LIMIT_MAX_EMIT_COUNT

public static final String RATE_LIMIT_MAX_EMIT_COUNT

See Also:

Constant Field Values

RATE_LIMIT_TIME_INTERVAL

public static final String RATE_LIMIT_TIME_INTERVAL

See Also:

Constant Field Values

PUBSUB_CONTEXT_NAME

public static final String PUBSUB_CONTEXT_NAME

See Also:

Constant Field Values

PUBSUB_CLASS_NAME

public static final String PUBSUB_CLASS_NAME

See Also:

Constant Field Values

STORAGE_CLASS_NAME

public static final String STORAGE_CLASS_NAME

See Also:

Constant Field Values

METRIC_PUBLISHER_CLASS_NAME

public static final String METRIC_PUBLISHER_CLASS_NAME

See Also:

Constant Field Values

RECORD_PROVIDER_CLASS_NAME

public static final String RECORD_PROVIDER_CLASS_NAME

See Also:

Constant Field Values

RECORD_SCHEMA_FILE_NAME

public static final String RECORD_SCHEMA_FILE_NAME

See Also:

Constant Field Values

QUERY_PARTITIONER_ENABLE

public static final String QUERY_PARTITIONER_ENABLE

See Also:

Constant Field Values

QUERY_PARTITIONER_CLASS_NAME

public static final String QUERY_PARTITIONER_CLASS_NAME

See Also:

Constant Field Values

EQUALITY_PARTITIONER_FIELDS

public static final String EQUALITY_PARTITIONER_FIELDS

See Also:

Constant Field Values

EQUALITY_PARTITIONER_DELIMITER

public static final String EQUALITY_PARTITIONER_DELIMITER

See Also:

Constant Field Values

DEFAULT_QUERY_DURATION

public static final long DEFAULT_QUERY_DURATION

See Also:

Constant Field Values

DEFAULT_QUERY_MAX_DURATION

public static final long DEFAULT_QUERY_MAX_DURATION

See Also:

Constant Field Values

DEFAULT_AGGREGATION_SIZE

public static final int DEFAULT_AGGREGATION_SIZE

See Also:

Constant Field Values

DEFAULT_AGGREGATION_MAX_SIZE

public static final int DEFAULT_AGGREGATION_MAX_SIZE

See Also:

Constant Field Values

DEFAULT_AGGREGATION_COMPOSITE_FIELD_SEPARATOR

public static final String DEFAULT_AGGREGATION_COMPOSITE_FIELD_SEPARATOR

See Also:

Constant Field Values

DEFAULT_RAW_AGGREGATION_MAX_SIZE

public static final int DEFAULT_RAW_AGGREGATION_MAX_SIZE

See Also:

Constant Field Values

QUICKSELECT_SKETCH_FAMILY

public static final String QUICKSELECT_SKETCH_FAMILY

See Also:

Constant Field Values

ALPHA_SKETCH_FAMILY

public static final String ALPHA_SKETCH_FAMILY

See Also:

Constant Field Values

DEFAULT_COUNT_DISTINCT_AGGREGATION_SKETCH_ENTRIES

public static final int DEFAULT_COUNT_DISTINCT_AGGREGATION_SKETCH_ENTRIES

See Also:

Constant Field Values

DEFAULT_COUNT_DISTINCT_AGGREGATION_SKETCH_SAMPLING

public static final float DEFAULT_COUNT_DISTINCT_AGGREGATION_SKETCH_SAMPLING

See Also:

Constant Field Values

DEFAULT_COUNT_DISTINCT_AGGREGATION_SKETCH_FAMILY

public static final String DEFAULT_COUNT_DISTINCT_AGGREGATION_SKETCH_FAMILY

See Also:

Constant Field Values

DEFAULT_COUNT_DISTINCT_AGGREGATION_SKETCH_RESIZE_FACTOR

public static final int DEFAULT_COUNT_DISTINCT_AGGREGATION_SKETCH_RESIZE_FACTOR

See Also:

Constant Field Values

DEFAULT_GROUP_AGGREGATION_SKETCH_ENTRIES

public static final int DEFAULT_GROUP_AGGREGATION_SKETCH_ENTRIES

See Also:

Constant Field Values

DEFAULT_GROUP_AGGREGATION_MAX_SIZE

public static final int DEFAULT_GROUP_AGGREGATION_MAX_SIZE

See Also:

Constant Field Values

DEFAULT_GROUP_AGGREGATION_SKETCH_SAMPLING

public static final float DEFAULT_GROUP_AGGREGATION_SKETCH_SAMPLING

See Also:

Constant Field Values

DEFAULT_GROUP_AGGREGATION_SKETCH_RESIZE_FACTOR

public static final int DEFAULT_GROUP_AGGREGATION_SKETCH_RESIZE_FACTOR

See Also:

Constant Field Values

DEFAULT_DISTRIBUTION_AGGREGATION_SKETCH_ENTRIES

public static final int DEFAULT_DISTRIBUTION_AGGREGATION_SKETCH_ENTRIES

See Also:

Constant Field Values

DEFAULT_DISTRIBUTION_AGGREGATION_MAX_POINTS

public static final int DEFAULT_DISTRIBUTION_AGGREGATION_MAX_POINTS

See Also:

Constant Field Values

DEFAULT_DISTRIBUTION_AGGREGATION_GENERATED_POINTS_ROUNDING

public static final int DEFAULT_DISTRIBUTION_AGGREGATION_GENERATED_POINTS_ROUNDING

See Also:

Constant Field Values

DEFAULT_TOP_K_AGGREGATION_SKETCH_ENTRIES

public static final int DEFAULT_TOP_K_AGGREGATION_SKETCH_ENTRIES

See Also:

Constant Field Values

DEFAULT_TOP_K_AGGREGATION_SKETCH_ERROR_TYPE

public static final String DEFAULT_TOP_K_AGGREGATION_SKETCH_ERROR_TYPE

See Also:

Constant Field Values

DEFAULT_RESULT_METADATA_ENABLE

public static final boolean DEFAULT_RESULT_METADATA_ENABLE

See Also:

Constant Field Values

DEFAULT_RESULT_METADATA_METRICS

public static final List<Map<String,String>> DEFAULT_RESULT_METADATA_METRICS

The mapping from Metadata concepts to the keys with which they should logged in the result metadata.

DEFAULT_WINDOW_DISABLE

public static final boolean DEFAULT_WINDOW_DISABLE

See Also:

Constant Field Values

DEFAULT_WINDOW_MIN_EMIT_EVERY

public static final int DEFAULT_WINDOW_MIN_EMIT_EVERY

See Also:

Constant Field Values

DEFAULT_RATE_LIMIT_ENABLE

public static final boolean DEFAULT_RATE_LIMIT_ENABLE

See Also:

Constant Field Values

DEFAULT_RATE_LIMIT_MAX_EMIT_COUNT

public static final long DEFAULT_RATE_LIMIT_MAX_EMIT_COUNT

See Also:

Constant Field Values

DEFAULT_RATE_LIMIT_TIME_INTERVAL

public static final long DEFAULT_RATE_LIMIT_TIME_INTERVAL

See Also:

Constant Field Values

DEFAULT_PUBSUB_CONTEXT_NAME

public static final String DEFAULT_PUBSUB_CONTEXT_NAME

DEFAULT_PUBSUB_CLASS_NAME

public static final String DEFAULT_PUBSUB_CLASS_NAME

See Also:

Constant Field Values

DEFAULT_RECORD_PROVIDER_CLASS_NAME

public static final String DEFAULT_RECORD_PROVIDER_CLASS_NAME

See Also:

Constant Field Values

DEFAULT_QUERY_PARTITIONER_ENABLE

public static final boolean DEFAULT_QUERY_PARTITIONER_ENABLE

See Also:

Constant Field Values

DEFAULT_QUERY_PARTITIONER_CLASS_NAME

public static final String DEFAULT_QUERY_PARTITIONER_CLASS_NAME

See Also:

Constant Field Values

DEFAULT_EQUALITY_PARTITIONER_DELIMITER

public static final String DEFAULT_EQUALITY_PARTITIONER_DELIMITER

See Also:

Constant Field Values

MAXIMUM_EQUALITY_FIELDS

public static final int MAXIMUM_EQUALITY_FIELDS

See Also:

Constant Field Values

DEFAULT_CONFIGURATION_NAME

public static final String DEFAULT_CONFIGURATION_NAME

See Also:

Constant Field Values

Constructor Detail

BulletConfig

public BulletConfig(String file)

Constructor that loads specific file augmented with defaults and validates itself.

Parameters:

file - YAML file to load.

BulletConfig

public BulletConfig()

Constructor that loads just the defaults.

Method Detail

getBulletRecordProvider

public com.yahoo.bullet.record.BulletRecordProvider getBulletRecordProvider()

Get the BulletRecordProvider stored in this BulletConfig instance. This BulletRecordProvider is created when this BulletConfig is constructed.

Returns:

The BulletRecordProvider instance.

getSchema

public com.yahoo.bullet.typesystem.Schema getSchema()

validate

public BulletConfig validate()

Validates and fixes configuration for this config. If there are undefaulted or wrongly typed elements, you should use a Validator to define the appropriate definitions, casters and defaults to use. You should call this method before you use the config if you set additional settings to ensure that all configurations are valid.

This class defines a validator for all the fields it knows about. If you subclass it and define your own fields, you should getValidator() and add entries and relationships that you need to validate. Make sure to call this method from your override if you wish validate your new definitions.

Returns:

This config for chaining.

getValidator

public static Validator getValidator()

Returns a copy of the Validator used by this config. You can use this to extend it with more Validator.Entry and Validator.Relationship items.

Returns:

A copy of the Validator object used.

merge

public void merge(Config other)

Description copied from class: Config

Merges another Config into this one.

Overrides:

merge in class Config

Parameters:

other - The other Config to merge into this one.

loadConfiguredClass

public <S> S loadConfiguredClass(String classNameKey)

This method loads a given class name (stored in this config) with the class name key and creates an instance of it by using a constructor that has a single argument for a BulletConfig. It then passes in this config and returns the constructed instance.

Type Parameters:

S - The type of the class.

Parameters:

classNameKey - The name of the key which stores the class name to load in this config.

Returns:

A created instance of this class.

Throws:

RuntimeException - if there were issues creating an instance. It wraps the real exception.