Files
sdk/docs/LeaderboardLeaderboardView.md

10 KiB

LeaderboardLeaderboardView

Properties

Name Type Description Notes
Available Pointer to bool Available is false when the usage warehouse is not connected or its rollup is not ready. Rows is then empty because nothing could be read — not because nobody used anything. Show that difference; never render an unavailable board as a real one. [optional]
End Pointer to string End is the EXCLUSIVE upper bound of the window, "2006-01-02" — the day after the last one counted. A board through today reports tomorrow's date here. [optional]
Metric Pointer to string Metric echoes the value ranked: tokens requests
Period Pointer to string Period is the window's canonical label: day week
Rows Pointer to []LeaderboardLeaderboardRow Rows are the ranked subjects, best first, at most the requested limit of them. Always a list, never null: an empty one means nothing was read, not an error. [optional]
Scope Pointer to string Scope echoes the board that was served: personal org
Self Pointer to LeaderboardSelfRank Self is the caller's own standing, reported even when they fall outside Rows. Absent when the caller's ledger identity cannot be resolved, or when the query behind it failed — never faked to keep the shape tidy. [optional]
Source Pointer to string Source names the table these numbers were aggregated from (the derived daily rollup, hanzo.usage_rollup_daily), so an operator can tell exactly what was read. [optional]
Start Pointer to string Start is the first day counted, "2006-01-02" inclusive. Empty for period=all, which has no lower bound at all. [optional]
Subject Pointer to string Subject is what the rows stand for — "user" on a personal or org board, "org" on the global one. It tells a client whether Handle names a person or a company. [optional]
Total Pointer to int64 Total is how many subjects were ranked in the window — the org's active users, or the active/opted-in orgs on the global board. It is the universe the ranks are out of, so it is normally larger than len(rows). [optional]

Methods

NewLeaderboardLeaderboardView

func NewLeaderboardLeaderboardView() *LeaderboardLeaderboardView

NewLeaderboardLeaderboardView instantiates a new LeaderboardLeaderboardView object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

NewLeaderboardLeaderboardViewWithDefaults

func NewLeaderboardLeaderboardViewWithDefaults() *LeaderboardLeaderboardView

NewLeaderboardLeaderboardViewWithDefaults instantiates a new LeaderboardLeaderboardView object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

GetAvailable

func (o *LeaderboardLeaderboardView) GetAvailable() bool

GetAvailable returns the Available field if non-nil, zero value otherwise.

GetAvailableOk

func (o *LeaderboardLeaderboardView) GetAvailableOk() (*bool, bool)

GetAvailableOk returns a tuple with the Available field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetAvailable

func (o *LeaderboardLeaderboardView) SetAvailable(v bool)

SetAvailable sets Available field to given value.

HasAvailable

func (o *LeaderboardLeaderboardView) HasAvailable() bool

HasAvailable returns a boolean if a field has been set.

GetEnd

func (o *LeaderboardLeaderboardView) GetEnd() string

GetEnd returns the End field if non-nil, zero value otherwise.

GetEndOk

func (o *LeaderboardLeaderboardView) GetEndOk() (*string, bool)

GetEndOk returns a tuple with the End field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetEnd

func (o *LeaderboardLeaderboardView) SetEnd(v string)

SetEnd sets End field to given value.

HasEnd

func (o *LeaderboardLeaderboardView) HasEnd() bool

HasEnd returns a boolean if a field has been set.

GetMetric

func (o *LeaderboardLeaderboardView) GetMetric() string

GetMetric returns the Metric field if non-nil, zero value otherwise.

GetMetricOk

func (o *LeaderboardLeaderboardView) GetMetricOk() (*string, bool)

GetMetricOk returns a tuple with the Metric field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMetric

func (o *LeaderboardLeaderboardView) SetMetric(v string)

SetMetric sets Metric field to given value.

HasMetric

func (o *LeaderboardLeaderboardView) HasMetric() bool

HasMetric returns a boolean if a field has been set.

GetPeriod

func (o *LeaderboardLeaderboardView) GetPeriod() string

GetPeriod returns the Period field if non-nil, zero value otherwise.

GetPeriodOk

func (o *LeaderboardLeaderboardView) GetPeriodOk() (*string, bool)

