Class: Azure::DataBox::Mgmt::V2018_01_01::Models::JobResource

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-01-01/generated/azure_mgmt_databox/models/job_resource.rb

Overview

Job Resource.

Instance Attribute Summary collapse

Attributes inherited from Resource

#location, #sku, #tags

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#cancellation_reason ⇒ String

Returns Reason for cancellation.

Returns:

  • (String) —

    Reason for cancellation.



44
45
46
 
# File 'lib/2018-01-01/generated/azure_mgmt_databox/models/job_resource.rb', line 44

def cancellation_reason
  @cancellation_reason
end

#details ⇒ JobDetails

for expand details filter.

Returns:

  • (JobDetails) —

    Details of a job run. This field will only be sent



41
42
43
 
# File 'lib/2018-01-01/generated/azure_mgmt_databox/models/job_resource.rb', line 41

def details
  @details
end

#error ⇒ Error

Returns Top level error for the job.

Returns:

  • (Error) —

    Top level error for the job.



37
38
39
 
# File 'lib/2018-01-01/generated/azure_mgmt_databox/models/job_resource.rb', line 37

def error
  @error
end

#id ⇒ String

Returns Id of the object.

Returns:

  • (String) —

    Id of the object.



50
51
52
 
# File 'lib/2018-01-01/generated/azure_mgmt_databox/models/job_resource.rb', line 50

def id
  @id
end

#is_cancellable ⇒ Boolean

Returns Describes whether the job is cancellable or not.

Returns:

  • (Boolean) —

    Describes whether the job is cancellable or not.



16
17
18
 
# File 'lib/2018-01-01/generated/azure_mgmt_databox/models/job_resource.rb', line 16

def is_cancellable
  @is_cancellable
end

#is_deletable ⇒ Boolean

Returns Describes whether the job is deletable or not.

Returns:

  • (Boolean) —

    Describes whether the job is deletable or not.



19
20
21
 
# File 'lib/2018-01-01/generated/azure_mgmt_databox/models/job_resource.rb', line 19

def is_deletable
  @is_deletable
end

#is_shipping_address_editable ⇒ Boolean

not.

Returns:

  • (Boolean) —

    Describes whether the shipping address is editable or



23
24
25
 
# File 'lib/2018-01-01/generated/azure_mgmt_databox/models/job_resource.rb', line 23

def is_shipping_address_editable
  @is_shipping_address_editable
end

#name ⇒ String

Returns Name of the object.

Returns:

  • (String) —

    Name of the object.



47
48
49
 
# File 'lib/2018-01-01/generated/azure_mgmt_databox/models/job_resource.rb', line 47

def name
  @name
end

#start_time ⇒ DateTime

format.

Returns:

  • (DateTime) —

    Time at which the job was started in UTC ISO 8601



34
35
36
 
# File 'lib/2018-01-01/generated/azure_mgmt_databox/models/job_resource.rb', line 34

def start_time
  @start_time
end

#status ⇒ StageName

values include: ‘DeviceOrdered’, ‘DevicePrepared’, ‘Dispatched’, ‘Delivered’, ‘PickedUp’, ‘AtAzureDC’, ‘DataCopy’, ‘Completed’, ‘CompletedWithErrors’, ‘Cancelled’, ‘Failed_IssueReportedAtCustomer’, ‘Failed_IssueDetectedAtAzureDC’, ‘Aborted’

Returns:

  • (StageName) —

    Name of the stage which is in progress. Possible



30
31
32
 
# File 'lib/2018-01-01/generated/azure_mgmt_databox/models/job_resource.rb', line 30

def status
  @status
end

#type ⇒ String

Returns Type of the object.

Returns:

  • (String) —

    Type of the object.



53
54
55
 
# File 'lib/2018-01-01/generated/azure_mgmt_databox/models/job_resource.rb', line 53

def type
  @type
end

Class Method Details

.mapper ⇒ Object

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



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
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
 
# File 'lib/2018-01-01/generated/azure_mgmt_databox/models/job_resource.rb', line 60

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'JobResource',
    type: {
      name: 'Composite',
      class_name: 'JobResource',
      model_properties: {
        location: {
          client_side_validation: true,
          required: true,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        sku: {
          client_side_validation: true,
          required: true,
          serialized_name: 'sku',
          type: {
            name: 'Composite',
            class_name: 'Sku'
          }
        },
        is_cancellable: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.isCancellable',
          type: {
            name: 'Boolean'
          }
        },
        is_deletable: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.isDeletable',
          type: {
            name: 'Boolean'
          }
        },
        is_shipping_address_editable: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.isShippingAddressEditable',
          type: {
            name: 'Boolean'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.status',
          type: {
            name: 'Enum',
            module: 'StageName'
          }
        },
        start_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.startTime',
          type: {
            name: 'DateTime'
          }
        },
        error: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.error',
          type: {
            name: 'Composite',
            class_name: 'Error'
          }
        },
        details: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.details',
          type: {
            name: 'Composite',
            polymorphic_discriminator: 'jobDetailsType',
            uber_parent: 'JobDetails',
            class_name: 'JobDetails'
          }
        },
        cancellation_reason: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.cancellationReason',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end