io.micronaut.discovery.aws.parameterstore

Class ParameterQuery

java.lang.Object

io.micronaut.discovery.aws.parameterstore.ParameterQuery

public class ParameterQuery
extends java.lang.Object

An object encapsulating all necessary parameters to perform a request for configuration values to the Parameter Store, as well as the name of the resulting property source and associated priority.

Since:

2.3.0

Author:

ttzn

Constructor Summary

Constructors

Constructor and Description
ParameterQuery(java.lang.String path, java.lang.String propertySourceName, int priority)
ParameterQuery(java.lang.String path, java.lang.String propertySourceName, int priority, boolean name)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPath()
int	getPriority()
java.lang.String	getPropertySourceName()
boolean	isName()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterQuery

public ParameterQuery(java.lang.String path,
                      java.lang.String propertySourceName,
                      int priority)

ParameterQuery

public ParameterQuery(java.lang.String path,
                      java.lang.String propertySourceName,
                      int priority,
                      boolean name)

Method Detail

getPath

public java.lang.String getPath()

Returns:

the path to be used when querying the Parameter Store; if isName() is true, it will be used as names in a GetParameters request, call, otherwise it is the path parameter of a GetParametersByPath.

getPropertySourceName

public java.lang.String getPropertySourceName()

Returns:

the name of the property source that will hold the retrieved configuration values.

isName

public boolean isName()

Returns:

whether the current query should be performed using the GetParameters API instead of GetParametersByPath. This is almost never not what you want.

getPriority

public int getPriority()

Returns:

the priority of the property source that will hold the retrieved configuration values.