Class: Azure::MediaServices::Mgmt::V2018_07_01::Models::Job

Inherits:
ProxyResource show all
Includes:
MsRestAzure
Defined in:
lib/2018-07-01/generated/azure_mgmt_media_services/models/job.rb

Overview

A Job resource type. The progress and state can be obtained by polling a Job or subscribing to events using EventGrid.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #name, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#correlation_data ⇒ Hash{String => String}

that will be returned in Job and JobOutput state events.

Returns:

  • (Hash{String => String}) —

    Customer provided key, value pairs



46
47
48
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/job.rb', line 46

def correlation_data
  @correlation_data
end

#created ⇒ DateTime

‘YYYY-MM-DDThh:mm:ssZ’ format.

Returns:

  • (DateTime) —

    The UTC date and time when the Job was created, in



18
19
20
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/job.rb', line 18

def created
  @created
end

#description ⇒ String

Returns Optional customer supplied description of the Job.

Returns:

  • (String) —

    Optional customer supplied description of the Job.



26
27
28
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/job.rb', line 26

def description
  @description
end

#end_time ⇒ DateTime

processing.

Returns:

  • (DateTime) —

    The UTC date and time at which this Job finished



54
55
56
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/job.rb', line 54

def end_time
  @end_time
end

#input ⇒ JobInput

Returns The inputs for the Job.

Returns:

  • (JobInput) —

    The inputs for the Job.



29
30
31
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/job.rb', line 29

def input
  @input
end

#last_modified ⇒ DateTime

in ‘YYYY-MM-DDThh:mm:ssZ’ format.

Returns:

  • (DateTime) —

    The UTC date and time when the Job was last updated,



33
34
35
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/job.rb', line 33

def last_modified
  @last_modified
end

#outputs ⇒ Array<JobOutput>

Returns The outputs for the Job.

Returns:

  • (Array<JobOutput>) —

    The outputs for the Job.



36
37
38
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/job.rb', line 36

def outputs
  @outputs
end

#priority ⇒ Priority

Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. Possible values include: ‘Low’, ‘Normal’, ‘High’

Returns:

  • (Priority) —

    Priority with which the job should be processed.



42
43
44
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/job.rb', line 42

def priority
  @priority
end

#start_time ⇒ DateTime

processing.

Returns:

  • (DateTime) —

    The UTC date and time at which this Job began



50
51
52
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/job.rb', line 50

def start_time
  @start_time
end

#state ⇒ JobState

include: ‘Canceled’, ‘Canceling’, ‘Error’, ‘Finished’, ‘Processing’, ‘Queued’, ‘Scheduled’

Returns:

  • (JobState) —

    The current state of the job. Possible values



23
24
25
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/job.rb', line 23

def state
  @state
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2018-07-01/generated/azure_mgmt_media_services/models/job.rb', line 61

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'
          }
        },
        created: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.created',
          type: {
            name: 'DateTime'
          }
        },
        state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.state',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.description',
          type: {
            name: 'String'
          }
        },
        input: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.input',
          type: {
            name: 'Composite',
            polymorphic_discriminator: '@odata.type',
            uber_parent: 'JobInput',
            class_name: 'JobInput'
          }
        },
        last_modified: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastModified',
          type: {
            name: 'DateTime'
          }
        },
        outputs: {
          client_side_validation: true,
          required: true,
          serialized_name: 'properties.outputs',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'JobOutputElementType',
                type: {
                  name: 'Composite',
                  polymorphic_discriminator: '@odata.type',
                  uber_parent: 'JobOutput',
                  class_name: 'JobOutput'
                }
            }
          }
        },
        priority: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.priority',
          type: {
            name: 'String'
          }
        },
        correlation_data: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.correlationData',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        start_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.startTime',
          type: {
            name: 'DateTime'
          }
        },
        end_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.endTime',
          type: {
            name: 'DateTime'
          }
        }
      }
    }
  }
end