class Twilio::REST::Bulkexports::V1::ExportContext::ExportCustomJobInstance

Public Class Methods

new(version, payload, resource_type: nil) click to toggle source

Initialize the ExportCustomJobInstance @param [Version] version Version that contains the resource @param [Hash] payload payload that contains response from Twilio @param [String] resource_type The type of communication – Messages, Calls,

Conferences, and Participants

@return [ExportCustomJobInstance] ExportCustomJobInstance

Calls superclass method Twilio::REST::InstanceResource::new
    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
185 def initialize(version, payload, resource_type: nil)
186   super(version)
187 
188   # Marshaled Properties
189   @properties = {
190       'friendly_name' => payload['friendly_name'],
191       'resource_type' => payload['resource_type'],
192       'start_day' => payload['start_day'],
193       'end_day' => payload['end_day'],
194       'webhook_url' => payload['webhook_url'],
195       'webhook_method' => payload['webhook_method'],
196       'email' => payload['email'],
197       'job_sid' => payload['job_sid'],
198       'details' => payload['details'],
199       'job_queue_position' => payload['job_queue_position'],
200       'estimated_completion_time' => payload['estimated_completion_time'],
201   }
202 end

Public Instance Methods

details() click to toggle source

@return [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

    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
254 def details
255   @properties['details']
256 end
email() click to toggle source

@return [String] The optional email to send the completion notification to

    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
242 def email
243   @properties['email']
244 end
end_day() click to toggle source

@return [String] 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.

    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
224 def end_day
225   @properties['end_day']
226 end
estimated_completion_time() click to toggle source

@return [String] 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

    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
266 def estimated_completion_time
267   @properties['estimated_completion_time']
268 end
friendly_name() click to toggle source

@return [String] The friendly name specified when creating the job

    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
206 def friendly_name
207   @properties['friendly_name']
208 end
inspect() click to toggle source

Provide a detailed, user friendly representation

    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
278 def inspect
279   "<Twilio.Bulkexports.V1.ExportCustomJobInstance>"
280 end
job_queue_position() click to toggle source

@return [String] 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

    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
260 def job_queue_position
261   @properties['job_queue_position']
262 end
job_sid() click to toggle source

@return [String] The unique job_sid returned when the custom export was created. This can be used to look up the status of the job.

    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
248 def job_sid
249   @properties['job_sid']
250 end
resource_type() click to toggle source

@return [String] The type of communication – Messages, Calls, Conferences, and Participants

    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
212 def resource_type
213   @properties['resource_type']
214 end
start_day() click to toggle source

@return [String] The start day for the custom export specified as a string in the format of yyyy-MM-dd

    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
218 def start_day
219   @properties['start_day']
220 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
272 def to_s
273   "<Twilio.Bulkexports.V1.ExportCustomJobInstance>"
274 end
webhook_method() click to toggle source

@return [String] This is the method used to call the webhook

    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
236 def webhook_method
237   @properties['webhook_method']
238 end
webhook_url() click to toggle source

@return [String] The optional webhook url called on completion

    # File lib/twilio-ruby/rest/bulkexports/v1/export/export_custom_job.rb
230 def webhook_url
231   @properties['webhook_url']
232 end