azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.sdk.iot...

365 строки
21 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.sdk.iot.service.Configuration"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration"
name: "Configuration"
nameWithType: "Configuration"
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **Configuration**"
constructors:
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.Configuration(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.Configuration(String configurationId)"
name: "Configuration(String configurationId)"
nameWithType: "Configuration.Configuration(String configurationId)"
summary: "Create a Configuration instance using the given configuration name"
parameters:
- description: "Name of the configuration (used as configuration id)"
name: "configurationId"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Configuration(String configurationId)"
desc: "Create a Configuration instance using the given configuration name"
fields:
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.UTC_TIME_DEFAULT"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.UTC_TIME_DEFAULT"
name: "UTC_TIME_DEFAULT"
nameWithType: "Configuration.UTC_TIME_DEFAULT"
modifiers:
- "protected"
- "final"
field:
value: "0001-01-01T00:00:00"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected final String UTC_TIME_DEFAULT"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.content"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.content"
name: "content"
nameWithType: "Configuration.content"
summary: "Specifies the configuration content"
modifiers:
- "protected"
field:
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.ConfigurationContent?alt=com.microsoft.azure.sdk.iot.service.ConfigurationContent&text=ConfigurationContent\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected ConfigurationContent content"
desc: "Specifies the configuration content"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.createdTimeUtc"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.createdTimeUtc"
name: "createdTimeUtc"
nameWithType: "Configuration.createdTimeUtc"
summary: "Datetime of configuration created time."
modifiers:
- "protected"
field:
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected String createdTimeUtc"
desc: "Datetime of configuration created time."
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.etag"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.etag"
name: "etag"
nameWithType: "Configuration.etag"
summary: "A string representing a ETAG"
modifiers:
- "protected"
field:
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected String etag"
desc: "A string representing a ETAG"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.id"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.id"
name: "id"
nameWithType: "Configuration.id"
summary: "Configuration name A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + \\{'-', ':', '.', '+', '%', '\\_', '\\#', '\\*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''\\}."
modifiers:
- "protected"
field:
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected String id"
desc: "Configuration name A case-sensitive string (up to 128 char long) of ASCII 7-bit alphanumeric chars + \\{'-', ':', '.', '+', '%', '\\_', '\\#', '\\*', '?', '!', '(', ')', ',', '=', '@', ';', '$', '''\\}."
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.labels"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.labels"
name: "labels"
nameWithType: "Configuration.labels"
summary: "Specifies the labels map of the configuration"
modifiers:
- "protected"
field:
type: "<xref href=\"java.util.HashMap?alt=java.util.HashMap&text=HashMap\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "protected HashMap<String,String> labels"
desc: "Specifies the labels map of the configuration"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.lastUpdatedTimeUtc"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.lastUpdatedTimeUtc"
name: "lastUpdatedTimeUtc"
nameWithType: "Configuration.lastUpdatedTimeUtc"
summary: "Datetime of configuration last updated time."
modifiers:
- "protected"
field:
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected String lastUpdatedTimeUtc"
desc: "Datetime of configuration last updated time."
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.metrics"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.metrics"
name: "metrics"
nameWithType: "Configuration.metrics"
summary: "Specifies the custom configuration metrics"
modifiers:
- "protected"
field:
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.ConfigurationMetrics?alt=com.microsoft.azure.sdk.iot.service.ConfigurationMetrics&text=ConfigurationMetrics\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected ConfigurationMetrics metrics"
desc: "Specifies the custom configuration metrics"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.priority"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.priority"
name: "priority"
nameWithType: "Configuration.priority"
summary: "Specifies the priority"
modifiers:
- "protected"
field:
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected Integer priority"
desc: "Specifies the priority"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.schemaVersion"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.schemaVersion"
name: "schemaVersion"
nameWithType: "Configuration.schemaVersion"
summary: "Specifies the schema<wbr>Version"
modifiers:
- "protected"
field:
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected String schemaVersion"
desc: "Specifies the schemaVersion"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.systemMetrics"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.systemMetrics"
name: "systemMetrics"
nameWithType: "Configuration.systemMetrics"
summary: "Specifies the system configuration metrics"
modifiers:
- "protected"
field:
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.ConfigurationMetrics?alt=com.microsoft.azure.sdk.iot.service.ConfigurationMetrics&text=ConfigurationMetrics\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected ConfigurationMetrics systemMetrics"
desc: "Specifies the system configuration metrics"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.targetCondition"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.targetCondition"
name: "targetCondition"
nameWithType: "Configuration.targetCondition"
summary: "Specifies the target<wbr>Condition"
modifiers:
- "protected"
field:
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "protected String targetCondition"
desc: "Specifies the targetCondition"
methods:
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.getContent()"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.getContent()"
name: "getContent()"
nameWithType: "Configuration.getContent()"
summary: "Getter for configuration content"
syntax: "public ConfigurationContent getContent()"
desc: "Getter for configuration content"
returns:
description: "The configuration content object"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.ConfigurationContent?alt=com.microsoft.azure.sdk.iot.service.ConfigurationContent&text=ConfigurationContent\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.getCreatedTimeUtc()"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.getCreatedTimeUtc()"
name: "getCreatedTimeUtc()"
nameWithType: "Configuration.getCreatedTimeUtc()"
summary: "Getter for configuration created time"
syntax: "public String getCreatedTimeUtc()"
desc: "Getter for configuration created time"
returns:
description: "The string containing the time when the configuration was created"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.getEtag()"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.getEtag()"
name: "getEtag()"
nameWithType: "Configuration.getEtag()"
summary: "Getter for e<wbr>Tag"
syntax: "public String getEtag()"
desc: "Getter for eTag"
returns:
description: "The eTag string"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.getId()"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.getId()"
name: "getId()"
nameWithType: "Configuration.getId()"
summary: "Getter for configuration name"
syntax: "public String getId()"
desc: "Getter for configuration name"
returns:
description: "The configuration string"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.getLabels()"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.getLabels()"
name: "getLabels()"
nameWithType: "Configuration.getLabels()"
summary: "Getter for labels"
syntax: "public HashMap<String,String> getLabels()"
desc: "Getter for labels"
returns:
description: "The labels map"
type: "<xref href=\"java.util.HashMap?alt=java.util.HashMap&text=HashMap\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.getLastUpdatedTimeUtc()"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.getLastUpdatedTimeUtc()"
name: "getLastUpdatedTimeUtc()"
nameWithType: "Configuration.getLastUpdatedTimeUtc()"
summary: "Getter for configuration last updated time string"
syntax: "public String getLastUpdatedTimeUtc()"
desc: "Getter for configuration last updated time string"
returns:
description: "The string containing the time when the configuration was last updated"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.getMetrics()"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.getMetrics()"
name: "getMetrics()"
nameWithType: "Configuration.getMetrics()"
summary: "Getter for the custom configuration metrics"
syntax: "public ConfigurationMetrics getMetrics()"
desc: "Getter for the custom configuration metrics"
returns:
description: "The custom configuration metrics object"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.ConfigurationMetrics?alt=com.microsoft.azure.sdk.iot.service.ConfigurationMetrics&text=ConfigurationMetrics\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.getPriority()"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.getPriority()"
name: "getPriority()"
nameWithType: "Configuration.getPriority()"
summary: "Getter for the configuration priority"
syntax: "public Integer getPriority()"
desc: "Getter for the configuration priority"
returns:
description: "The Integer containing the priority"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.getSchemaVersion()"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.getSchemaVersion()"
name: "getSchemaVersion()"
nameWithType: "Configuration.getSchemaVersion()"
summary: "Getter for schema version"
syntax: "public String getSchemaVersion()"
desc: "Getter for schema version"
returns:
description: "The schema version"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.getSystemMetrics()"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.getSystemMetrics()"
name: "getSystemMetrics()"
nameWithType: "Configuration.getSystemMetrics()"
summary: "Getter for the system configuration metrics"
syntax: "public ConfigurationMetrics getSystemMetrics()"
desc: "Getter for the system configuration metrics"
returns:
description: "The system configuration metrics object"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.ConfigurationMetrics?alt=com.microsoft.azure.sdk.iot.service.ConfigurationMetrics&text=ConfigurationMetrics\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.getTargetCondition()"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.getTargetCondition()"
name: "getTargetCondition()"
nameWithType: "Configuration.getTargetCondition()"
summary: "Getter for target<wbr>Condition"
syntax: "public String getTargetCondition()"
desc: "Getter for targetCondition"
returns:
description: "The targetCondition string"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.setContent(com.microsoft.azure.sdk.iot.service.ConfigurationContent)"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.setContent(ConfigurationContent content)"
name: "setContent(ConfigurationContent content)"
nameWithType: "Configuration.setContent(ConfigurationContent content)"
summary: "Setter for the configuration content"
parameters:
- description: "configuration content to be set"
name: "content"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.ConfigurationContent?alt=com.microsoft.azure.sdk.iot.service.ConfigurationContent&text=ConfigurationContent\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setContent(ConfigurationContent content)"
desc: "Setter for the configuration content"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.setEtag(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.setEtag(String etag)"
name: "setEtag(String etag)"
nameWithType: "Configuration.setEtag(String etag)"
summary: "Setter for the ETAG"
parameters:
- description: "to be set"
name: "etag"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setEtag(String etag)"
desc: "Setter for the ETAG"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.setForceUpdate(java.lang.Boolean)"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.setForceUpdate(Boolean forceUpdate)"
name: "setForceUpdate(Boolean forceUpdate)"
nameWithType: "Configuration.setForceUpdate(Boolean forceUpdate)"
summary: "Setter for force update boolean"
deprecatedTag: "This method currently only validates force<wbr>Update parameter"
parameters:
- description: "- Boolean controlling if the update should be forced or not"
name: "forceUpdate"
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "</br>public void setForceUpdate(Boolean forceUpdate)"
exceptions:
- description: "if the provided argument is null"
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
desc: "Setter for force update boolean"
hasDeprecatedTag: true
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.setLabels(java.util.HashMap<java.lang.String,java.lang.String>)"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.setLabels(HashMap<String,String> labels)"
name: "setLabels(HashMap<String,String> labels)"
nameWithType: "Configuration.setLabels(HashMap<String,String> labels)"
summary: "Setter for the labels of the configuration"
parameters:
- description: "labels to be set"
name: "labels"
type: "<xref href=\"java.util.HashMap?alt=java.util.HashMap&text=HashMap\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public void setLabels(HashMap<String,String> labels)"
desc: "Setter for the labels of the configuration"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.setMetrics(com.microsoft.azure.sdk.iot.service.ConfigurationMetrics)"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.setMetrics(ConfigurationMetrics metrics)"
name: "setMetrics(ConfigurationMetrics metrics)"
nameWithType: "Configuration.setMetrics(ConfigurationMetrics metrics)"
summary: "Set the configuration metrics of this object"
parameters:
- description: "the metrics to set"
name: "metrics"
type: "<xref href=\"com.microsoft.azure.sdk.iot.service.ConfigurationMetrics?alt=com.microsoft.azure.sdk.iot.service.ConfigurationMetrics&text=ConfigurationMetrics\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setMetrics(ConfigurationMetrics metrics)"
desc: "Set the configuration metrics of this object"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.setPriority(java.lang.Integer)"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.setPriority(Integer priority)"
name: "setPriority(Integer priority)"
nameWithType: "Configuration.setPriority(Integer priority)"
summary: "Setter for the configuration priority"
parameters:
- description: "to be set"
name: "priority"
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setPriority(Integer priority)"
desc: "Setter for the configuration priority"
- uid: "com.microsoft.azure.sdk.iot.service.Configuration.setTargetCondition(java.lang.String)"
fullName: "com.microsoft.azure.sdk.iot.service.Configuration.setTargetCondition(String targetCondition)"
name: "setTargetCondition(String targetCondition)"
nameWithType: "Configuration.setTargetCondition(String targetCondition)"
summary: "Setter for the target<wbr>Condition"
parameters:
- description: "targetCondition to be set"
name: "targetCondition"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public void setTargetCondition(String targetCondition)"
desc: "Setter for the targetCondition"
type: "class"
metadata: {}
package: "com.microsoft.azure.sdk.iot.service"
artifact: com.microsoft.azure.sdk.iot:iot-service-client:1.30.0