Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkerContext::WorkersRealTimeStatisticsInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil) ⇒ WorkersRealTimeStatisticsInstance

Initialize the WorkersRealTimeStatisticsInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • workspace_sid (String) (defaults to: nil)

    The SID of the Workspace that contains the Workers.


117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 117

def initialize(version, payload, workspace_sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'activity_statistics' => payload['activity_statistics'],
      'total_workers' => payload['total_workers'].to_i,
      'workspace_sid' => payload['workspace_sid'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'workspace_sid' => workspace_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


147
148
149
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 147

def 
  @properties['account_sid']
end

#activity_statisticsArray[Hash]

Returns The number of current Workers by Activity.

Returns:

  • (Array[Hash])

    The number of current Workers by Activity


153
154
155
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 153

def activity_statistics
  @properties['activity_statistics']
end

#contextWorkersRealTimeStatisticsContext

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

Returns:


138
139
140
141
142
143
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 138

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

#fetch(task_channel: :unset) ⇒ WorkersRealTimeStatisticsInstance

Fetch the WorkersRealTimeStatisticsInstance

Parameters:

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

    Only calculate real-time statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.

Returns:


181
182
183
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 181

def fetch(task_channel: :unset)
  context.fetch(task_channel: task_channel, )
end

#inspectObject

Provide a detailed, user friendly representation


194
195
196
197
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 194

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

#to_sObject

Provide a user friendly representation


187
188
189
190
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 187

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

#total_workersString

Returns The total number of Workers.

Returns:

  • (String)

    The total number of Workers


159
160
161
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 159

def total_workers
  @properties['total_workers']
end

#urlString

Returns The absolute URL of the Workers statistics resource.

Returns:

  • (String)

    The absolute URL of the Workers statistics resource


171
172
173
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 171

def url
  @properties['url']
end

#workspace_sidString

Returns The SID of the Workspace that contains the Workers.

Returns:

  • (String)

    The SID of the Workspace that contains the Workers


165
166
167
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb', line 165

def workspace_sid
  @properties['workspace_sid']
end