Class: Azure::ARM::IotHub::Models::JobResponse

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_iot_hub/models/job_response.rb

Overview

The properties describing a Job Response.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#device_id ⇒ String

Returns The deviceId related to this response.

Returns:

  • (String) —

    The deviceId related to this response.



42
43
44
 
# File 'lib/generated/azure_mgmt_iot_hub/models/job_response.rb', line 42

def device_id
  @device_id
end

#end_time_utc ⇒ DateTime

Returns Represents the time the job stopped processing.

Returns:

  • (DateTime) —

    Represents the time the job stopped processing.



22
23
24
 
# File 'lib/generated/azure_mgmt_iot_hub/models/job_response.rb', line 22

def end_time_utc
  @end_time_utc
end

#failure_reason ⇒ String

containing the reason.

Returns:

  • (String) —

    If status == failure, this represents a string



36
37
38
 
# File 'lib/generated/azure_mgmt_iot_hub/models/job_response.rb', line 36

def failure_reason
  @failure_reason
end

#job_id ⇒ String

Returns The job identifier.

Returns:

  • (String) —

    The job identifier.



16
17
18
 
# File 'lib/generated/azure_mgmt_iot_hub/models/job_response.rb', line 16

def job_id
  @job_id
end

#parent_job_id ⇒ String

Returns The jobId of the parent job, if any.

Returns:

  • (String) —

    The jobId of the parent job, if any.



45
46
47
 
# File 'lib/generated/azure_mgmt_iot_hub/models/job_response.rb', line 45

def parent_job_id
  @parent_job_id
end

#start_time_utc ⇒ DateTime

Returns Start time of the Job.

Returns:

  • (DateTime) —

    Start time of the Job.



19
20
21
 
# File 'lib/generated/azure_mgmt_iot_hub/models/job_response.rb', line 19

def start_time_utc
  @start_time_utc
end

#status ⇒ JobStatus

‘unknown’, ‘enqueued’, ‘running’, ‘completed’, ‘failed’, ‘cancelled’

Returns:

  • (JobStatus) —

    Status of the Job. Possible values include:



32
33
34
 
# File 'lib/generated/azure_mgmt_iot_hub/models/job_response.rb', line 32

def status
  @status
end

#status_message ⇒ String

Returns The status message for the job.

Returns:

  • (String) —

    The status message for the job.



39
40
41
 
# File 'lib/generated/azure_mgmt_iot_hub/models/job_response.rb', line 39

def status_message
  @status_message
end

#type ⇒ JobType

‘unknown’, ‘export’, ‘import’, ‘backup’, ‘readDeviceProperties’, ‘writeDeviceProperties’, ‘updateDeviceConfiguration’, ‘rebootDevice’, ‘factoryResetDevice’, ‘firmwareUpdate’

Returns:

  • (JobType) —

    The type of job to execute. Possible values include:



28
29
30
 
# File 'lib/generated/azure_mgmt_iot_hub/models/job_response.rb', line 28

def type
  @type
end

Class Method Details

.mapper ⇒ Object

Mapper for JobResponse class as Ruby Hash. This will be used for serialization/deserialization.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/generated/azure_mgmt_iot_hub/models/job_response.rb', line 52

def self.mapper()
  {
    required: false,
    serialized_name: 'JobResponse',
    type: {
      name: 'Composite',
      class_name: 'JobResponse',
      model_properties: {
        job_id: {
          required: false,
          serialized_name: 'jobId',
          type: {
            name: 'String'
          }
        },
        start_time_utc: {
          required: false,
          serialized_name: 'startTimeUtc',
          type: {
            name: 'DateTime'
          }
        },
        end_time_utc: {
          required: false,
          serialized_name: 'endTimeUtc',
          type: {
            name: 'DateTime'
          }
        },
        type: {
          required: false,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        status: {
          required: false,
          serialized_name: 'status',
          type: {
            name: 'Enum',
            module: 'JobStatus'
          }
        },
        failure_reason: {
          required: false,
          serialized_name: 'failureReason',
          type: {
            name: 'String'
          }
        },
        status_message: {
          required: false,
          serialized_name: 'statusMessage',
          type: {
            name: 'String'
          }
        },
        device_id: {
          required: false,
          serialized_name: 'deviceId',
          type: {
            name: 'String'
          }
        },
        parent_job_id: {
          required: false,
          serialized_name: 'parentJobId',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end