Package com.elastisys.autoscaler.metricstreamers.ceilometer.config

Class CeilometerMetricStreamerConfig

java.lang.Object

com.elastisys.autoscaler.metricstreamers.ceilometer.config.CeilometerMetricStreamerConfig

public class CeilometerMetricStreamerConfig
extends java.lang.Object

Carries configuration parameters for the CeilometerMetricStreamer.

See Also:

CeilometerMetricStreamer

Constructor Summary

Constructors

Constructor	Description
CeilometerMetricStreamerConfig(com.elastisys.scale.commons.openstack.AuthConfig auth, java.lang.String region, com.elastisys.scale.commons.json.types.TimeInterval pollInterval, java.util.List<CeilometerMetricStreamDefinition> metricStreams)	Creates a new CeilometerMetricStreamerConfig.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
com.elastisys.scale.commons.openstack.AuthConfig	getAuth()	Declares how to authenticate with the OpenStack identity service (Keystone).
java.util.List<CeilometerMetricStreamDefinition>	getMetricStreams()	The collection of published MetricStreams.
com.elastisys.scale.commons.json.types.TimeInterval	getPollInterval()	Returns the polling interval (given in seconds) for metric streams.
java.lang.String	getRegion()	The particular OpenStack region (out of the ones available in Keystone's service catalog) to connect to.
int	hashCode()
java.lang.String	toString()
void	validate()	Validates the configuration.
CeilometerMetricStreamerConfig	withMetricStream(CeilometerMetricStreamDefinition stream)	Returns a copy of this CeilometerMetricStreamerConfig with an additional CeilometerMetricStreamDefinition.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CeilometerMetricStreamerConfig

public CeilometerMetricStreamerConfig(com.elastisys.scale.commons.openstack.AuthConfig auth,
                                      java.lang.String region,
                                      com.elastisys.scale.commons.json.types.TimeInterval pollInterval,
                                      java.util.List<CeilometerMetricStreamDefinition> metricStreams)

Creates a new CeilometerMetricStreamerConfig.

Parameters:

auth - The authentication block, either in version 2 or version 3 format. Required.

region - The particular OpenStack region (out of the ones available in Keystone's service catalog) to connect to. For example, RegionOne. Required.

pollInterval - The polling interval for metric streams.

metricStreams - The collection of published MetricStreams. May be null.

Method Detail

getAuth

public com.elastisys.scale.commons.openstack.AuthConfig getAuth()

Declares how to authenticate with the OpenStack identity service (Keystone).

Returns:

getRegion

public java.lang.String getRegion()

The particular OpenStack region (out of the ones available in Keystone's service catalog) to connect to. For example, RegionOne.

Returns:

getPollInterval

public com.elastisys.scale.commons.json.types.TimeInterval getPollInterval()

Returns the polling interval (given in seconds) for metric streams.

Returns:

getMetricStreams

public java.util.List<CeilometerMetricStreamDefinition> getMetricStreams()

The collection of published MetricStreams.

Returns:

validate

public void validate()
              throws java.lang.IllegalArgumentException

Validates the configuration. On validation error, an IllegalArgumentException is thrown.

Throws:

java.lang.IllegalArgumentException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

withMetricStream

public CeilometerMetricStreamerConfig withMetricStream(CeilometerMetricStreamDefinition stream)

Returns a copy of this CeilometerMetricStreamerConfig with an additional CeilometerMetricStreamDefinition. Note that the instance that this method is invoked on remains unchanged.

Parameters:

stream - The CeilometerMetricStreamDefinition that will be added in the returned copy.

Returns:

A copy of this CeilometerMetricStreamerConfig with the stream definition added.