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.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 145

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



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

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



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

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.



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

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



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

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



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

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



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

def estimated_completion_time
    @properties['estimated_completion_time']
end

#fetch ⇒ JobInstance

Fetch the JobInstance

Returns:



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

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



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



277
278
279
280
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 277

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



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

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



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

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



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

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



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

def start_day
    @properties['start_day']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns:

  • (String) 


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

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



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

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



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

def webhook_url
    @properties['webhook_url']
end