real_time_statistics

Documentation

Overview

Package real_time_statistics contains auto-generated files. DO NOT MODIFY

Package real_time_statistics contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch(options *FetchRealTimeStatisticsOptions) (*FetchRealTimeStatisticsResponse, error)
  • func (c Client) FetchWithContext(context context.Context, options *FetchRealTimeStatisticsOptions) (*FetchRealTimeStatisticsResponse, error)
• type ClientProperties
• type FetchActivityStatistic
• type FetchRealTimeStatisticsOptions
• type FetchRealTimeStatisticsResponse

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for managing task queue real time statistics See https://www.twilio.com/docs/taskrouter/api/taskqueue-statistics for more details

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the real time statistics client

func (Client) Fetch

func (c Client) Fetch(options *FetchRealTimeStatisticsOptions) (*FetchRealTimeStatisticsResponse, error)

Fetch retrieves real time statistics See https://www.twilio.com/docs/taskrouter/api/taskqueue-statistics#taskqueue-realtime-statisticss for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context, options *FetchRealTimeStatisticsOptions) (*FetchRealTimeStatisticsResponse, error)

FetchWithContext retrieves real time statistics See https://www.twilio.com/docs/taskrouter/api/taskqueue-statistics#taskqueue-realtime-statisticss for more details

type ClientProperties

type ClientProperties struct {
	TaskQueueSid string
	WorkspaceSid string
}

ClientProperties are the properties required to manage the real time statistics resources

type FetchActivityStatistic

type FetchActivityStatistic struct {
	FriendlyName string `json:"friendly_name"`
	Sid          string `json:"sid"`
	Workers      int    `json:"workers"`
}

type FetchRealTimeStatisticsOptions

type FetchRealTimeStatisticsOptions struct {
	TaskChannel *string
}

FetchRealTimeStatisticsOptions defines the query options for the api operation

type FetchRealTimeStatisticsResponse

type FetchRealTimeStatisticsResponse struct {
	AccountSid                    string                   `json:"account_sid"`
	ActivityStatistics            []FetchActivityStatistic `json:"activity_statistics"`
	LongestRelativeTaskAgeInQueue int                      `json:"longest_relative_task_age_in_queue"`
	LongestRelativeTaskSidInQueue *string                  `json:"longest_relative_task_sid_in_queue,omitempty"`
	LongestTaskWaitingAge         int                      `json:"longest_task_waiting_age"`
	LongestTaskWaitingSid         *string                  `json:"longest_task_waiting_sid,omitempty"`
	TaskQueueSid                  string                   `json:"task_queue_sid"`
	TasksByPriority               map[string]int           `json:"tasks_by_priority"`
	TasksByStatus                 map[string]int           `json:"tasks_by_status"`
	TotalAvailableWorkers         int                      `json:"total_available_workers"`
	TotalEligibleWorkers          int                      `json:"total_eligible_workers"`
	TotalTasks                    int                      `json:"total_tasks"`
	URL                           string                   `json:"url"`
	WorkspaceSid                  string                   `json:"workspace_sid"`
}

FetchRealTimeStatisticsResponse defines the response fields for the retrieved real time statistics