8.4 KiB
LeaderboardSelfRank
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| CostCents | Pointer to int64 | CostCents is the caller's own spend in whole US cents. Always populated — your own spend is never withheld from you — so here 0 really does mean zero. | [optional] |
| Handle | Pointer to string | Handle is how the caller appears on this board: their chosen handle, falling back to their username, on a user board; their org id on the global board. Present even when unlisted — this is the caller looking at themselves. | [optional] |
| Listed | Pointer to bool | Listed says whether the caller is publicly visible on this board: opted in on a user board, org opted in (or the viewer is a platform admin) on the global one. False is the prompt to offer the opt-in, and explains an unranked global self. | [optional] |
| Metric | Pointer to int64 | Metric is whichever of the three values above the board was ranked by, so a client can compare the caller against the rows without re-reading the request. Metric <= 0 is exactly the case that leaves Ranked false. | [optional] |
| OfTotal | Pointer to int64 | OfTotal is the size of the universe Rank is out of — "rank N of OfTotal". On a user board that is the org's users with any usage in the window; on the global board it is every active org for a platform admin, and the count of opted-in orgs for everyone else. | [optional] |
| Rank | Pointer to int64 | Rank is the caller's 1-based standing, computed as (subjects whose windowed metric strictly exceeds the caller's) + 1. It is exact against the whole ranked universe, not just the returned page, so it can far exceed len(rows). Read it only when Ranked. | [optional] |
| Ranked | Pointer to bool | Ranked is false when the caller holds no position: they had no usage in the window, or (on the global board) their org has not opted into public listing and so is not ranked against a set it never joined. Rank is then 0 and means nothing. | [optional] |
| Requests | Pointer to int64 | Requests is the caller's own request count in the window, 0 if they were idle. | [optional] |
| Tokens | Pointer to int64 | Tokens is the caller's own prompt+completion tokens in the window. | [optional] |
Methods
NewLeaderboardSelfRank
func NewLeaderboardSelfRank() *LeaderboardSelfRank
NewLeaderboardSelfRank instantiates a new LeaderboardSelfRank 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
NewLeaderboardSelfRankWithDefaults
func NewLeaderboardSelfRankWithDefaults() *LeaderboardSelfRank
NewLeaderboardSelfRankWithDefaults instantiates a new LeaderboardSelfRank 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
GetCostCents
func (o *LeaderboardSelfRank) GetCostCents() int64
GetCostCents returns the CostCents field if non-nil, zero value otherwise.
GetCostCentsOk
func (o *LeaderboardSelfRank) GetCostCentsOk() (*int64, bool)
GetCostCentsOk returns a tuple with the CostCents field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
SetCostCents
func (o *LeaderboardSelfRank) SetCostCents(v int64)
SetCostCents sets CostCents field to given value.
HasCostCents
func (o *LeaderboardSelfRank) HasCostCents() bool
HasCostCents returns a boolean if a field has been set.
GetHandle
func (o *LeaderboardSelfRank) GetHandle() string
GetHandle returns the Handle field if non-nil, zero value otherwise.
GetHandleOk
func (o *LeaderboardSelfRank) GetHandleOk() (*string, bool)
GetHandleOk returns a tuple with the Handle field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
SetHandle
func (o *LeaderboardSelfRank) SetHandle(v string)
SetHandle sets Handle field to given value.
HasHandle
func (o *LeaderboardSelfRank) HasHandle() bool
HasHandle returns a boolean if a field has been set.
GetListed
func (o *LeaderboardSelfRank) GetListed() bool
GetListed returns the Listed field if non-nil, zero value otherwise.
GetListedOk
func (o *LeaderboardSelfRank) GetListedOk() (*bool, bool)
GetListedOk returns a tuple with the Listed field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
SetListed
func (o *LeaderboardSelfRank) SetListed(v bool)
SetListed sets Listed field to given value.
HasListed
func (o *LeaderboardSelfRank) HasListed() bool
HasListed returns a boolean if a field has been set.
GetMetric
func (o *LeaderboardSelfRank) GetMetric() int64
GetMetric returns the Metric field if non-nil, zero value otherwise.
GetMetricOk
func (o *LeaderboardSelfRank) GetMetricOk() (*int64, 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 *LeaderboardSelfRank) SetMetric(v int64)
SetMetric sets Metric field to given value.
HasMetric
func (o *LeaderboardSelfRank) HasMetric() bool
HasMetric returns a boolean if a field has been set.
GetOfTotal
func (o *LeaderboardSelfRank) GetOfTotal() int64
GetOfTotal returns the OfTotal field if non-nil, zero value otherwise.
GetOfTotalOk
func (o *LeaderboardSelfRank) GetOfTotalOk() (*int64, bool)
GetOfTotalOk returns a tuple with the OfTotal field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
SetOfTotal
func (o *LeaderboardSelfRank) SetOfTotal(v int64)
SetOfTotal sets OfTotal field to given value.
HasOfTotal
func (o *LeaderboardSelfRank) HasOfTotal() bool
HasOfTotal returns a boolean if a field has been set.
GetRank
func (o *LeaderboardSelfRank) GetRank() int64
GetRank returns the Rank field if non-nil, zero value otherwise.
GetRankOk
func (o *LeaderboardSelfRank) GetRankOk() (*int64, bool)
GetRankOk returns a tuple with the Rank field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
SetRank
func (o *LeaderboardSelfRank) SetRank(v int64)
SetRank sets Rank field to given value.
HasRank
func (o *LeaderboardSelfRank) HasRank() bool
HasRank returns a boolean if a field has been set.
GetRanked
func (o *LeaderboardSelfRank) GetRanked() bool
GetRanked returns the Ranked field if non-nil, zero value otherwise.
GetRankedOk
func (o *LeaderboardSelfRank) GetRankedOk() (*bool, bool)
GetRankedOk returns a tuple with the Ranked field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
SetRanked
func (o *LeaderboardSelfRank) SetRanked(v bool)
SetRanked sets Ranked field to given value.
HasRanked
func (o *LeaderboardSelfRank) HasRanked() bool
HasRanked returns a boolean if a field has been set.
GetRequests
func (o *LeaderboardSelfRank) GetRequests() int64
GetRequests returns the Requests field if non-nil, zero value otherwise.
GetRequestsOk
func (o *LeaderboardSelfRank) GetRequestsOk() (*int64, bool)
GetRequestsOk returns a tuple with the Requests field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
SetRequests
func (o *LeaderboardSelfRank) SetRequests(v int64)
SetRequests sets Requests field to given value.
HasRequests
func (o *LeaderboardSelfRank) HasRequests() bool
HasRequests returns a boolean if a field has been set.
GetTokens
func (o *LeaderboardSelfRank) GetTokens() int64
GetTokens returns the Tokens field if non-nil, zero value otherwise.
GetTokensOk
func (o *LeaderboardSelfRank) GetTokensOk() (*int64, bool)
GetTokensOk returns a tuple with the Tokens field if it's non-nil, zero value otherwise and a boolean to check if the value has been set.
SetTokens
func (o *LeaderboardSelfRank) SetTokens(v int64)
SetTokens sets Tokens field to given value.
HasTokens
func (o *LeaderboardSelfRank) HasTokens() bool
HasTokens returns a boolean if a field has been set.