limits

package
v2.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 4, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package limits provides API Limits operations.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type HTTPClient

type HTTPClient interface {
	Get(ctx context.Context, path string) ([]byte, error)
}

HTTPClient interface for dependency injection.

type Limit

type Limit struct {
	Max       int `json:"Max"`
	Remaining int `json:"Remaining"`
}

Limit represents an API limit.

func (Limit) PercentUsed

func (l Limit) PercentUsed() float64

PercentUsed returns the percentage of limit used.

func (Limit) Used

func (l Limit) Used() int

Used returns the number of uses consumed.

type Limits

type Limits struct {
	ActiveScratchOrgs                           Limit `json:"ActiveScratchOrgs"`
	AnalyticsExternalDataSizeMB                 Limit `json:"AnalyticsExternalDataSizeMB"`
	ConcurrentAsyncGetReportInstances           Limit `json:"ConcurrentAsyncGetReportInstances"`
	ConcurrentEinsteinDataInsightsStoryCreation Limit `json:"ConcurrentEinsteinDataInsightsStoryCreation"`
	ConcurrentEinsteinDiscoveryStoryCreation    Limit `json:"ConcurrentEinsteinDiscoveryStoryCreation"`
	ConcurrentSyncReportRuns                    Limit `json:"ConcurrentSyncReportRuns"`
	DailyAnalyticsDataflowJobExecutions         Limit `json:"DailyAnalyticsDataflowJobExecutions"`
	DailyAnalyticsUploadedFilesSizeMB           Limit `json:"DailyAnalyticsUploadedFilesSizeMB"`
	DailyApiRequests                            Limit `json:"DailyApiRequests"`
	DailyAsyncApexExecutions                    Limit `json:"DailyAsyncApexExecutions"`
	DailyBulkApiRequests                        Limit `json:"DailyBulkApiRequests"`
	DailyBulkV2QueryFileStorageMB               Limit `json:"DailyBulkV2QueryFileStorageMB"`
	DailyBulkV2QueryJobs                        Limit `json:"DailyBulkV2QueryJobs"`
	DailyDeliveredPlatformEvents                Limit `json:"DailyDeliveredPlatformEvents"`
	DailyDurableGenericStreamingApiEvents       Limit `json:"DailyDurableGenericStreamingApiEvents"`
	DailyDurableStreamingApiEvents              Limit `json:"DailyDurableStreamingApiEvents"`
	DailyEinsteinDataInsightsStoryCreation      Limit `json:"DailyEinsteinDataInsightsStoryCreation"`
	DailyEinsteinDiscoveryPredictAPIAggregate   Limit `json:"DailyEinsteinDiscoveryPredictAPICalls"`
	DailyEinsteinDiscoveryRecreatePredictions   Limit `json:"DailyEinsteinDiscoveryRecreatePredictions"`
	DailyEinsteinDiscoveryStoryCreation         Limit `json:"DailyEinsteinDiscoveryStoryCreation"`
	DailyFunctionsApiCallLimit                  Limit `json:"DailyFunctionsApiCallLimit"`
	DailyGenericStreamingApiEvents              Limit `json:"DailyGenericStreamingApiEvents"`
	DailyScratchOrgs                            Limit `json:"DailyScratchOrgs"`
	DailyStandardVolumePlatformEvents           Limit `json:"DailyStandardVolumePlatformEvents"`
	DailyStreamingApiEvents                     Limit `json:"DailyStreamingApiEvents"`
	DailyWorkflowEmails                         Limit `json:"DailyWorkflowEmails"`
	DataStorageMB                               Limit `json:"DataStorageMB"`
	DurableStreamingApiConcurrentClients        Limit `json:"DurableStreamingApiConcurrentClients"`
	FileStorageMB                               Limit `json:"FileStorageMB"`
	HourlyAsyncReportRuns                       Limit `json:"HourlyAsyncReportRuns"`
	HourlyDashboardRefreshes                    Limit `json:"HourlyDashboardRefreshes"`
	HourlyDashboardResults                      Limit `json:"HourlyDashboardResults"`
	HourlyDashboardStatuses                     Limit `json:"HourlyDashboardStatuses"`
	HourlyLongTermIdMapping                     Limit `json:"HourlyLongTermIdMapping"`
	HourlyManagedContentPublicRequests          Limit `json:"HourlyManagedContentPublicRequests"`
	HourlyODataCallout                          Limit `json:"HourlyODataCallout"`
	HourlyPublishedPlatformEvents               Limit `json:"HourlyPublishedPlatformEvents"`
	HourlyPublishedStandardVolumePlatformEvents Limit `json:"HourlyPublishedStandardVolumePlatformEvents"`
	HourlyShortTermIdMapping                    Limit `json:"HourlyShortTermIdMapping"`
	HourlySyncReportRuns                        Limit `json:"HourlySyncReportRuns"`
	HourlyTimeBasedWorkflow                     Limit `json:"HourlyTimeBasedWorkflow"`
	MassEmail                                   Limit `json:"MassEmail"`
	MonthlyEinsteinDiscoveryStoryCreation       Limit `json:"MonthlyEinsteinDiscoveryStoryCreation"`
	MonthlyPlatformEventsUsageEntitlement       Limit `json:"MonthlyPlatformEventsUsageEntitlement"`
	Package2VersionCreates                      Limit `json:"Package2VersionCreates"`
	Package2VersionCreatesWithoutValidation     Limit `json:"Package2VersionCreatesWithoutValidation"`
	PermissionSets                              Limit `json:"PermissionSets"`
	PrivateConnectOutboundCalloutHourlyLimitMB  Limit `json:"PrivateConnectOutboundCalloutHourlyLimitMB"`
	SingleEmail                                 Limit `json:"SingleEmail"`
	StreamingApiConcurrentClients               Limit `json:"StreamingApiConcurrentClients"`
}

Limits contains all API limits.

type Service

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

Service provides Limits API operations.

func NewService

func NewService(client HTTPClient, apiVersion string) *Service

NewService creates a new Limits service.

func (*Service) GetDailyApiRequests

func (s *Service) GetDailyApiRequests(ctx context.Context) (*Limit, error)

GetDailyApiRequests returns the daily API request limit.

func (*Service) GetDataStorage

func (s *Service) GetDataStorage(ctx context.Context) (*Limit, error)

GetDataStorage returns the data storage limit.

func (*Service) GetFileStorage

func (s *Service) GetFileStorage(ctx context.Context) (*Limit, error)

GetFileStorage returns the file storage limit.

func (*Service) GetLimits

func (s *Service) GetLimits(ctx context.Context) (*Limits, error)

GetLimits retrieves all API limits.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL