Class: Twilio::REST::Bulkexports::V1::ExportList::JobInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/bulkexports/v1/export/job.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, job_sid: nil) ⇒ JobInstance

Initialize the JobInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Job resource.

  • sid (String) —

    The SID of the Call resource to fetch.



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 137

def initialize(version, payload , job_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'resource_type' => payload['resource_type'],
        'friendly_name' => payload['friendly_name'],
        'details' => payload['details'],
        'start_day' => payload['start_day'],
        'end_day' => payload['end_day'],
        'job_sid' => payload['job_sid'],
        'webhook_url' => payload['webhook_url'],
        'webhook_method' => payload['webhook_method'],
        'email' => payload['email'],
        'url' => payload['url'],
        'job_queue_position' => payload['job_queue_position'],
        'estimated_completion_time' => payload['estimated_completion_time'],
    }

    # Context
    @instance_context = nil
    @params = { 'job_sid' => job_sid  || @properties['job_sid']  , }
end

Instance Method Details

#context ⇒ JobContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:

  • (JobContext) —

    CallContext for this CallInstance



165
166
167
168
169
170
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 165

def context
    unless @instance_context
        @instance_context = JobContext.new(@version , @params['job_sid'])
    end
    @instance_context
end

#delete ⇒ Boolean

Delete the JobInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



247
248
249
250
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 247

def delete

    context.delete
end

#details ⇒ Hash

Returns The details of a job which is an object that contains an array of status grouped by ‘status` state. Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days.

Returns:

  • (Hash) —

    The details of a job which is an object that contains an array of status grouped by ‘status` state. Each `status` object has a `status` string, a count which is the number of days in that `status`, and list of days in that `status`. The day strings are in the format yyyy-MM-dd. As an example, a currently running job may have a status object for COMPLETED and a `status` object for SUBMITTED each with its own count and list of days.



186
187
188
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 186

def details
    @properties['details']
end

#email ⇒ String

Returns The optional email to send the completion notification to.

Returns:

  • (String) —

    The optional email to send the completion notification to



222
223
224
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 222

def email
    @properties['email']
end

#end_day ⇒ String

Returns The end time for the export specified when creating the job.

Returns:

  • (String) —

    The end time for the export specified when creating the job



198
199
200
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 198

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.

Returns:

  • (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



240
241
242
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 240

def estimated_completion_time
    @properties['estimated_completion_time']
end

#fetch ⇒ JobInstance

Fetch the JobInstance

Returns:



255
256
257
258
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 255

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The friendly name specified when creating the job.

Returns:

  • (String) —

    The friendly name specified when creating the job



180
181
182
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 180

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



269
270
271
272
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 269

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Bulkexports.V1.JobInstance #{values}>"
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.

Returns:

  • (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



234
235
236
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 234

def job_queue_position
    @properties['job_queue_position']
end

#job_sid ⇒ String

Returns The job_sid returned when the export was created.

Returns:

  • (String) —

    The job_sid returned when the export was created



204
205
206
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 204

def job_sid
    @properties['job_sid']
end

#resource_type ⇒ String

Returns The type of communication – Messages, Calls, Conferences, and Participants.

Returns:

  • (String) —

    The type of communication – Messages, Calls, Conferences, and Participants



174
175
176
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 174

def resource_type
    @properties['resource_type']
end

#start_day ⇒ String

Returns The start time for the export specified when creating the job.

Returns:

  • (String) —

    The start time for the export specified when creating the job



192
193
194
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 192

def start_day
    @properties['start_day']
end

#to_s ⇒ Object

Provide a user friendly representation



262
263
264
265
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 262

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Bulkexports.V1.JobInstance #{values}>"
end

#url ⇒ String

Returns:

  • (String) 


228
229
230
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 228

def url
    @properties['url']
end

#webhook_method ⇒ String

Returns This is the method used to call the webhook.

Returns:

  • (String) —

    This is the method used to call the webhook



216
217
218
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 216

def webhook_method
    @properties['webhook_method']
end

#webhook_url ⇒ String

Returns The optional webhook url called on completion.

Returns:

  • (String) —

    The optional webhook url called on completion



210
211
212
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 210

def webhook_url
    @properties['webhook_url']
end