Class: Twilio::REST::Preview::Understand::AssistantContext::ModelBuildInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected]

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, assistant_sid: nil, sid: nil) ⇒ ModelBuildInstance

Initialize the ModelBuildInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • assistant_sid (String) (defaults to: nil)

    The unique ID of the parent Assistant.

  • sid (String) (defaults to: nil)

    The sid


245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 245

def initialize(version, payload, assistant_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'assistant_sid' => payload['assistant_sid'],
      'sid' => payload['sid'],
      'status' => payload['status'],
      'unique_name' => payload['unique_name'],
      'url' => payload['url'],
      'build_duration' => payload['build_duration'] == nil ? payload['build_duration'] : payload['build_duration'].to_i,
      'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
  }

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

Instance Method Details

#account_sidString

Returns The unique ID of the Account that created this Model Build.

Returns:

  • (String)

    The unique ID of the Account that created this Model Build.


280
281
282
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 280

def 
  @properties['account_sid']
end

#assistant_sidString

Returns The unique ID of the parent Assistant.

Returns:

  • (String)

    The unique ID of the parent Assistant.


298
299
300
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 298

def assistant_sid
  @properties['assistant_sid']
end

#build_durationString

Returns The time in seconds it took to build the model.

Returns:

  • (String)

    The time in seconds it took to build the model.


328
329
330
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 328

def build_duration
  @properties['build_duration']
end

#contextModelBuildContext

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

Returns:


271
272
273
274
275
276
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 271

def context
  unless @instance_context
    @instance_context = ModelBuildContext.new(@version, @params['assistant_sid'], @params['sid'], )
  end
  @instance_context
end

#date_createdTime

Returns The date that this resource was created.

Returns:

  • (Time)

    The date that this resource was created


286
287
288
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 286

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date that this resource was last updated.

Returns:

  • (Time)

    The date that this resource was last updated


292
293
294
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 292

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the ModelBuildInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


358
359
360
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 358

def delete
  context.delete
end

#error_codeString

Returns The error_code.

Returns:

  • (String)

    The error_code


334
335
336
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 334

def error_code
  @properties['error_code']
end

#fetchModelBuildInstance

Fetch the ModelBuildInstance

Returns:


341
342
343
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 341

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation


371
372
373
374
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 371

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Preview.Understand.ModelBuildInstance #{values}>"
end

#sidString

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String)

    A 34 character string that uniquely identifies this resource.


304
305
306
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 304

def sid
  @properties['sid']
end

#statusmodel_build.Status

Returns A string that described the model build status. The values can be: enqueued, building, completed, failed.

Returns:

  • (model_build.Status)

    A string that described the model build status. The values can be: enqueued, building, completed, failed


310
311
312
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 310

def status
  @properties['status']
end

#to_sObject

Provide a user friendly representation


364
365
366
367
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 364

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

#unique_nameString

Returns A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.

Returns:

  • (String)

    A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.


316
317
318
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 316

def unique_name
  @properties['unique_name']
end

#update(unique_name: :unset) ⇒ ModelBuildInstance

Update the ModelBuildInstance

Parameters:

  • unique_name (String) (defaults to: :unset)

    A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long. For example: v0.1

Returns:


351
352
353
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 351

def update(unique_name: :unset)
  context.update(unique_name: unique_name, )
end

#urlString

Returns The url.

Returns:

  • (String)

    The url


322
323
324
# File 'lib/twilio-ruby/rest/preview/understand/assistant/model_build.rb', line 322

def url
  @properties['url']
end