Class: Twilio::REST::Bulkexports::V1::ExportContext::ExportCustomJobInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Bulkexports::V1::ExportContext::ExportCustomJobInstance
- Defined in:
- lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
Instance Method Summary collapse
-
#details ⇒ Hash
The details of a job state which is an object that contains a `status` string, a day count integer, and list of days in the job.
-
#email ⇒ String
The optional email to send the completion notification to.
-
#end_day ⇒ String
The end day for the custom export specified as a string in the format of yyyy-MM-dd.
-
#estimated_completion_time ⇒ String
This is the time estimated until your job is complete.
-
#friendly_name ⇒ String
The friendly name specified when creating the job.
-
#initialize(version, payload, resource_type: nil) ⇒ ExportCustomJobInstance
constructor
Initialize the ExportCustomJobInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#job_queue_position ⇒ String
This is the job position from the 1st in line.
-
#job_sid ⇒ String
The unique job_sid returned when the custom export was created.
-
#resource_type ⇒ String
The type of communication – Messages, Calls, Conferences, and Participants.
-
#start_day ⇒ String
The start day for the custom export specified as a string in the format of yyyy-MM-dd.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#webhook_method ⇒ String
This is the method used to call the webhook.
-
#webhook_url ⇒ String
The optional webhook url called on completion.
Constructor Details
#initialize(version, payload, resource_type: nil) ⇒ ExportCustomJobInstance
Initialize the ExportCustomJobInstance
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 185 def initialize(version, payload, resource_type: nil) super(version) # Marshaled Properties @properties = { 'friendly_name' => payload['friendly_name'], 'resource_type' => payload['resource_type'], 'start_day' => payload['start_day'], 'end_day' => payload['end_day'], 'webhook_url' => payload['webhook_url'], 'webhook_method' => payload['webhook_method'], 'email' => payload['email'], 'job_sid' => payload['job_sid'], 'details' => payload['details'], 'job_queue_position' => payload['job_queue_position'], 'estimated_completion_time' => payload['estimated_completion_time'], } end |
Instance Method Details
#details ⇒ Hash
Returns The details of a job state which is an object that contains a `status` string, a day count integer, and list of days in the job.
254 255 256 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 254 def details @properties['details'] end |
#email ⇒ String
Returns The optional email to send the completion notification to.
242 243 244 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 242 def email @properties['email'] end |
#end_day ⇒ String
Returns The end day for the custom export specified as a string in the format of yyyy-MM-dd. This will be the last day exported. For instance, to export a single day, choose the same day for start and end day. To export the first 4 days of July, you would set the start date to 2020-07-01 and the end date to 2020-07-04. The end date must be the UTC day before yesterday.
224 225 226 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 224 def end_day @properties['end_day'] end |
#estimated_completion_time ⇒ String
Returns this is the time estimated until your job is complete. This is calculated each time you request the job list. The time is calculated based on the current rate of job completion (which may vary) and your job queue position.
266 267 268 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 266 def estimated_completion_time @properties['estimated_completion_time'] end |
#friendly_name ⇒ String
Returns The friendly name specified when creating the job.
206 207 208 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 206 def friendly_name @properties['friendly_name'] end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
278 279 280 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 278 def inspect "<Twilio.Bulkexports.V1.ExportCustomJobInstance>" end |
#job_queue_position ⇒ String
Returns This is the job position from the 1st in line. Your queue position will never increase. As jobs ahead of yours in the queue are processed, the queue position number will decrease.
260 261 262 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 260 def job_queue_position @properties['job_queue_position'] end |
#job_sid ⇒ String
Returns The unique job_sid returned when the custom export was created. This can be used to look up the status of the job.
248 249 250 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 248 def job_sid @properties['job_sid'] end |
#resource_type ⇒ String
Returns The type of communication – Messages, Calls, Conferences, and Participants.
212 213 214 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 212 def resource_type @properties['resource_type'] end |
#start_day ⇒ String
Returns The start day for the custom export specified as a string in the format of yyyy-MM-dd.
218 219 220 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 218 def start_day @properties['start_day'] end |
#to_s ⇒ Object
Provide a user friendly representation
272 273 274 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 272 def to_s "<Twilio.Bulkexports.V1.ExportCustomJobInstance>" end |
#webhook_method ⇒ String
Returns This is the method used to call the webhook.
236 237 238 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 236 def webhook_method @properties['webhook_method'] end |
#webhook_url ⇒ String
Returns The optional webhook url called on completion.
230 231 232 |
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb', line 230 def webhook_url @properties['webhook_url'] end |