class Azure::IotHub::Mgmt::V2018_04_01::Models::JobResponse

The properties of the Job Response object.

Attributes

end_time_utc[RW]

@return [DateTime] The time the job stopped processing.

failure_reason[RW]

@return [String] If status == failed, this string containing the reason for the failure.

job_id[RW]

@return [String] The job identifier.

parent_job_id[RW]

@return [String] The job identifier of the parent job, if any.

start_time_utc[RW]

@return [DateTime] The start time of the job.

status[RW]

@return [JobStatus] The status of the job. Possible values include: 'unknown', 'enqueued', 'running', 'completed', 'failed', 'cancelled'

status_message[RW]

@return [String] The status message for the job.

type[RW]

@return [JobType] The type of the job. Possible values include: 'unknown', 'export', 'import', 'backup', 'readDeviceProperties', 'writeDeviceProperties', 'updateDeviceConfiguration', 'rebootDevice', 'factoryResetDevice', 'firmwareUpdate'

Public Class Methods

mapper() click to toggle source

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

# File lib/2018-04-01/generated/azure_mgmt_iot_hub/models/job_response.rb, line 49
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'JobResponse',
    type: {
      name: 'Composite',
      class_name: 'JobResponse',
      model_properties: {
        job_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'jobId',
          type: {
            name: 'String'
          }
        },
        start_time_utc: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'startTimeUtc',
          type: {
            name: 'DateTimeRfc1123'
          }
        },
        end_time_utc: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'endTimeUtc',
          type: {
            name: 'DateTimeRfc1123'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'status',
          type: {
            name: 'Enum',
            module: 'JobStatus'
          }
        },
        failure_reason: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'failureReason',
          type: {
            name: 'String'
          }
        },
        status_message: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'statusMessage',
          type: {
            name: 'String'
          }
        },
        parent_job_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'parentJobId',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end