users

Documentation

Index

• Constants
• type QuotasResponseItem
• type QuotasResponseLimits
• type QuotasResponseUsed
• type UsersService
  • func NewUsersClientFromOptions(opts *options.Options) UsersService

Constants

const Endpoint = "/users"

Endpoint is the public path for the users service.

Types

type QuotasResponseItem

type QuotasResponseItem struct {
	UUID   string               `json:"uuid"`
	Used   QuotasResponseUsed   `json:"used"`
	Hard   QuotasResponseUsed   `json:"hard"`
	Limits QuotasResponseLimits `json:"limits"`

	kcclient.APIResponseCommon
}

QuotasResponseItem is a data item from a response to a GET /users/quotas request. https://docs.kraft.cloud/api/v1/users/#list-quota-usage-and-limits

type QuotasResponseLimits

type QuotasResponseLimits struct {
	MinMemoryMb      int `json:"min_memory_mb"`
	MaxMemoryMb      int `json:"max_memory_mb"`
	MinVolumeMb      int `json:"min_volume_mb"`
	MaxVolumeMb      int `json:"max_volume_mb"`
	MinAutoscaleSize int `json:"min_autoscale_size"`
	MaxAutoscaleSize int `json:"max_autoscale_size"`
}

type QuotasResponseUsed

type QuotasResponseUsed struct {
	Instances     int `json:"instances"`
	LiveInstances int `json:"live_instances"`
	LiveMemoryMb  int `json:"live_memory_mb"`
	ServiceGroups int `json:"service_groups"`
	Services      int `json:"services"`
	Volumes       int `json:"volumes"`
	TotalVolumeMb int `json:"total_volume_mb"`
}

type UsersService

type UsersService interface {
	kcclient.ServiceClient[UsersService]

	// Lists quota usage and limits of your user account. Limits are hard limits
	// that cannot be exceeded.
	// https://docs.kraft.cloud/api/v1/users/#list-quota-usage-and-limits
	Quotas(ctx context.Context) (*kcclient.ServiceResponse[QuotasResponseItem], error)
}

func NewUsersClientFromOptions

func NewUsersClientFromOptions(opts *options.Options) UsersService

NewUsersClientFromOptions instantiates a new users services client based on the provided pre-existing options.