Class: Azure::DataBoxEdge::Mgmt::V2019_08_01::Models::Job

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb

Overview

A device job.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#current_stage ⇒ UpdateOperationStage

Possible values include: ‘Unknown’, ‘Initial’, ‘ScanStarted’, ‘ScanComplete’, ‘ScanFailed’, ‘DownloadStarted’, ‘DownloadComplete’, ‘DownloadFailed’, ‘InstallStarted’, ‘InstallComplete’, ‘InstallFailed’, ‘RebootInitiated’, ‘Success’, ‘Failure’, ‘RescanStarted’, ‘RescanComplete’, ‘RescanFailed’

Returns:



52
53
54
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 52

def current_stage
  @current_stage
end

#download_progress ⇒ UpdateDownloadProgress

Returns The download progress.

Returns:



55
56
57
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 55

def download_progress
  @download_progress
end

#end_time ⇒ DateTime

Returns The UTC date and time at which the job completed.

Returns:

  • (DateTime) —

    The UTC date and time at which the job completed.



33
34
35
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 33

def end_time
  @end_time
end

#error ⇒ JobErrorDetails

Returns The error details.

Returns:



39
40
41
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 39

def error
  @error
end

#error_manifest_file ⇒ String

error manifest file of the refresh.

Returns:

  • (String) —

    Local share/remote container relative path to the



66
67
68
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 66

def error_manifest_file
  @error_manifest_file
end

#folder ⇒ String

subfolder path inside the share or container. (The path is empty if there are no subfolders.)

Returns:

  • (String) —

    If only subfolders need to be refreshed, then the



74
75
76
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 74

def folder
  @folder
end

#id ⇒ String

Returns The path ID that uniquely identifies the object.

Returns:

  • (String) —

    The path ID that uniquely identifies the object.



16
17
18
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 16

def id
  @id
end

#install_progress ⇒ UpdateInstallProgress

Returns The install progress.

Returns:



58
59
60
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 58

def install_progress
  @install_progress
end

#job_type ⇒ JobType

‘Invalid’, ‘ScanForUpdates’, ‘DownloadUpdates’, ‘InstallUpdates’, ‘RefreshShare’, ‘RefreshContainer’

Returns:

  • (JobType) —

    The type of the job. Possible values include:



44
45
46
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 44

def job_type
  @job_type
end

#name ⇒ String

Returns The name of the object.

Returns:

  • (String) —

    The name of the object.



19
20
21
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 19

def name
  @name
end

#percent_complete ⇒ Integer

Returns The percentage of the job that is complete.

Returns:

  • (Integer) —

    The percentage of the job that is complete.



36
37
38
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 36

def percent_complete
  @percent_complete
end

#refreshed_entity_id ⇒ String

Returns ARM ID of the entity that was refreshed.

Returns:

  • (String) —

    ARM ID of the entity that was refreshed.



69
70
71
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 69

def refreshed_entity_id
  @refreshed_entity_id
end

#start_time ⇒ DateTime

Returns The UTC date and time at which the job started.

Returns:

  • (DateTime) —

    The UTC date and time at which the job started.



30
31
32
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 30

def start_time
  @start_time
end

#status ⇒ JobStatus

include: ‘Invalid’, ‘Running’, ‘Succeeded’, ‘Failed’, ‘Canceled’, ‘Paused’, ‘Scheduled’

Returns:

  • (JobStatus) —

    The current status of the job. Possible values



27
28
29
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 27

def status
  @status
end

#total_refresh_errors ⇒ Integer

process.

Returns:

  • (Integer) —

    Total number of errors encountered during the refresh



62
63
64
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 62

def total_refresh_errors
  @total_refresh_errors
end

#type ⇒ String

Returns The hierarchical type of the object.

Returns:

  • (String) —

    The hierarchical type of the object.



22
23
24
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 22

def type
  @type
end

Class Method Details

.mapper ⇒ Object

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



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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/2019-08-01/generated/azure_mgmt_databoxedge/models/job.rb', line 81

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Job',
    type: {
      name: 'Composite',
      class_name: 'Job',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        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: 'String'
          }
        },
        start_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'startTime',
          type: {
            name: 'DateTime'
          }
        },
        end_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'endTime',
          type: {
            name: 'DateTime'
          }
        },
        percent_complete: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'percentComplete',
          type: {
            name: 'Number'
          }
        },
        error: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'error',
          type: {
            name: 'Composite',
            class_name: 'JobErrorDetails'
          }
        },
        job_type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.jobType',
          type: {
            name: 'String'
          }
        },
        current_stage: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.currentStage',
          type: {
            name: 'String'
          }
        },
        download_progress: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.downloadProgress',
          type: {
            name: 'Composite',
            class_name: 'UpdateDownloadProgress'
          }
        },
        install_progress: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.installProgress',
          type: {
            name: 'Composite',
            class_name: 'UpdateInstallProgress'
          }
        },
        total_refresh_errors: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.totalRefreshErrors',
          type: {
            name: 'Number'
          }
        },
        error_manifest_file: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.errorManifestFile',
          type: {
            name: 'String'
          }
        },
        refreshed_entity_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.refreshedEntityId',
          type: {
            name: 'String'
          }
        },
        folder: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.folder',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end