report

package
v8.11.3 Latest Latest
Warning

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

 Go to latest Published: Aug 24, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package report provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

View Source 
const (
	ApiKeyScopes     = "apiKey.Scopes"
	BearerAuthScopes = "bearerAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewGetCustomersReportDashboardRequest 

func NewGetCustomersReportDashboardRequest(server string) (*http.Request, error)

NewGetCustomersReportDashboardRequest generates requests for GetCustomersReportDashboard

func NewGetHistoricalDnsLogsRequest 

func NewGetHistoricalDnsLogsRequest(server string, params *GetHistoricalDnsLogsParams) (*http.Request, error)

NewGetHistoricalDnsLogsRequest generates requests for GetHistoricalDnsLogs

func NewGetStatisticsRequest 

func NewGetStatisticsRequest(server string, params *GetStatisticsParams) (*http.Request, error)

NewGetStatisticsRequest generates requests for GetStatistics

func NewGetTopCategoriesRequest 

func NewGetTopCategoriesRequest(server string, params *GetTopCategoriesParams) (*http.Request, error)

NewGetTopCategoriesRequest generates requests for GetTopCategories

func NewGetTopDomainsByCategoryRequest 

func NewGetTopDomainsByCategoryRequest(server string, params *GetTopDomainsByCategoryParams) (*http.Request, error)

NewGetTopDomainsByCategoryRequest generates requests for GetTopDomainsByCategory

func NewGetTopDomainsRequest 

func NewGetTopDomainsRequest(server string, params *GetTopDomainsParams) (*http.Request, error)

NewGetTopDomainsRequest generates requests for GetTopDomains

Types

type BadRequestResponse 

type BadRequestResponse = FlashStartErrorBody

BadRequestResponse defines model for BadRequest.

type Client 

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient 

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) GetCustomersReportDashboard 

