common

Documentation

Index

• Constants
• func GetPageSize() int
• func GetSortParams(sortBy SortField, sortOrder SortOrder) string
• func ReadAllPages[T any](client *zia.Client, endpoint string, list *[]T) error
• func ReadPage[T any](client *zia.Client, endpoint string, page int, list *[]T) error
• type DatacenterSearchParameters
• type DeviceGroups
• type Devices
• type IDExtensions
• type IDName
• type IDNameExtensions
• type SandboxRSS
• type Service
  • func New(c *zia.Client) *Service
• type SortField
• type SortOrder
• type UserDepartment
• type UserGroups

Constants

const (
	ASCSortOrder          SortOrder = "ASC"
	DESCSortOrder                   = "DESC"
	IDSortField           SortField = "id"
	NameSortField                   = "name"
	CreationTimeSortField           = "creationTime"
	ModifiedTimeSortField           = "modifiedTime"
)

Functions

func GetPageSize

func GetPageSize() int

GetPageSize returns the page size.

func GetSortParams

func GetSortParams(sortBy SortField, sortOrder SortOrder) string

func ReadAllPages

func ReadAllPages[T any](client *zia.Client, endpoint string, list *[]T) error

func ReadPage

func ReadPage[T any](client *zia.Client, endpoint string, page int, list *[]T) error

Types

type DatacenterSearchParameters

type DatacenterSearchParameters struct {
	RoutableIP                bool
	WithinCountryOnly         bool
	IncludePrivateServiceEdge bool
	IncludeCurrentVips        bool
	SourceIp                  string
	Latitude                  float64
	Longitude                 float64
	Subcloud                  string
}

type DeviceGroups

type DeviceGroups struct {
	ID   int    `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type Devices

type Devices struct {
	ID   int    `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type IDExtensions

type IDExtensions struct {
	ID         int                    `json:"id,omitempty"`
	Extensions map[string]interface{} `json:"extensions,omitempty"`
}

type IDName

type IDName struct {
	ID   int    `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

type IDNameExtensions

type IDNameExtensions struct {
	ID         int                    `json:"id,omitempty"`
	Name       string                 `json:"name,omitempty"`
	Extensions map[string]interface{} `json:"extensions,omitempty"`
}

type SandboxRSS

type SandboxRSS struct {
	Risk             string `json:"Risk,omitempty"`
	Signature        string `json:"Signature,omitempty"`
	SignatureSources string `json:"SignatureSources,omitempty"`
}

type Service

type Service struct {
	Client *zia.Client
}

func New

func New(c *zia.Client) *Service

type SortField

type SortField string

type SortOrder

type SortOrder string

type UserDepartment

type UserDepartment struct {
	ID       int    `json:"id,omitempty"`
	Name     string `json:"name,omitempty"`
	IdpID    int    `json:"idp_id,omitempty"`
	Comments string `json:"comments,omitempty"`
	Deleted  bool   `json:"deleted,omitempty"`
}

type UserGroups

type UserGroups struct {
	ID       int    `json:"id,omitempty"`
	Name     string `json:"name,omitempty"`
	IdpID    int    `json:"idp_id,omitempty"`
	Comments string `json:"comments,omitempty"`
}