Class: Twilio::REST::Autopilot::V1::AssistantContext::ModelBuildInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/autopilot/v1/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 SID of the [Assistant](www.twilio.com/docs/autopilot/api/assistant) that is the parent of the resource.

  • sid (String) (defaults to: nil)

    The Twilio-provided string that uniquely identifies the ModelBuild resource to fetch.



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 273

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 SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource



308
309
310
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 308

def 
  @properties['account_sid']
end

#assistant_sidString

Returns The SID of the Assistant that is the parent of the resource.

Returns:

  • (String)

    The SID of the Assistant that is the parent of the resource



326
327
328
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 326

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



356
357
358
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 356

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:



299
300
301
302
303
304
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 299

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

#date_createdTime

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT when the resource was created



314
315
316
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 314

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time)

    The RFC 2822 date and time in GMT when the resource was last updated



320
321
322
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 320

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Deletes the ModelBuildInstance

Returns:

  • (Boolean)

    true if delete succeeds, true otherwise



387
388
389
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 387

def delete
  context.delete
end

#error_codeString

Returns More information about why the model build failed, if ‘status` is `failed`.

Returns:

  • (String)

    More information about why the model build failed, if ‘status` is `failed`



362
363
364
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 362

def error_code
  @properties['error_code']
end

#fetchModelBuildInstance

Fetch a ModelBuildInstance

Returns:



369
370
371
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 369

def fetch
  context.fetch
end

#inspectObject

Provide a detailed, user friendly representation



400
401
402
403
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 400

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

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource



332
333
334
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 332

def sid
  @properties['sid']
end

#statusmodel_build.Status

Returns The status of the model build process.

Returns:

  • (model_build.Status)

    The status of the model build process



338
339
340
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 338

def status
  @properties['status']
end

#to_sObject

Provide a user friendly representation



393
394
395
396
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 393

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

#unique_nameString

Returns An application-defined string that uniquely identifies the resource.

Returns:

  • (String)

    An application-defined string that uniquely identifies the resource



344
345
346
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 344

def unique_name
  @properties['unique_name']
end

#update(unique_name: :unset) ⇒ ModelBuildInstance

Update the ModelBuildInstance

Parameters:

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

    An application-defined string that uniquely identifies the resource. This value must be a unique string of no more than 64 characters. It can be used as an alternative to the ‘sid` in the URL path to address the resource.

Returns:



380
381
382
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 380

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

#urlString

Returns The absolute URL of the ModelBuild resource.

Returns:

  • (String)

    The absolute URL of the ModelBuild resource



350
351
352
# File 'lib/twilio-ruby/rest/autopilot/v1/assistant/model_build.rb', line 350

def url
  @properties['url']
end