func (c *Client) GetCustomersReportDashboard(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetHistoricalDnsLogs 

func (c *Client) GetHistoricalDnsLogs(ctx context.Context, params *GetHistoricalDnsLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetStatistics 

func (c *Client) GetStatistics(ctx context.Context, params *GetStatisticsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTopCategories 

func (c *Client) GetTopCategories(ctx context.Context, params *GetTopCategoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTopDomains 

func (c *Client) GetTopDomains(ctx context.Context, params *GetTopDomainsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetTopDomainsByCategory 

func (c *Client) GetTopDomainsByCategory(ctx context.Context, params *GetTopDomainsByCategoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface 

type ClientInterface interface {
	// GetTopCategories request
	GetTopCategories(ctx context.Context, params *GetTopCategoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTopDomainsByCategory request
	GetTopDomainsByCategory(ctx context.Context, params *GetTopDomainsByCategoryParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetCustomersReportDashboard request
	GetCustomersReportDashboard(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetHistoricalDnsLogs request
	GetHistoricalDnsLogs(ctx context.Context, params *GetHistoricalDnsLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetTopDomains request
	GetTopDomains(ctx context.Context, params *GetTopDomainsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetStatistics request
	GetStatistics(ctx context.Context, params *GetStatisticsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption 

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL 

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient 

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn 

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses 

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses 

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) GetCustomersReportDashboardWithResponse 

func (c *ClientWithResponses) GetCustomersReportDashboardWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCustomersReportDashboardResponse, error)

GetCustomersReportDashboardWithResponse request returning *GetCustomersReportDashboardResponse

func (*ClientWithResponses) GetHistoricalDnsLogsWithResponse 

func (c *ClientWithResponses) GetHistoricalDnsLogsWithResponse(ctx context.Context, params *GetHistoricalDnsLogsParams, reqEditors ...RequestEditorFn) (*GetHistoricalDnsLogsResponse, error)

GetHistoricalDnsLogsWithResponse request returning *GetHistoricalDnsLogsResponse

func (*ClientWithResponses) GetStatisticsWithResponse 

func (c *ClientWithResponses) GetStatisticsWithResponse(ctx context.Context, params *GetStatisticsParams, reqEditors ...RequestEditorFn) (*GetStatisticsResponse, error)

GetStatisticsWithResponse request returning *GetStatisticsResponse

func (*ClientWithResponses) GetTopCategoriesWithResponse 

func (c *ClientWithResponses) GetTopCategoriesWithResponse(ctx context.Context, params *GetTopCategoriesParams, reqEditors ...RequestEditorFn) (*GetTopCategoriesResponse, error)

GetTopCategoriesWithResponse request returning *GetTopCategoriesResponse

func (*ClientWithResponses) GetTopDomainsByCategoryWithResponse 

func (c *ClientWithResponses) GetTopDomainsByCategoryWithResponse(ctx context.Context, params *GetTopDomainsByCategoryParams, reqEditors ...RequestEditorFn) (*GetTopDomainsByCategoryResponse, error)

GetTopDomainsByCategoryWithResponse request returning *GetTopDomainsByCategoryResponse

func (*ClientWithResponses) GetTopDomainsWithResponse 

func (c *ClientWithResponses) GetTopDomainsWithResponse(ctx context.Context, params *GetTopDomainsParams, reqEditors ...RequestEditorFn) (*GetTopDomainsResponse, error)

GetTopDomainsWithResponse request returning *GetTopDomainsResponse

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// GetTopCategoriesWithResponse request
	GetTopCategoriesWithResponse(ctx context.Context, params *GetTopCategoriesParams, reqEditors ...RequestEditorFn) (*GetTopCategoriesResponse, error)

	// GetTopDomainsByCategoryWithResponse request
	GetTopDomainsByCategoryWithResponse(ctx context.Context, params *GetTopDomainsByCategoryParams, reqEditors ...RequestEditorFn) (*GetTopDomainsByCategoryResponse, error)

	// GetCustomersReportDashboardWithResponse request
	GetCustomersReportDashboardWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetCustomersReportDashboardResponse, error)

	// GetHistoricalDnsLogsWithResponse request
	GetHistoricalDnsLogsWithResponse(ctx context.Context, params *GetHistoricalDnsLogsParams, reqEditors ...RequestEditorFn) (*GetHistoricalDnsLogsResponse, error)

	// GetTopDomainsWithResponse request
	GetTopDomainsWithResponse(ctx context.Context, params *GetTopDomainsParams, reqEditors ...RequestEditorFn) (*GetTopDomainsResponse, error)

	// GetStatisticsWithResponse request
	GetStatisticsWithResponse(ctx context.Context, params *GetStatisticsParams, reqEditors ...RequestEditorFn) (*GetStatisticsResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type FlashStartErrorBody 

type FlashStartErrorBody struct {
	Code    string       `json:"code"`
	Details *interface{} `json:"details,omitempty"`
	Message *string      `json:"message,omitempty"`
}

FlashStartErrorBody defines model for FlashStartErrorBody.

type ForbiddenResponse 

type ForbiddenResponse = FlashStartErrorBody

ForbiddenResponse defines model for Forbidden.

type GetCustomersReportDashboardResponse 

type GetCustomersReportDashboardResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]struct {
		Allowed        float32 `json:"allowed"`
		Blocked        float32 `json:"blocked"`
		OrganizationId string  `json:"organizationId"`
		Requests       float32 `json:"requests"`
		Unresolved     float32 `json:"unresolved"`
	}
	JSON401 *UnauthorizedResponse
	JSON403 *ForbiddenResponse
	JSON404 *NotFoundResponse
	JSON500 *ServerErrorResponse
}

func ParseGetCustomersReportDashboardResponse 

func ParseGetCustomersReportDashboardResponse(rsp *http.Response) (*GetCustomersReportDashboardResponse, error)

ParseGetCustomersReportDashboardResponse parses an HTTP response from a GetCustomersReportDashboardWithResponse call

func (GetCustomersReportDashboardResponse) Status 

func (r GetCustomersReportDashboardResponse) Status() string

Status returns HTTPResponse.Status

func (GetCustomersReportDashboardResponse) StatusCode 

func (r GetCustomersReportDashboardResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetHistoricalDnsLogs200Action 

type GetHistoricalDnsLogs200Action string

type GetHistoricalDnsLogs200QueryType 

type GetHistoricalDnsLogs200QueryType string

type GetHistoricalDnsLogs200Reason 

type GetHistoricalDnsLogs200Reason string

type GetHistoricalDnsLogsParams 

type GetHistoricalDnsLogsParams struct {
	Start           time.Time                            `form:"start" json:"start"`
	End             time.Time                            `form:"end" json:"end"`
	Limit           *float32                             `form:"limit,omitempty" json:"limit,omitempty"`
	Offset          *float32                             `form:"offset,omitempty" json:"offset,omitempty"`
	Actions         *[]GetHistoricalDnsLogsParamsActions `form:"actions,omitempty" json:"actions,omitempty"`
	CategoryIds     *[]openapi_types.UUID                `form:"categoryIds,omitempty" json:"categoryIds,omitempty"`
	FqdnSearch      *string                              `form:"fqdnSearch,omitempty" json:"fqdnSearch,omitempty"`
	NetworkIds      *[]openapi_types.UUID                `form:"networkIds,omitempty" json:"networkIds,omitempty"`
	OrganizationIds *[]openapi_types.UUID                `form:"organizationIds,omitempty" json:"organizationIds,omitempty"`
	PolicyIds       *[]openapi_types.UUID                `form:"policyIds,omitempty" json:"policyIds,omitempty"`
	Reasons         *[]GetHistoricalDnsLogsParamsReasons `form:"reasons,omitempty" json:"reasons,omitempty"`
}

GetHistoricalDnsLogsParams defines parameters for GetHistoricalDnsLogs.

type GetHistoricalDnsLogsParamsActions 

type GetHistoricalDnsLogsParamsActions string

GetHistoricalDnsLogsParamsActions defines parameters for GetHistoricalDnsLogs. 

const (
	DENIED     GetHistoricalDnsLogsParamsActions = "DENIED"
	GRANTED    GetHistoricalDnsLogsParamsActions = "GRANTED"
	UNRESOLVED GetHistoricalDnsLogsParamsActions = "UNRESOLVED"
)

Defines values for GetHistoricalDnsLogsParamsActions.

type GetHistoricalDnsLogsParamsReasons 

type GetHistoricalDnsLogsParamsReasons string

GetHistoricalDnsLogsParamsReasons defines parameters for GetHistoricalDnsLogs. 

const (
	ALLOWLIST             GetHistoricalDnsLogsParamsReasons = "ALLOW_LIST"
	BINGSAFESEARCH        GetHistoricalDnsLogsParamsReasons = "BING_SAFESEARCH"
	BLOCKLIST             GetHistoricalDnsLogsParamsReasons = "BLOCK_LIST"
	CATEGORY              GetHistoricalDnsLogsParamsReasons = "CATEGORY"
	DUCKDCUCKGOSAFESEARCH GetHistoricalDnsLogsParamsReasons = "DUCKDCUCKGO_SAFESEARCH"
	GEOBLOCK              GetHistoricalDnsLogsParamsReasons = "GEO_BLOCK"
	GOOGLESAFESEARCH      GetHistoricalDnsLogsParamsReasons = "GOOGLE_SAFESEARCH"
	IPBLOCK               GetHistoricalDnsLogsParamsReasons = "IP_BLOCK"
	IPREMOVED             GetHistoricalDnsLogsParamsReasons = "IP_REMOVED"
	NOPOLICY              GetHistoricalDnsLogsParamsReasons = "NO_POLICY"
	YOUTUBESAFESEARCH     GetHistoricalDnsLogsParamsReasons = "YOUTUBE_SAFESEARCH"
)

Defines values for GetHistoricalDnsLogsParamsReasons.

type GetHistoricalDnsLogsResponse 

type GetHistoricalDnsLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]struct {
		Action                   GetHistoricalDnsLogs200Action    `json:"action"`
		CategoryCode             string                           `json:"categoryCode"`
		CountryCode              *string                          `json:"countryCode,omitempty"`
		EdnsTag                  *string                          `json:"ednsTag"`
		FullyQualifiedDomainName string                           `json:"fullyQualifiedDomainName"`
		NetworkId                string                           `json:"networkId"`
		OrganizationId           string                           `json:"organizationId"`
		PolicyId                 string                           `json:"policyId"`
		QueryType                GetHistoricalDnsLogs200QueryType `json:"queryType"`
		Reason                   GetHistoricalDnsLogs200Reason    `json:"reason"`
		ServerId                 string                           `json:"serverId"`
		SourceIpAddress          string                           `json:"sourceIpAddress"`
		Timestamp                time.Time                        `json:"timestamp"`
	}
	JSON401 *UnauthorizedResponse
	JSON403 *ForbiddenResponse
	JSON404 *NotFoundResponse
	JSON422 *BadRequestResponse
	JSON500 *ServerErrorResponse
}

func ParseGetHistoricalDnsLogsResponse 

func ParseGetHistoricalDnsLogsResponse(rsp *http.Response) (*GetHistoricalDnsLogsResponse, error)

ParseGetHistoricalDnsLogsResponse parses an HTTP response from a GetHistoricalDnsLogsWithResponse call

func (GetHistoricalDnsLogsResponse) Status 

func (r GetHistoricalDnsLogsResponse) Status() string

Status returns HTTPResponse.Status

func (GetHistoricalDnsLogsResponse) StatusCode 

func (r GetHistoricalDnsLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetStatistics200FiltersGranularity 

type GetStatistics200FiltersGranularity string

type GetStatistics200FiltersMetric 

type GetStatistics200FiltersMetric string

type GetStatistics200FiltersProtectionModule 

type GetStatistics200FiltersProtectionModule string

type GetStatistics200FiltersReason 

type GetStatistics200FiltersReason string

type GetStatisticsParams 

type GetStatisticsParams struct {
	Start           time.Time                       `form:"start" json:"start"`
	End             time.Time                       `form:"end" json:"end"`
	Granularity     *GetStatisticsParamsGranularity `form:"granularity,omitempty" json:"granularity,omitempty"`
	NetworkIds      *[]openapi_types.UUID           `form:"networkIds,omitempty" json:"networkIds,omitempty"`
	OrganizationIds *[]openapi_types.UUID           `form:"organizationIds,omitempty" json:"organizationIds,omitempty"`
	PolicyIds       *[]openapi_types.UUID           `form:"policyIds,omitempty" json:"policyIds,omitempty"`
}

GetStatisticsParams defines parameters for GetStatistics.

type GetStatisticsParamsGranularity 

type GetStatisticsParamsGranularity string

GetStatisticsParamsGranularity defines parameters for GetStatistics. 

const (
	Daily   GetStatisticsParamsGranularity = "daily"
	Hourly  GetStatisticsParamsGranularity = "hourly"
	Monthly GetStatisticsParamsGranularity = "monthly"
)

Defines values for GetStatisticsParamsGranularity.

type GetStatisticsResponse 

type GetStatisticsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Filters struct {
			CategoryIds      *[]openapi_types.UUID                    `json:"categoryIds,omitempty"`
			End              time.Time                                `json:"end"`
			Granularity      *GetStatistics200FiltersGranularity      `json:"granularity,omitempty"`
			Limit            *float32                                 `json:"limit,omitempty"`
			Metric           *GetStatistics200FiltersMetric           `json:"metric,omitempty"`
			NetworkIds       *[]openapi_types.UUID                    `json:"networkIds,omitempty"`
			OrganizationIds  *[]openapi_types.UUID                    `json:"organizationIds,omitempty"`
			PolicyIds        *[]openapi_types.UUID                    `json:"policyIds,omitempty"`
			ProtectionModule *GetStatistics200FiltersProtectionModule `json:"protectionModule,omitempty"`
			Reason           *GetStatistics200FiltersReason           `json:"reason,omitempty"`
			Start            time.Time                                `json:"start"`
		} `json:"filters"`
		Intervals []struct {
			Allowed    float32   `json:"allowed"`
			Blocked    float32   `json:"blocked"`
			End        time.Time `json:"end"`
			Requests   float32   `json:"requests"`
			Start      time.Time `json:"start"`
			Unresolved float32   `json:"unresolved"`
		} `json:"intervals"`
		Statistics struct {
			Allowed    float32 `json:"allowed"`
			Blocked    float32 `json:"blocked"`
			Requests   float32 `json:"requests"`
			Unresolved float32 `json:"unresolved"`
		} `json:"statistics"`
	}
	JSON401 *UnauthorizedResponse
	JSON403 *ForbiddenResponse
	JSON404 *NotFoundResponse
	JSON422 *BadRequestResponse
	JSON500 *ServerErrorResponse
}

func ParseGetStatisticsResponse 

func ParseGetStatisticsResponse(rsp *http.Response) (*GetStatisticsResponse, error)

ParseGetStatisticsResponse parses an HTTP response from a GetStatisticsWithResponse call

func (GetStatisticsResponse) Status 

func (r GetStatisticsResponse) Status() string

Status returns HTTPResponse.Status

func (GetStatisticsResponse) StatusCode 

func (r GetStatisticsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTopCategories200FiltersGranularity 

type GetTopCategories200FiltersGranularity string

type GetTopCategories200FiltersMetric 

type GetTopCategories200FiltersMetric string

type GetTopCategories200FiltersProtectionModule 

type GetTopCategories200FiltersProtectionModule string

type GetTopCategories200FiltersReason 

type GetTopCategories200FiltersReason string

type GetTopCategoriesParams 

type GetTopCategoriesParams struct {
	Start            time.Time                               `form:"start" json:"start"`
	End              time.Time                               `form:"end" json:"end"`
	Metric           *GetTopCategoriesParamsMetric           `form:"metric,omitempty" json:"metric,omitempty"`
	Limit            *float32                                `form:"limit,omitempty" json:"limit,omitempty"`
	CategoryIds      *[]openapi_types.UUID                   `form:"categoryIds,omitempty" json:"categoryIds,omitempty"`
	NetworkIds       *[]openapi_types.UUID                   `form:"networkIds,omitempty" json:"networkIds,omitempty"`
	OrganizationIds  *[]openapi_types.UUID                   `form:"organizationIds,omitempty" json:"organizationIds,omitempty"`
	PolicyIds        *[]openapi_types.UUID                   `form:"policyIds,omitempty" json:"policyIds,omitempty"`
	ProtectionModule *GetTopCategoriesParamsProtectionModule `form:"protectionModule,omitempty" json:"protectionModule,omitempty"`
	Reason           *GetTopCategoriesParamsReason           `form:"reason,omitempty" json:"reason,omitempty"`
}

GetTopCategoriesParams defines parameters for GetTopCategories.

type GetTopCategoriesParamsMetric 

type GetTopCategoriesParamsMetric string

GetTopCategoriesParamsMetric defines parameters for GetTopCategories. 

const (
	GetTopCategoriesParamsMetricAllowed    GetTopCategoriesParamsMetric = "allowed"
	GetTopCategoriesParamsMetricBlocked    GetTopCategoriesParamsMetric = "blocked"
	GetTopCategoriesParamsMetricRequests   GetTopCategoriesParamsMetric = "requests"
	GetTopCategoriesParamsMetricUnresolved GetTopCategoriesParamsMetric = "unresolved"
)

Defines values for GetTopCategoriesParamsMetric.

type GetTopCategoriesParamsProtectionModule 

type GetTopCategoriesParamsProtectionModule string

GetTopCategoriesParamsProtectionModule defines parameters for GetTopCategories. 

const (
	GetTopCategoriesParamsProtectionModuleAppBlocker        GetTopCategoriesParamsProtectionModule = "app_blocker"
	GetTopCategoriesParamsProtectionModuleContentFilter     GetTopCategoriesParamsProtectionModule = "content_filter"
	GetTopCategoriesParamsProtectionModuleMalwareProtection GetTopCategoriesParamsProtectionModule = "malware_protection"
)

Defines values for GetTopCategoriesParamsProtectionModule.

type GetTopCategoriesParamsReason 

type GetTopCategoriesParamsReason string

GetTopCategoriesParamsReason defines parameters for GetTopCategories. 

const (
	GetTopCategoriesParamsReasonIpBlocker GetTopCategoriesParamsReason = "ip_blocker"
)

Defines values for GetTopCategoriesParamsReason.

type GetTopCategoriesResponse 

type GetTopCategoriesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Categories []struct {
			Allowed    float32 `json:"allowed"`
			Blocked    float32 `json:"blocked"`
			Category   string  `json:"category"`
			Requests   float32 `json:"requests"`
			Unresolved float32 `json:"unresolved"`
		} `json:"categories"`
		Filters struct {
			CategoryIds      *[]openapi_types.UUID                       `json:"categoryIds,omitempty"`
			End              time.Time                                   `json:"end"`
			Granularity      *GetTopCategories200FiltersGranularity      `json:"granularity,omitempty"`
			Limit            *float32                                    `json:"limit,omitempty"`
			Metric           *GetTopCategories200FiltersMetric           `json:"metric,omitempty"`
			NetworkIds       *[]openapi_types.UUID                       `json:"networkIds,omitempty"`
			OrganizationIds  *[]openapi_types.UUID                       `json:"organizationIds,omitempty"`
			PolicyIds        *[]openapi_types.UUID                       `json:"policyIds,omitempty"`
			ProtectionModule *GetTopCategories200FiltersProtectionModule `json:"protectionModule,omitempty"`
			Reason           *GetTopCategories200FiltersReason           `json:"reason,omitempty"`
			Start            time.Time                                   `json:"start"`
		} `json:"filters"`
	}
	JSON401 *UnauthorizedResponse
	JSON403 *ForbiddenResponse
	JSON404 *NotFoundResponse
	JSON422 *BadRequestResponse
	JSON500 *ServerErrorResponse
}

func ParseGetTopCategoriesResponse 

func ParseGetTopCategoriesResponse(rsp *http.Response) (*GetTopCategoriesResponse, error)

ParseGetTopCategoriesResponse parses an HTTP response from a GetTopCategoriesWithResponse call

func (GetTopCategoriesResponse) Status 

func (r GetTopCategoriesResponse) Status() string

Status returns HTTPResponse.Status

func (GetTopCategoriesResponse) StatusCode 

func (r GetTopCategoriesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTopDomains200FiltersGranularity 

type GetTopDomains200FiltersGranularity string

type GetTopDomains200FiltersMetric 

type GetTopDomains200FiltersMetric string

type GetTopDomains200FiltersProtectionModule 

type GetTopDomains200FiltersProtectionModule string

type GetTopDomains200FiltersReason 

type GetTopDomains200FiltersReason string

type GetTopDomainsByCategory200FiltersGranularity 

type GetTopDomainsByCategory200FiltersGranularity string

type GetTopDomainsByCategory200FiltersMetric 

type GetTopDomainsByCategory200FiltersMetric string

type GetTopDomainsByCategory200FiltersProtectionModule 

type GetTopDomainsByCategory200FiltersProtectionModule string

type GetTopDomainsByCategory200FiltersReason 

type GetTopDomainsByCategory200FiltersReason string

type GetTopDomainsByCategoryParams 

type GetTopDomainsByCategoryParams struct {
	Start            time.Time                                      `form:"start" json:"start"`
	End              time.Time                                      `form:"end" json:"end"`
	CategoryIds      []openapi_types.UUID                           `form:"categoryIds" json:"categoryIds"`
	Metric           *GetTopDomainsByCategoryParamsMetric           `form:"metric,omitempty" json:"metric,omitempty"`
	Limit            *float32                                       `form:"limit,omitempty" json:"limit,omitempty"`
	NetworkIds       *[]openapi_types.UUID                          `form:"networkIds,omitempty" json:"networkIds,omitempty"`
	OrganizationIds  *[]openapi_types.UUID                          `form:"organizationIds,omitempty" json:"organizationIds,omitempty"`
	PolicyIds        *[]openapi_types.UUID                          `form:"policyIds,omitempty" json:"policyIds,omitempty"`
	ProtectionModule *GetTopDomainsByCategoryParamsProtectionModule `form:"protectionModule,omitempty" json:"protectionModule,omitempty"`
	Reason           *GetTopDomainsByCategoryParamsReason           `form:"reason,omitempty" json:"reason,omitempty"`
}

GetTopDomainsByCategoryParams defines parameters for GetTopDomainsByCategory.

type GetTopDomainsByCategoryParamsMetric 

type GetTopDomainsByCategoryParamsMetric string

GetTopDomainsByCategoryParamsMetric defines parameters for GetTopDomainsByCategory. 

const (
	GetTopDomainsByCategoryParamsMetricAllowed    GetTopDomainsByCategoryParamsMetric = "allowed"
	GetTopDomainsByCategoryParamsMetricBlocked    GetTopDomainsByCategoryParamsMetric = "blocked"
	GetTopDomainsByCategoryParamsMetricRequests   GetTopDomainsByCategoryParamsMetric = "requests"
	GetTopDomainsByCategoryParamsMetricUnresolved GetTopDomainsByCategoryParamsMetric = "unresolved"
)

Defines values for GetTopDomainsByCategoryParamsMetric.

type GetTopDomainsByCategoryParamsProtectionModule 

type GetTopDomainsByCategoryParamsProtectionModule string

GetTopDomainsByCategoryParamsProtectionModule defines parameters for GetTopDomainsByCategory. 

const (
	GetTopDomainsByCategoryParamsProtectionModuleAppBlocker        GetTopDomainsByCategoryParamsProtectionModule = "app_blocker"
	GetTopDomainsByCategoryParamsProtectionModuleContentFilter     GetTopDomainsByCategoryParamsProtectionModule = "content_filter"
	GetTopDomainsByCategoryParamsProtectionModuleMalwareProtection GetTopDomainsByCategoryParamsProtectionModule = "malware_protection"
)

Defines values for GetTopDomainsByCategoryParamsProtectionModule.

type GetTopDomainsByCategoryParamsReason 

type GetTopDomainsByCategoryParamsReason string

GetTopDomainsByCategoryParamsReason defines parameters for GetTopDomainsByCategory. 

const (
	GetTopDomainsByCategoryParamsReasonIpBlocker GetTopDomainsByCategoryParamsReason = "ip_blocker"
)

Defines values for GetTopDomainsByCategoryParamsReason.

type GetTopDomainsByCategoryResponse 

type GetTopDomainsByCategoryResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		DomainsByCategory []struct {
			Category string `json:"category"`
			Domains  []struct {
				Allowed    float32 `json:"allowed"`
				Blocked    float32 `json:"blocked"`
				Domain     string  `json:"domain"`
				Requests   float32 `json:"requests"`
				Unresolved float32 `json:"unresolved"`
			} `json:"domains"`
		} `json:"domainsByCategory"`
		Filters struct {
			CategoryIds      *[]openapi_types.UUID                              `json:"categoryIds,omitempty"`
			End              time.Time                                          `json:"end"`
			Granularity      *GetTopDomainsByCategory200FiltersGranularity      `json:"granularity,omitempty"`
			Limit            *float32                                           `json:"limit,omitempty"`
			Metric           *GetTopDomainsByCategory200FiltersMetric           `json:"metric,omitempty"`
			NetworkIds       *[]openapi_types.UUID                              `json:"networkIds,omitempty"`
			OrganizationIds  *[]openapi_types.UUID                              `json:"organizationIds,omitempty"`
			PolicyIds        *[]openapi_types.UUID                              `json:"policyIds,omitempty"`
			ProtectionModule *GetTopDomainsByCategory200FiltersProtectionModule `json:"protectionModule,omitempty"`
			Reason           *GetTopDomainsByCategory200FiltersReason           `json:"reason,omitempty"`
			Start            time.Time                                          `json:"start"`
		} `json:"filters"`
	}
	JSON401 *UnauthorizedResponse
	JSON403 *ForbiddenResponse
	JSON404 *NotFoundResponse
	JSON422 *BadRequestResponse
	JSON500 *ServerErrorResponse
}

func ParseGetTopDomainsByCategoryResponse 

func ParseGetTopDomainsByCategoryResponse(rsp *http.Response) (*GetTopDomainsByCategoryResponse, error)

ParseGetTopDomainsByCategoryResponse parses an HTTP response from a GetTopDomainsByCategoryWithResponse call

func (GetTopDomainsByCategoryResponse) Status 

func (r GetTopDomainsByCategoryResponse) Status() string

Status returns HTTPResponse.Status

func (GetTopDomainsByCategoryResponse) StatusCode 

func (r GetTopDomainsByCategoryResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetTopDomainsParams 

type GetTopDomainsParams struct {
	Start            time.Time                            `form:"start" json:"start"`
	End              time.Time                            `form:"end" json:"end"`
	Metric           *GetTopDomainsParamsMetric           `form:"metric,omitempty" json:"metric,omitempty"`
	Limit            *float32                             `form:"limit,omitempty" json:"limit,omitempty"`
	CategoryIds      *[]openapi_types.UUID                `form:"categoryIds,omitempty" json:"categoryIds,omitempty"`
	NetworkIds       *[]openapi_types.UUID                `form:"networkIds,omitempty" json:"networkIds,omitempty"`
	OrganizationIds  *[]openapi_types.UUID                `form:"organizationIds,omitempty" json:"organizationIds,omitempty"`
	PolicyIds        *[]openapi_types.UUID                `form:"policyIds,omitempty" json:"policyIds,omitempty"`
	ProtectionModule *GetTopDomainsParamsProtectionModule `form:"protectionModule,omitempty" json:"protectionModule,omitempty"`
	Reason           *GetTopDomainsParamsReason           `form:"reason,omitempty" json:"reason,omitempty"`
}

GetTopDomainsParams defines parameters for GetTopDomains.

type GetTopDomainsParamsMetric 

type GetTopDomainsParamsMetric string

GetTopDomainsParamsMetric defines parameters for GetTopDomains. 

const (
	Allowed    GetTopDomainsParamsMetric = "allowed"
	Blocked    GetTopDomainsParamsMetric = "blocked"
	Requests   GetTopDomainsParamsMetric = "requests"
	Unresolved GetTopDomainsParamsMetric = "unresolved"
)

Defines values for GetTopDomainsParamsMetric.

type GetTopDomainsParamsProtectionModule 

type GetTopDomainsParamsProtectionModule string

GetTopDomainsParamsProtectionModule defines parameters for GetTopDomains. 

const (
	AppBlocker        GetTopDomainsParamsProtectionModule = "app_blocker"
	ContentFilter     GetTopDomainsParamsProtectionModule = "content_filter"
	MalwareProtection GetTopDomainsParamsProtectionModule = "malware_protection"
)

Defines values for GetTopDomainsParamsProtectionModule.

type GetTopDomainsParamsReason 

type GetTopDomainsParamsReason string

GetTopDomainsParamsReason defines parameters for GetTopDomains. 

const (
	IpBlocker GetTopDomainsParamsReason = "ip_blocker"
)

Defines values for GetTopDomainsParamsReason.

type GetTopDomainsResponse 

type GetTopDomainsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		Domains []struct {
			Allowed    float32 `json:"allowed"`
			Blocked    float32 `json:"blocked"`
			Domain     string  `json:"domain"`
			Requests   float32 `json:"requests"`
			Unresolved float32 `json:"unresolved"`
		} `json:"domains"`
		Filters struct {
			CategoryIds      *[]openapi_types.UUID                    `json:"categoryIds,omitempty"`
			End              time.Time                                `json:"end"`
			Granularity      *GetTopDomains200FiltersGranularity      `json:"granularity,omitempty"`
			Limit            *float32                                 `json:"limit,omitempty"`
			Metric           *GetTopDomains200FiltersMetric           `json:"metric,omitempty"`
			NetworkIds       *[]openapi_types.UUID                    `json:"networkIds,omitempty"`
			OrganizationIds  *[]openapi_types.UUID                    `json:"organizationIds,omitempty"`
			PolicyIds        *[]openapi_types.UUID                    `json:"policyIds,omitempty"`
			ProtectionModule *GetTopDomains200FiltersProtectionModule `json:"protectionModule,omitempty"`
			Reason           *GetTopDomains200FiltersReason           `json:"reason,omitempty"`
			Start            time.Time                                `json:"start"`
		} `json:"filters"`
	}
	JSON401 *UnauthorizedResponse
	JSON403 *ForbiddenResponse
	JSON404 *NotFoundResponse
	JSON422 *BadRequestResponse
	JSON500 *ServerErrorResponse
}

func ParseGetTopDomainsResponse 

func ParseGetTopDomainsResponse(rsp *http.Response) (*GetTopDomainsResponse, error)

ParseGetTopDomainsResponse parses an HTTP response from a GetTopDomainsWithResponse call

func (GetTopDomainsResponse) Status 

func (r GetTopDomainsResponse) Status() string

Status returns HTTPResponse.Status

func (GetTopDomainsResponse) StatusCode 

func (r GetTopDomainsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer 

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type MissingCredentialsErrorBody 

type MissingCredentialsErrorBody struct {
	Message string `json:"message"`
}

MissingCredentialsErrorBody defines model for MissingCredentialsErrorBody.

type NotFoundResponse 

type NotFoundResponse = FlashStartErrorBody

NotFoundResponse defines model for NotFound.

type RequestEditorFn 

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type ServerErrorResponse 

type ServerErrorResponse = FlashStartErrorBody

ServerErrorResponse defines model for ServerError.

type UnauthorizedResponse 

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

UnauthorizedResponse defines model for Unauthorized.

func (UnauthorizedResponse) AsFlashStartErrorBody 

func (t UnauthorizedResponse) AsFlashStartErrorBody() (FlashStartErrorBody, error)

AsFlashStartErrorBody returns the union data inside the UnauthorizedResponse as a FlashStartErrorBody

func (UnauthorizedResponse) AsMissingCredentialsErrorBody 

func (t UnauthorizedResponse) AsMissingCredentialsErrorBody() (MissingCredentialsErrorBody, error)

AsMissingCredentialsErrorBody returns the union data inside the UnauthorizedResponse as a MissingCredentialsErrorBody

func (*UnauthorizedResponse) FromFlashStartErrorBody 

func (t *UnauthorizedResponse) FromFlashStartErrorBody(v FlashStartErrorBody) error

FromFlashStartErrorBody overwrites any union data inside the UnauthorizedResponse as the provided FlashStartErrorBody

func (*UnauthorizedResponse) FromMissingCredentialsErrorBody 

func (t *UnauthorizedResponse) FromMissingCredentialsErrorBody(v MissingCredentialsErrorBody) error

FromMissingCredentialsErrorBody overwrites any union data inside the UnauthorizedResponse as the provided MissingCredentialsErrorBody

func (UnauthorizedResponse) MarshalJSON 

func (t UnauthorizedResponse) MarshalJSON() ([]byte, error)

func (*UnauthorizedResponse) MergeFlashStartErrorBody 

func (t *UnauthorizedResponse) MergeFlashStartErrorBody(v FlashStartErrorBody) error

MergeFlashStartErrorBody performs a merge with any union data inside the UnauthorizedResponse, using the provided FlashStartErrorBody

func (*UnauthorizedResponse) MergeMissingCredentialsErrorBody 

func (t *UnauthorizedResponse) MergeMissingCredentialsErrorBody(v MissingCredentialsErrorBody) error

MergeMissingCredentialsErrorBody performs a merge with any union data inside the UnauthorizedResponse, using the provided MissingCredentialsErrorBody

func (*UnauthorizedResponse) UnmarshalJSON 

func (t *UnauthorizedResponse) UnmarshalJSON(b []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.