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

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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

  • job_sid (String) (defaults to: nil) —

    The unique string that that we created to identify the Bulk Export job



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 124

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) —

    JobContext for this JobInstance



152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 152

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



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

def delete
  context.delete
end

#details ⇒ Hash

Returns This is a list of the completed, pending, or errored dates within the export time range, with one entry for each status with more than one day in that status.

Returns:

  • (Hash) —

    This is a list of the completed, pending, or errored dates within the export time range, with one entry for each status with more than one day in that status



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

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



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

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



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

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



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

def estimated_completion_time
  @properties['estimated_completion_time']
end

#fetch ⇒ JobInstance

Fetch the JobInstance

Returns:



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

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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

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



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

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



161
162
163
 
# File 'lib/twilio-ruby/rest/bulkexports/v1/export/job.rb', line 161

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



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

def start_day
  @properties['start_day']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

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



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

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



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

def webhook_url
  @properties['webhook_url']
end