com.microsoft.azure.sdk.iot.service

Class Configuration

java.lang.Object

com.microsoft.azure.sdk.iot.service.Configuration

public class Configuration
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ConfigurationContent	content Specifies the configuration content
protected String	createdTimeUtc Datetime of configuration created time.
protected String	etag A string representing a ETAG
protected String	id Configuration name A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.
protected HashMap<String,String>	labels Specifies the labels map of the configuration
protected String	lastUpdatedTimeUtc Datetime of configuration last updated time.
protected ConfigurationMetrics	metrics Specifies the custom configuration metrics
protected Integer	priority Specifies the priority
protected String	schemaVersion Specifies the schemaVersion
protected ConfigurationMetrics	systemMetrics Specifies the system configuration metrics
protected String	targetCondition Specifies the targetCondition
protected String	UTC_TIME_DEFAULT

Constructor Summary

Constructors

Constructor and Description
Configuration(String configurationId) Create a Configuration instance using the given configuration name

Method Summary

Modifier and Type	Method and Description
ConfigurationContent	getContent() Getter for configuration content
String	getCreatedTimeUtc() Getter for configuration created time
String	getEtag() Getter for eTag
String	getId() Getter for configuration name
HashMap<String,String>	getLabels() Getter for labels
String	getLastUpdatedTimeUtc() Getter for configuration last updated time string
ConfigurationMetrics	getMetrics() Getter for the custom configuration metrics
Integer	getPriority() Getter for the configuration priority
String	getSchemaVersion() Getter for schema version
ConfigurationMetrics	getSystemMetrics() Getter for the system configuration metrics
String	getTargetCondition() Getter for targetCondition
void	setContent(ConfigurationContent content) Setter for the configuration content
void	setEtag(String etag) Setter for the ETAG
void	setForceUpdate(Boolean forceUpdate) Deprecated. This method currently only validates forceUpdate parameter
void	setLabels(HashMap<String,String> labels) Setter for the labels of the configuration
void	setMetrics(ConfigurationMetrics metrics) Set the configuration metrics of this object
void	setPriority(Integer priority) Setter for the configuration priority
void	setTargetCondition(String targetCondition) Setter for the targetCondition

Methods inherited from class java.lang.Object

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

Field Detail

UTC_TIME_DEFAULT

protected final String UTC_TIME_DEFAULT

See Also:

Constant Field Values

id

protected String id

Configuration name A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + {'-', ':', '.', '+', '%', '_', '#', '*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''}.

schemaVersion

protected String schemaVersion

Specifies the schemaVersion

labels

protected HashMap<String,String> labels

Specifies the labels map of the configuration

content

protected ConfigurationContent content

Specifies the configuration content

targetCondition

protected String targetCondition

Specifies the targetCondition

createdTimeUtc

protected String createdTimeUtc

Datetime of configuration created time.

lastUpdatedTimeUtc

protected String lastUpdatedTimeUtc

Datetime of configuration last updated time.

priority

protected Integer priority

Specifies the priority

systemMetrics

protected ConfigurationMetrics systemMetrics

Specifies the system configuration metrics

metrics

protected ConfigurationMetrics metrics

Specifies the custom configuration metrics

etag

protected String etag

A string representing a ETAG

Constructor Detail

Configuration

public Configuration(String configurationId)

Create a Configuration instance using the given configuration name

Parameters:

configurationId - Name of the configuration (used as configuration id)

Throws:

IllegalArgumentException - This exception is thrown if deviceId or moduleId is null or empty.

Method Detail

getId

public String getId()

Getter for configuration name

Returns:

The configuration string

getSchemaVersion

public String getSchemaVersion()

Getter for schema version

Returns:

The schema version

setLabels

public void setLabels(HashMap<String,String> labels)

Setter for the labels of the configuration

Parameters:

labels - labels to be set

getLabels

public HashMap<String,String> getLabels()

Getter for labels

Returns:

The labels map

setMetrics

public void setMetrics(ConfigurationMetrics metrics)

Set the configuration metrics of this object

Parameters:

metrics - the metrics to set

setContent

public void setContent(ConfigurationContent content)

Setter for the configuration content

Parameters:

content - configuration content to be set

getContent

public ConfigurationContent getContent()

Getter for configuration content

Returns:

The configuration content object

setTargetCondition

public void setTargetCondition(String targetCondition)

Setter for the targetCondition

Parameters:

targetCondition - targetCondition to be set

getTargetCondition

public String getTargetCondition()

Getter for targetCondition

Returns:

The targetCondition string

getCreatedTimeUtc

public String getCreatedTimeUtc()

Getter for configuration created time

Returns:

The string containing the time when the configuration was created

getLastUpdatedTimeUtc

public String getLastUpdatedTimeUtc()

Getter for configuration last updated time string

Returns:

The string containing the time when the configuration was last updated

setPriority

public void setPriority(Integer priority)

Setter for the configuration priority

Parameters:

priority - to be set

getPriority

public Integer getPriority()

Getter for the configuration priority

Returns:

The Integer containing the priority

getSystemMetrics

public ConfigurationMetrics getSystemMetrics()

Getter for the system configuration metrics

Returns:

The system configuration metrics object

getMetrics

public ConfigurationMetrics getMetrics()

Getter for the custom configuration metrics

Returns:

The custom configuration metrics object

setEtag

public void setEtag(String etag)

Setter for the ETAG

Parameters:

etag - to be set

getEtag

public String getEtag()

Getter for eTag

Returns:

The eTag string

setForceUpdate

@Deprecated
public void setForceUpdate(Boolean forceUpdate)
                                 throws IllegalArgumentException

Deprecated. This method currently only validates forceUpdate parameter

Setter for force update boolean

Parameters:

forceUpdate - - Boolean controlling if the update should be forced or not

Throws:

IllegalArgumentException - if the provided argument is null