GetPeriodOk returns a tuple with the Period field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPeriod

func (o *LeaderboardLeaderboardView) SetPeriod(v string)

SetPeriod sets Period field to given value.

HasPeriod

func (o *LeaderboardLeaderboardView) HasPeriod() bool

HasPeriod returns a boolean if a field has been set.

GetRows

func (o *LeaderboardLeaderboardView) GetRows() []LeaderboardLeaderboardRow

GetRows returns the Rows field if non-nil, zero value otherwise.

GetRowsOk

func (o *LeaderboardLeaderboardView) GetRowsOk() (*[]LeaderboardLeaderboardRow, bool)

GetRowsOk returns a tuple with the Rows field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRows

func (o *LeaderboardLeaderboardView) SetRows(v []LeaderboardLeaderboardRow)

SetRows sets Rows field to given value.

HasRows

func (o *LeaderboardLeaderboardView) HasRows() bool

HasRows returns a boolean if a field has been set.

GetScope

func (o *LeaderboardLeaderboardView) GetScope() string

GetScope returns the Scope field if non-nil, zero value otherwise.

GetScopeOk

func (o *LeaderboardLeaderboardView) GetScopeOk() (*string, bool)

GetScopeOk returns a tuple with the Scope field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetScope

func (o *LeaderboardLeaderboardView) SetScope(v string)

SetScope sets Scope field to given value.

HasScope

func (o *LeaderboardLeaderboardView) HasScope() bool

HasScope returns a boolean if a field has been set.

GetSelf

func (o *LeaderboardLeaderboardView) GetSelf() LeaderboardSelfRank

GetSelf returns the Self field if non-nil, zero value otherwise.

GetSelfOk

func (o *LeaderboardLeaderboardView) GetSelfOk() (*LeaderboardSelfRank, bool)

GetSelfOk returns a tuple with the Self field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSelf

func (o *LeaderboardLeaderboardView) SetSelf(v LeaderboardSelfRank)

SetSelf sets Self field to given value.

HasSelf

func (o *LeaderboardLeaderboardView) HasSelf() bool

HasSelf returns a boolean if a field has been set.

GetSource

func (o *LeaderboardLeaderboardView) GetSource() string

GetSource returns the Source field if non-nil, zero value otherwise.

GetSourceOk

func (o *LeaderboardLeaderboardView) GetSourceOk() (*string, bool)

GetSourceOk returns a tuple with the Source field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSource

func (o *LeaderboardLeaderboardView) SetSource(v string)

SetSource sets Source field to given value.

HasSource

func (o *LeaderboardLeaderboardView) HasSource() bool

HasSource returns a boolean if a field has been set.

GetStart

func (o *LeaderboardLeaderboardView) GetStart() string

GetStart returns the Start field if non-nil, zero value otherwise.

GetStartOk

func (o *LeaderboardLeaderboardView) GetStartOk() (*string, bool)

GetStartOk returns a tuple with the Start field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStart

func (o *LeaderboardLeaderboardView) SetStart(v string)

SetStart sets Start field to given value.

HasStart

func (o *LeaderboardLeaderboardView) HasStart() bool

HasStart returns a boolean if a field has been set.

GetSubject

func (o *LeaderboardLeaderboardView) GetSubject() string

GetSubject returns the Subject field if non-nil, zero value otherwise.

GetSubjectOk

func (o *LeaderboardLeaderboardView) GetSubjectOk() (*string, bool)

GetSubjectOk returns a tuple with the Subject field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSubject

func (o *LeaderboardLeaderboardView) SetSubject(v string)

SetSubject sets Subject field to given value.

HasSubject

func (o *LeaderboardLeaderboardView) HasSubject() bool

HasSubject returns a boolean if a field has been set.

GetTotal

func (o *LeaderboardLeaderboardView) GetTotal() int64

GetTotal returns the Total field if non-nil, zero value otherwise.

GetTotalOk

func (o *LeaderboardLeaderboardView) GetTotalOk() (*int64, bool)

GetTotalOk returns a tuple with the Total field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.

SetTotal

func (o *LeaderboardLeaderboardView) SetTotal(v int64)

SetTotal sets Total field to given value.

HasTotal

func (o *LeaderboardLeaderboardView) HasTotal() bool

HasTotal returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]