249 строки
16 KiB
YAML
249 строки
16 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser"
|
|
name: "JobsResponseParser"
|
|
nameWithType: "JobsResponseParser"
|
|
summary: "Representation of a single Jobs response collection with a Json deserializer."
|
|
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 **JobsResponseParser**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.JobsResponseParser()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.JobsResponseParser()"
|
|
name: "JobsResponseParser()"
|
|
nameWithType: "JobsResponseParser.JobsResponseParser()"
|
|
syntax: "public JobsResponseParser()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.createFromJson(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.createFromJson(String json)"
|
|
name: "createFromJson(String json)"
|
|
nameWithType: "JobsResponseParser.createFromJson(String json)"
|
|
summary: "Static constructor to create a instance based on the provided json"
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "is the string with the json to parse"
|
|
name: "json"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static JobsResponseParser createFromJson(String json)"
|
|
exceptions:
|
|
- description: "if the json is <code>null</code> or empty, or if any date is invalid"
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "if the json is <code>null</code> or empty, or if any date is invalid"
|
|
type: "<xref href=\"com.google.gson.JsonParseException?alt=com.google.gson.JsonParseException&text=JsonParseException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Static constructor to create a instance based on the provided json"
|
|
returns:
|
|
description: "an instance of the JobsResponseParser"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser?alt=com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser&text=JobsResponseParser\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getCloudToDeviceMethod()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getCloudToDeviceMethod()"
|
|
name: "getCloudToDeviceMethod()"
|
|
nameWithType: "JobsResponseParser.getCloudToDeviceMethod()"
|
|
summary: "Getter for cloud to device method json"
|
|
syntax: "public MethodParser getCloudToDeviceMethod()"
|
|
desc: "Getter for cloud to device method json"
|
|
returns:
|
|
description: "the json of cloud to device method. It is <code>null</code> if type\n is not scheduleDeviceMethod"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.serializer.MethodParser?alt=com.microsoft.azure.sdk.iot.deps.serializer.MethodParser&text=MethodParser\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getCreatedTime()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getCreatedTime()"
|
|
name: "getCreatedTime()"
|
|
nameWithType: "JobsResponseParser.getCreatedTime()"
|
|
summary: "Getter for created time"
|
|
syntax: "public Date getCreatedTime()"
|
|
desc: "Getter for created time"
|
|
returns:
|
|
description: "the scheduled job start time in UTC. It can be <code>null</code>"
|
|
type: "<xref href=\"java.util.Date?alt=java.util.Date&text=Date\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getDeviceId()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getDeviceId()"
|
|
name: "getDeviceId()"
|
|
nameWithType: "JobsResponseParser.getDeviceId()"
|
|
summary: "Getter for the device Id"
|
|
syntax: "public String getDeviceId()"
|
|
desc: "Getter for the device Id"
|
|
returns:
|
|
description: "the deviceId related to this response. It can be <code>null</code>\n (e.g. in case of a parent orchestration)"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getEndTime()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getEndTime()"
|
|
name: "getEndTime()"
|
|
nameWithType: "JobsResponseParser.getEndTime()"
|
|
summary: "Getter for the end time UTC Represents the time the job stopped processing"
|
|
syntax: "public Date getEndTime()"
|
|
desc: "Getter for the end time UTC Represents the time the job stopped processing"
|
|
returns:
|
|
description: "the system generated end time in UTC. It can be <code>null</code>"
|
|
type: "<xref href=\"java.util.Date?alt=java.util.Date&text=Date\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getError()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getError()"
|
|
name: "getError()"
|
|
nameWithType: "JobsResponseParser.getError()"
|
|
summary: "Returns the error as json"
|
|
syntax: "public JobQueryResponseError getError()"
|
|
desc: "Returns the error as json"
|
|
returns:
|
|
description: "the json error returned by IotHub"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.serializer.JobQueryResponseError?alt=com.microsoft.azure.sdk.iot.deps.serializer.JobQueryResponseError&text=JobQueryResponseError\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getFailureReason()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getFailureReason()"
|
|
name: "getFailureReason()"
|
|
nameWithType: "JobsResponseParser.getFailureReason()"
|
|
summary: "Getter for failure reason"
|
|
syntax: "public String getFailureReason()"
|
|
desc: "Getter for failure reason"
|
|
returns:
|
|
description: "If status == failure, this represents a string containing the\n reason. It can be <code>null</code>"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getJobId()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getJobId()"
|
|
name: "getJobId()"
|
|
nameWithType: "JobsResponseParser.getJobId()"
|
|
summary: "Getter for the Job identifier"
|
|
syntax: "public String getJobId()"
|
|
desc: "Getter for the Job identifier"
|
|
returns:
|
|
description: "Job identifier"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getJobStatistics()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getJobStatistics()"
|
|
name: "getJobStatistics()"
|
|
nameWithType: "JobsResponseParser.getJobStatistics()"
|
|
summary: "Getter for jobs statistics"
|
|
syntax: "public JobsStatisticsParser getJobStatistics()"
|
|
desc: "Getter for jobs statistics"
|
|
returns:
|
|
description: "a set of counters with the jobs statistics. It can be <code>null</code>"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.serializer.JobsStatisticsParser?alt=com.microsoft.azure.sdk.iot.deps.serializer.JobsStatisticsParser&text=JobsStatisticsParser\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getJobsStatus()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getJobsStatus()"
|
|
name: "getJobsStatus()"
|
|
nameWithType: "JobsResponseParser.getJobsStatus()"
|
|
summary: "Getter for the jobs status"
|
|
syntax: "public String getJobsStatus()"
|
|
desc: "Getter for the jobs status"
|
|
returns:
|
|
description: "the status of this job"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getLastUpdatedTimeDate()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getLastUpdatedTimeDate()"
|
|
name: "getLastUpdatedTimeDate()"
|
|
nameWithType: "JobsResponseParser.getLastUpdatedTimeDate()"
|
|
summary: "Getter for last updated time in UTC"
|
|
syntax: "public Date getLastUpdatedTimeDate()"
|
|
desc: "Getter for last updated time in UTC"
|
|
returns:
|
|
description: "System generated last updated time in UTC. Can be <code>null</code>"
|
|
type: "<xref href=\"java.util.Date?alt=java.util.Date&text=Date\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getMaxExecutionTimeInSeconds()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getMaxExecutionTimeInSeconds()"
|
|
name: "getMaxExecutionTimeInSeconds()"
|
|
nameWithType: "JobsResponseParser.getMaxExecutionTimeInSeconds()"
|
|
summary: "Getter for max execution time in seconds"
|
|
syntax: "public Long getMaxExecutionTimeInSeconds()"
|
|
desc: "Getter for max execution time in seconds"
|
|
returns:
|
|
description: "the max execution time in seconds (ttl duration). It can be <code>null</code>"
|
|
type: "<xref href=\"java.lang.Long?alt=java.lang.Long&text=Long\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getOutcome()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getOutcome()"
|
|
name: "getOutcome()"
|
|
nameWithType: "JobsResponseParser.getOutcome()"
|
|
summary: "Getter for the outcome of device method"
|
|
syntax: "public MethodParser getOutcome()"
|
|
desc: "Getter for the outcome of device method"
|
|
returns:
|
|
description: "the outcome in json for device method when querying device method job"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.serializer.MethodParser?alt=com.microsoft.azure.sdk.iot.deps.serializer.MethodParser&text=MethodParser\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getParentJobId()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getParentJobId()"
|
|
name: "getParentJobId()"
|
|
nameWithType: "JobsResponseParser.getParentJobId()"
|
|
summary: "Getter for the parent job<wbr>Id"
|
|
syntax: "public String getParentJobId()"
|
|
desc: "Getter for the parent jobId"
|
|
returns:
|
|
description: "the jobId of the parent orchestration, if any. It can be <code>null</code>"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getQueryCondition()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getQueryCondition()"
|
|
name: "getQueryCondition()"
|
|
nameWithType: "JobsResponseParser.getQueryCondition()"
|
|
summary: "Getter for query condition"
|
|
syntax: "public String getQueryCondition()"
|
|
desc: "Getter for query condition"
|
|
returns:
|
|
description: "the condition for device query to get devices to execute the\n job on. It can be <code>null</code>"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getStartTime()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getStartTime()"
|
|
name: "getStartTime()"
|
|
nameWithType: "JobsResponseParser.getStartTime()"
|
|
summary: "Getter for start time UTC"
|
|
syntax: "public Date getStartTime()"
|
|
desc: "Getter for start time UTC"
|
|
returns:
|
|
description: "the system generated start time in UTC. It can be <code>null</code>"
|
|
type: "<xref href=\"java.util.Date?alt=java.util.Date&text=Date\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getStatusMessage()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getStatusMessage()"
|
|
name: "getStatusMessage()"
|
|
nameWithType: "JobsResponseParser.getStatusMessage()"
|
|
summary: "Getter for the status message"
|
|
syntax: "public String getStatusMessage()"
|
|
desc: "Getter for the status message"
|
|
returns:
|
|
description: "a string containing a message with status about the job\n execution. It can be <code>null</code>"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getType()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getType()"
|
|
name: "getType()"
|
|
nameWithType: "JobsResponseParser.getType()"
|
|
summary: "Getter for the job type"
|
|
syntax: "public String getType()"
|
|
desc: "Getter for the job type"
|
|
returns:
|
|
description: "the type of job to execute"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getUpdateTwin()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getUpdateTwin()"
|
|
name: "getUpdateTwin()"
|
|
nameWithType: "JobsResponseParser.getUpdateTwin()"
|
|
summary: "Getter for update twin json"
|
|
deprecatedTag: "As of release 0.4.0, replaced by <xref uid=\"com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getUpdateTwinState()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getUpdateTwinState()\"></xref>"
|
|
syntax: "</br>public TwinParser getUpdateTwin()"
|
|
desc: "Getter for update twin json"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the json of update twin. It is <code>null</code> if type\n is not scheduleUpdateTwin"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.serializer.TwinParser?alt=com.microsoft.azure.sdk.iot.deps.serializer.TwinParser&text=TwinParser\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getUpdateTwinState()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.JobsResponseParser.getUpdateTwinState()"
|
|
name: "getUpdateTwinState()"
|
|
nameWithType: "JobsResponseParser.getUpdateTwinState()"
|
|
summary: "Getter for update twin json"
|
|
syntax: "public TwinState getUpdateTwinState()"
|
|
desc: "Getter for update twin json"
|
|
returns:
|
|
description: "the json of update twin. It is <code>null</code> if type\n is not scheduleUpdateTwin"
|
|
type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.twin.TwinState?alt=com.microsoft.azure.sdk.iot.deps.twin.TwinState&text=TwinState\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Representation of a single Jobs response collection with a Json deserializer."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.deps.serializer"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-deps:0.12.0
|