billing

Documentation

Index

• type ActiveUsers
• type Client
  • func NewClient(c *api.Client) *Client
  • func (c *Client) ApiClient() *api.Client
  • func (c *Client) MonthlyActiveUsers(ctx context.Context, opt ...Option) (*MonthlyActiveUsersResult, error)
• type MonthlyActiveUsersResult
  • func (r MonthlyActiveUsersResult) GetItems() any
  • func (r MonthlyActiveUsersResult) GetResponse() *api.Response
• type Option
  • func WithAutomaticVersioning(enable bool) Option
  • func WithClientDirectedPagination(with bool) Option
  • func WithEndTime(inEndTime string) Option
  • func WithFilter(filter string) Option
  • func WithListToken(listToken string) Option
  • func WithPageSize(with uint32) Option
  • func WithResourcePathOverride(path string) Option
  • func WithSkipCurlOutput(skip bool) Option
  • func WithStartTime(inStartTime string) Option

Types

type ActiveUsers

type ActiveUsers struct {
	Count     uint32    `json:"count"`
	StartTime time.Time `json:"start_time,omitempty"`
	EndTime   time.Time `json:"end_time,omitempty"`
}

type Client

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

Client is a client for this collection

func NewClient

func NewClient(c *api.Client) *Client

Creates a new client for this collection. The submitted API client is cloned; modifications to it after generating this client will not have effect. If you need to make changes to the underlying API client, use ApiClient() to access it.

func (*Client) ApiClient

func (c *Client) ApiClient() *api.Client

ApiClient returns the underlying API client

func (*Client) MonthlyActiveUsers

func (c *Client) MonthlyActiveUsers(ctx context.Context, opt ...Option) (*MonthlyActiveUsersResult, error)

type MonthlyActiveUsersResult

type MonthlyActiveUsersResult struct {
	Items []*ActiveUsers
	// contains filtered or unexported fields
}

func (MonthlyActiveUsersResult) GetItems

func (r MonthlyActiveUsersResult) GetItems() any

func (MonthlyActiveUsersResult) GetResponse

func (r MonthlyActiveUsersResult) GetResponse() *api.Response

type Option

type Option func(*options)

Option is a func that sets optional attributes for a call. This does not need to be used directly, but instead option arguments are built from the functions in this package. WithX options set a value to that given in the argument; DefaultX options indicate that the value should be set to its default. When an API call is made options are processed in the order they appear in the function call, so for a given argument X, a succession of WithX or DefaultX calls will result in the last call taking effect.

func WithAutomaticVersioning

func WithAutomaticVersioning(enable bool) Option

If set, and if the version is zero during an update, the API will perform a fetch to get the current version of the resource and populate it during the update call. This is convenient but opens up the possibility for subtle order-of-modification issues, so use carefully.

func WithClientDirectedPagination

func WithClientDirectedPagination(with bool) Option

WithClientDirectedPagination tells the List function to return only the first page, if more pages are available

func WithEndTime

func WithEndTime(inEndTime string) Option

func WithFilter

func WithFilter(filter string) Option

WithFilter tells the API to filter the items returned using the provided filter term. The filter should be in a format supported by hashicorp/go-bexpr.

func WithListToken

func WithListToken(listToken string) Option

WithListToken tells the API to use the provided list token for listing operations on this resource.

func WithPageSize

func WithPageSize(with uint32) Option

WithPageSize controls the size of pages used during List

func WithResourcePathOverride

func WithResourcePathOverride(path string) Option

WithResourcePathOverride tells the API to use the provided resource path

func WithSkipCurlOutput

func WithSkipCurlOutput(skip bool) Option

WithSkipCurlOutput tells the API to not use the current call for cURL output. Useful for when we need to look up versions.

func WithStartTime

func WithStartTime(inStartTime string) Option