common

Documentation

Index

• Constants
• func GetPageSize() int
• func GetSortParams(sortBy SortField, sortOrder SortOrder) string
• func ReadAllPages[T any](ctx context.Context, client *zscaler.Client, endpoint string, list *[]T) error
• func ReadPage[T any](ctx context.Context, client *zscaler.Client, endpoint string, page int, ...) error
• type DataConsumed
• type DatacenterSearchParameters
• type DeviceGroups
• type Devices
• type IDCustom
• type IDExtensions
• type IDName
• type IDNameExtensions
• type IDNameWorkloadGroup
• type Order
• type SandboxRSS
• type SortField
• type SortOrder
• type UserDepartment
• type UserGroups
• type ZPAAppSegments

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](ctx context.Context, client *zscaler.Client, endpoint string, list *[]T) error

func ReadPage

func ReadPage[T any](ctx context.Context, client *zscaler.Client, endpoint string, page int, list *[]T) error

Types

type DataConsumed

type DataConsumed struct {
	Min int `json:"min,omitempty"`
	Max int `json:"max,omitempty"`
}

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 IDCustom

type IDCustom struct {
	ID int `json:"id,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 IDNameWorkloadGroup

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

type Order

type Order struct {
	On string `json:"on,omitempty"`
	By string `json:"by,omitempty"`
}

type SandboxRSS

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

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"`
}

type ZPAAppSegments

type ZPAAppSegments struct {
	// A unique identifier assigned to the Application Segment
	ID int `json:"id"`

	// The name of the Application Segment
	Name string `json:"name,omitempty"`

	// Indicates the external ID. Applicable only when this reference is of an external entity.
	ExternalID string `json:"externalId"`
}