describer

Documentation

Index

• Constants
• func GetChromeDevice(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)
• func GetDomain(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)
• func GetDomainAlias(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)
• func GetGroup(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)
• func GetLoggerFromContext(ctx context.Context) *zap.Logger
• func GetMobileDevice(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)
• func GetOrgUnit(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)
• func GetParameterFromContext(ctx context.Context, key string) any
• func GetResourceBuilding(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)
• func GetResourceCalender(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)
• func GetResourceFeature(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)
• func GetRole(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)
• func GetRoleAssignment(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)
• func GetTriggerTypeFromContext(ctx context.Context) enums.DescribeTriggerType
• func GetUser(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)
• func ListChromeDevices(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListDomainAliases(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListDomains(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListGroupAliases(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListGroupMembers(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListGroups(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListMobileDevices(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListOrgUnits(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListPrivileges(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListResourceBuildings(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListResourceCalenders(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListResourceFeatures(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListRoleAssignments(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListRoles(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListUserAliases(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func ListUsers(ctx context.Context, handler *GoogleWorkspaceAPIHandler, ...) ([]models.Resource, error)
• func WithLogger(ctx context.Context, logger *zap.Logger) context.Context
• func WithTriggerType(ctx context.Context, tt enums.DescribeTriggerType) context.Context
• type GoogleWorkspaceAPIHandler
  • func NewGoogleWorkspaceAPIHandler(adminService *admin.Service, customerID string, rateLimit rate.Limit, ...) *GoogleWorkspaceAPIHandler
  • func (h *GoogleWorkspaceAPIHandler) DoRequest(ctx context.Context, requestFunc func() (*int, error)) error

Constants

const (
	MaxPageResultsUsers           = 500
	MaxPageResultsGroups          = 200
	MaxPageResultsGroupMembers    = 200
	MaxPageResultsMobileDevices   = 100
	MaxPageResultsChromeDevices   = 300
	MaxPageResultsRoles           = 100
	MaxPageResultsRoleAssignments = 100
	MaxPageResultsBuildings       = 100
	MaxPageResultsCalenders       = 100
	MaxPageResultsFeatures        = 100
)

Functions

func GetChromeDevice

func GetChromeDevice(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)

func GetDomain

func GetDomain(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)

func GetDomainAlias

func GetDomainAlias(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)

func GetGroup

func GetGroup(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)

func GetLoggerFromContext

func GetLoggerFromContext(ctx context.Context) *zap.Logger

func GetMobileDevice

func GetMobileDevice(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)

func GetOrgUnit

func GetOrgUnit(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)

func GetParameterFromContext

func GetParameterFromContext(ctx context.Context, key string) any

func GetResourceBuilding

func GetResourceBuilding(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)

func GetResourceCalender

func GetResourceCalender(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)

func GetResourceFeature

func GetResourceFeature(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)

func GetRole

func GetRole(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)

func GetRoleAssignment

func GetRoleAssignment(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)

func GetTriggerTypeFromContext

func GetTriggerTypeFromContext(ctx context.Context) enums.DescribeTriggerType

func GetUser

func GetUser(ctx context.Context, handler *GoogleWorkspaceAPIHandler, resourceID string) (*models.Resource, error)

func ListChromeDevices

func ListChromeDevices(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListDomainAliases

func ListDomainAliases(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListDomains

func ListDomains(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListGroupAliases

func ListGroupAliases(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListGroupMembers

func ListGroupMembers(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListGroups

func ListGroups(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListMobileDevices

func ListMobileDevices(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListOrgUnits

func ListOrgUnits(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListPrivileges

func ListPrivileges(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListResourceBuildings

func ListResourceBuildings(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListResourceCalenders

func ListResourceCalenders(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListResourceFeatures

func ListResourceFeatures(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListRoleAssignments

func ListRoleAssignments(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListRoles

func ListRoles(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListUserAliases

func ListUserAliases(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func ListUsers

func ListUsers(ctx context.Context, handler *GoogleWorkspaceAPIHandler, stream *models.StreamSender) ([]models.Resource, error)

func WithLogger

func WithLogger(ctx context.Context, logger *zap.Logger) context.Context

func WithTriggerType

func WithTriggerType(ctx context.Context, tt enums.DescribeTriggerType) context.Context

Types

type GoogleWorkspaceAPIHandler

type GoogleWorkspaceAPIHandler struct {
	AdminService *admin.Service
	CustomerID   string
	RateLimiter  *rate.Limiter
	Semaphore    chan struct{}
	MaxRetries   int
	RetryBackoff time.Duration
}

func NewGoogleWorkspaceAPIHandler

func NewGoogleWorkspaceAPIHandler(adminService *admin.Service, customerID string, rateLimit rate.Limit, burst int, maxConcurrency int, maxRetries int, retryBackoff time.Duration) *GoogleWorkspaceAPIHandler

func (*GoogleWorkspaceAPIHandler) DoRequest

func (h *GoogleWorkspaceAPIHandler) DoRequest(ctx context.Context, requestFunc func() (*int, error)) error

DoRequest executes the googleWorkspace API request with rate limiting, retries, and concurrency control.