brooklyn-maven-plugin - brooklyn:sensor

brooklyn:sensor

Full name:

io.brooklyn.maven:brooklyn-maven-plugin:0.3.0:sensor

Description:

Fetch the value of a sensor on entities at a given server whose types match a regular expression.

Attributes:

Requires a Maven project to be executed.
Binds by default to the lifecycle phase: pre-integration-test.

Required Parameters

Name	Type	Since	Description
application	`String`	`-`	The ID of the application whose entities should be queried. User property is: `brooklyn.app`.
sensor	`String`	`-`	The name of the sensor to query. User property is: `brooklyn.sensor`.

Optional Parameters

Name	Type	Since	Description
failIfNoMatches	`boolean`	`-`	Configure the plugin to fail the build if no entities in the application have a sensor with the given name. Default value is: `false`.
ignoreSkipTests	`Boolean`	`-`	Configure the goal to ignore `skipTests`. Useful if your use of the plugin is outside of the default pre- and post-integration-test phases. Default value is: `false`. User property is: `ignoreSkipTests`.
password	`String`	`-`	The password for the user at the Brooklyn server. User property is: `brooklyn.password`.
pollPeriod	`Integer`	`-`	The period that should be waited between successive polls of the Brooklyn server. Default value is: `5`. User property is: `brooklyn.pollPeriod`.
pollUnit	`TimeUnit`	`-`	The unit associated with `pollPeriod`. Default value is: `SECONDS`. User property is: `brooklyn.pollUnit`.
sensorValueProperty	`String`	`-`	The property to set to the sensor's value. Default value is: `brooklyn.sensor`.
server	`URL`	`-`	The URL of the Brooklyn server to communicate with. User property is: `brooklyn.server`.
skipITs	`Boolean`	`-`	Configure the goal to skip execution. Default value is: `false`. User property is: `skipITs`.
skipTests	`Boolean`	`-`	Configure the goal to skip execution. Default value is: `false`. User property is: `skipTests`.
tearDownOnFailure	`boolean`	`-`	Sets whether servers started by `StartBrooklynMojo` should be stopped if execution of the goal fails. Default value is: `true`. User property is: `brooklyn.tearDownOnFailure`.
timeout	`Integer`	`-`	The duration mojos should wait for actions at Brooklyn to complete. Default value is: `5`. User property is: `brooklyn.timeout`.
timeoutUnit	`TimeUnit`	`-`	The unit associated with `timeout`. Default value is: `MINUTES`. User property is: `brooklyn.timeoutUnit`.
typeRegex	`String`	`-`	Regular expression to match entities by type. Default value is: `.`. User property is*: `brooklyn.entityTypeRegex`.
username	`String`	`-`	The user to connect to the Brooklyn server as. User property is: `brooklyn.user`.
waitForRunning	`boolean`	`-`	Configure the plugin to wait for the application to be `running` before retrieving sensor values or to throw a `MojoFailureException` if it is not running within the configured `timeout`. Default value is: `false`.

Parameter Details

application:

The ID of the application whose entities should be queried.

Type: java.lang.String
Required: Yes
User Property: brooklyn.app

failIfNoMatches:

Configure the plugin to fail the build if no entities in the application have a sensor with the given name.

Type: boolean
Required: No
Default: false

ignoreSkipTests:

Configure the goal to ignore skipTests. Useful if your use of the plugin is outside of the default pre- and post-integration-test phases.

Type: java.lang.Boolean
Required: No
User Property: ignoreSkipTests
Default: false

password:

The password for the user at the Brooklyn server.

Type: java.lang.String
Required: No
User Property: brooklyn.password

pollPeriod:

The period that should be waited between successive polls of the Brooklyn server.

Type: java.lang.Integer
Required: No
User Property: brooklyn.pollPeriod
Default: 5

pollUnit:

The unit associated with pollPeriod.

Type: java.util.concurrent.TimeUnit
Required: No
User Property: brooklyn.pollUnit
Default: SECONDS

sensor:

The name of the sensor to query.

Type: java.lang.String
Required: Yes
User Property: brooklyn.sensor

sensorValueProperty:

The property to set to the sensor's value.

Type: java.lang.String
Required: No
Default: brooklyn.sensor

server:

The URL of the Brooklyn server to communicate with.

Type: java.net.URL
Required: No
User Property: brooklyn.server

skipITs:

Configure the goal to skip execution.

Type: java.lang.Boolean
Required: No
User Property: skipITs
Default: false

skipTests:

Configure the goal to skip execution.

Type: java.lang.Boolean
Required: No
User Property: skipTests
Default: false

tearDownOnFailure:

Sets whether servers started by StartBrooklynMojo should be stopped if execution of the goal fails.

Type: boolean
Required: No
User Property: brooklyn.tearDownOnFailure
Default: true

timeout:

The duration mojos should wait for actions at Brooklyn to complete.

Type: java.lang.Integer
Required: No
User Property: brooklyn.timeout
Default: 5

timeoutUnit:

The unit associated with timeout.

Type: java.util.concurrent.TimeUnit
Required: No
User Property: brooklyn.timeoutUnit
Default: MINUTES

typeRegex:

Regular expression to match entities by type.

Type: java.lang.String
Required: No
User Property: brooklyn.entityTypeRegex
Default: .*

username:

The user to connect to the Brooklyn server as.

Type: java.lang.String
Required: No
User Property: brooklyn.user

waitForRunning:

Configure the plugin to wait for the application to be running before retrieving sensor values or to throw a MojoFailureException if it is not running within the configured timeout.

Type: boolean
Required: No
Default: false