models

package
v1.13.0 Latest Latest
Warning

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

 Go to latest Published: Nov 30, 2020 License: AGPL-3.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AnalysisType 

type AnalysisType string

AnalysisType analysis type

swagger:model AnalysisType 

const (

	// AnalysisTypeDATAMODEL captures enum value "DATAMODEL"
	AnalysisTypeDATAMODEL AnalysisType = "DATAMODEL"

	// AnalysisTypeGLOBAL captures enum value "GLOBAL"
	AnalysisTypeGLOBAL AnalysisType = "GLOBAL"

	// AnalysisTypePOLICY captures enum value "POLICY"
	AnalysisTypePOLICY AnalysisType = "POLICY"

	// AnalysisTypeRULE captures enum value "RULE"
	AnalysisTypeRULE AnalysisType = "RULE"
)

func (AnalysisType) Validate 

func (m AnalysisType) Validate(formats strfmt.Registry) error

Validate validates this analysis type

type AutoRemediationID 

type AutoRemediationID string

AutoRemediationID When a resource fails the policy, trigger the remediation with this ID

swagger:model autoRemediationId

func (AutoRemediationID) Validate 

func (m AutoRemediationID) Validate(formats strfmt.Registry) error

Validate validates this auto remediation Id

type AutoRemediationParameters 

type AutoRemediationParameters map[string]string

AutoRemediationParameters Configuration parameters passed to the remediation handler

swagger:model autoRemediationParameters

func (AutoRemediationParameters) Validate 

func (m AutoRemediationParameters) Validate(formats strfmt.Registry) error

Validate validates this auto remediation parameters

type Base64zipfile 

type Base64zipfile string

Base64zipfile Base64-encoded zipfile with a policy bundle

swagger:model base64zipfile

func (Base64zipfile) Validate 

func (m Base64zipfile) Validate(formats strfmt.Registry) error

Validate validates this base64zipfile

type Body 

type Body string

Body Python policy source code

swagger:model body

func (Body) Validate 

func (m Body) Validate(formats strfmt.Registry) error

Validate validates this body

type BulkUpload 

type BulkUpload struct {

	// data
	// Required: true
	Data Base64zipfile `json:"data"`

	// user Id
	// Required: true
	UserID UserID `json:"userId"`
}

BulkUpload bulk upload

swagger:model BulkUpload

func (*BulkUpload) MarshalBinary 

func (m *BulkUpload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BulkUpload) UnmarshalBinary 

func (m *BulkUpload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BulkUpload) Validate 

func (m *BulkUpload) Validate(formats strfmt.Registry) error

Validate validates this bulk upload

type BulkUploadResult 

type BulkUploadResult struct {

	// modified data models
	// Required: true
	// Minimum: 0
	ModifiedDataModels *int64 `json:"modifiedDataModels"`

	// modified globals
	// Required: true
	// Minimum: 0
	ModifiedGlobals *int64 `json:"modifiedGlobals"`

	// modified policies
	// Required: true
	// Minimum: 0
	ModifiedPolicies *int64 `json:"modifiedPolicies"`

	// modified rules
	// Required: true
	// Minimum: 0
	ModifiedRules *int64 `json:"modifiedRules"`

	// new data models
	// Required: true
	// Minimum: 0
	NewDataModels *int64 `json:"newDataModels"`

	// new globals
	// Required: true
	// Minimum: 0
	NewGlobals *int64 `json:"newGlobals"`

	// new policies
	// Required: true
	// Minimum: 0
	NewPolicies *int64 `json:"newPolicies"`

	// new rules
	// Required: true
	// Minimum: 0
	NewRules *int64 `json:"newRules"`

	// total data models
	// Required: true
	// Minimum: 0
	TotalDataModels *int64 `json:"totalDataModels"`

	// total globals
	// Required: true
	// Minimum: 0
	TotalGlobals *int64 `json:"totalGlobals"`

	// total policies
	// Required: true
	// Minimum: 0
	TotalPolicies *int64 `json:"totalPolicies"`

	// total rules
	// Required: true
	// Minimum: 0
	TotalRules *int64 `json:"totalRules"`
}

BulkUploadResult bulk upload result

swagger:model BulkUploadResult

func (*BulkUploadResult) MarshalBinary 

func (m *BulkUploadResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BulkUploadResult) UnmarshalBinary 

func (m *BulkUploadResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BulkUploadResult) Validate 

func (m *BulkUploadResult) Validate(formats strfmt.Registry) error

Validate validates this bulk upload result

type ComplianceStatus 

type ComplianceStatus string

ComplianceStatus Pass/fail compliance status

swagger:model complianceStatus 

const (

	// ComplianceStatusERROR captures enum value "ERROR"
	ComplianceStatusERROR ComplianceStatus = "ERROR"

	// ComplianceStatusFAIL captures enum value "FAIL"
	ComplianceStatusFAIL ComplianceStatus = "FAIL"

	// ComplianceStatusPASS captures enum value "PASS"
	ComplianceStatusPASS ComplianceStatus = "PASS"
)

func (ComplianceStatus) Validate 

func (m ComplianceStatus) Validate(formats strfmt.Registry) error

Validate validates this compliance status

type DataModel added in v1.13.0 

type DataModel struct {

	// body
	Body Body `json:"body,omitempty"`

	// created at
	// Required: true
	// Format: date-time
	CreatedAt ModifyTime `json:"createdAt"`

	// created by
	// Required: true
	CreatedBy UserID `json:"createdBy"`

	// description
	Description Description `json:"description,omitempty"`

	// display name
	DisplayName DisplayName `json:"displayName,omitempty"`

	// enabled
	// Required: true
	Enabled Enabled `json:"enabled"`

	// id
	// Required: true
	ID ID `json:"id"`

	// last modified
	// Required: true
	// Format: date-time
	LastModified ModifyTime `json:"lastModified"`

	// last modified by
	// Required: true
	LastModifiedBy UserID `json:"lastModifiedBy"`

	// log types
	// Required: true
	LogTypes TypeSet `json:"logTypes"`

	// mappings
	// Required: true
	Mappings DataModelMappings `json:"mappings"`

	// version Id
	// Required: true
	VersionID VersionID `json:"versionId"`
}

DataModel data model

swagger:model DataModel

func (*DataModel) MarshalBinary added in v1.13.0 

func (m *DataModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DataModel) UnmarshalBinary added in v1.13.0 

func (m *DataModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DataModel) Validate added in v1.13.0 

func (m *DataModel) Validate(formats strfmt.Registry) error

Validate validates this data model

type DataModelList added in v1.13.0 

type DataModelList struct {

	// data models
	// Required: true
	DataModels []*DataModelSummary `json:"dataModels"`

	// paging
	// Required: true
	Paging *Paging `json:"paging"`
}

DataModelList data model list

swagger:model DataModelList

func (*DataModelList) MarshalBinary added in v1.13.0 

func (m *DataModelList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DataModelList) UnmarshalBinary added in v1.13.0 

func (m *DataModelList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DataModelList) Validate added in v1.13.0 

func (m *DataModelList) Validate(formats strfmt.Registry) error

Validate validates this data model list

type DataModelMapping added in v1.13.0 

type DataModelMapping struct {

	// method
	Method DataModelMethod `json:"method,omitempty"`

	// name
	// Required: true
	Name DataModelName `json:"name"`

	// path
	Path DataModelPath `json:"path,omitempty"`
}

DataModelMapping data model mapping

swagger:model DataModelMapping

func (*DataModelMapping) MarshalBinary added in v1.13.0 

func (m *DataModelMapping) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DataModelMapping) UnmarshalBinary added in v1.13.0 

func (m *DataModelMapping) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DataModelMapping) Validate added in v1.13.0 

func (m *DataModelMapping) Validate(formats strfmt.Registry) error

Validate validates this data model mapping

type DataModelMappings added in v1.13.0 

type DataModelMappings []*DataModelMapping

DataModelMappings yml schema mappings

swagger:model DataModelMappings

func (DataModelMappings) Validate added in v1.13.0 

func (m DataModelMappings) Validate(formats strfmt.Registry) error

Validate validates this data model mappings

type DataModelMethod added in v1.13.0 

type DataModelMethod string

DataModelMethod method name used to map data in a DataModel

swagger:model dataModelMethod

func (DataModelMethod) Validate added in v1.13.0 

func (m DataModelMethod) Validate(formats strfmt.Registry) error

Validate validates this data model method

type DataModelName added in v1.13.0 

type DataModelName string

DataModelName standardized field name used in DataModel

swagger:model dataModelName

func (DataModelName) Validate added in v1.13.0 

func (m DataModelName) Validate(formats strfmt.Registry) error

Validate validates this data model name

type DataModelPath added in v1.13.0 

type DataModelPath string

DataModelPath path name used to map data in a DataModel

swagger:model dataModelPath

func (DataModelPath) Validate added in v1.13.0 

func (m DataModelPath) Validate(formats strfmt.Registry) error

Validate validates this data model path

type DataModelSummary added in v1.13.0 

type DataModelSummary struct {

	// enabled
	Enabled Enabled `json:"enabled,omitempty"`

	// id
	// Required: true
	ID ID `json:"id"`

	// last modified
	// Required: true
	// Format: date-time
	LastModified ModifyTime `json:"lastModified"`

	// log types
	LogTypes TypeSet `json:"logTypes,omitempty"`
}

DataModelSummary data model summary

swagger:model DataModelSummary

func (*DataModelSummary) MarshalBinary added in v1.13.0 

func (m *DataModelSummary) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DataModelSummary) UnmarshalBinary added in v1.13.0 

func (m *DataModelSummary) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DataModelSummary) Validate added in v1.13.0 

func (m *DataModelSummary) Validate(formats strfmt.Registry) error

Validate validates this data model summary

type DedupPeriodMinutes added in v1.0.0 

type DedupPeriodMinutes int64

DedupPeriodMinutes The time in minutes for which we deduplicate events when generating alerts for log analysis

swagger:model dedupPeriodMinutes

func (DedupPeriodMinutes) Validate added in v1.0.0 

func (m DedupPeriodMinutes) Validate(formats strfmt.Registry) error

Validate validates this dedup period minutes

type DeleteEntry 

type DeleteEntry struct {

	// id
	// Required: true
	ID ID `json:"id"`
}

DeleteEntry delete entry

swagger:model DeleteEntry

func (*DeleteEntry) MarshalBinary 

func (m *DeleteEntry) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DeleteEntry) UnmarshalBinary 

func (m *DeleteEntry) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DeleteEntry) Validate 

func (m *DeleteEntry) Validate(formats strfmt.Registry) error

Validate validates this delete entry

type DeletePolicies 

type DeletePolicies struct {

	// policies
	// Required: true
	// Max Items: 1000
	// Min Items: 1
	// Unique: true
	Policies []*DeleteEntry `json:"policies"`
}

DeletePolicies delete policies

swagger:model DeletePolicies

func (*DeletePolicies) MarshalBinary 

func (m *DeletePolicies) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DeletePolicies) UnmarshalBinary 

func (m *DeletePolicies) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DeletePolicies) Validate 

func (m *DeletePolicies) Validate(formats strfmt.Registry) error

Validate validates this delete policies

type Description 

type Description string

Description Summary of the policy and its purpose

swagger:model description

func (Description) Validate 

func (m Description) Validate(formats strfmt.Registry) error

Validate validates this description

type DisplayName 

type DisplayName string

DisplayName Optional user-friendly policy name

swagger:model displayName

func (DisplayName) Validate 

func (m DisplayName) Validate(formats strfmt.Registry) error

Validate validates this display name

type Enabled 

type Enabled bool

Enabled True if the policy is currently being evaluated

swagger:model enabled

func (Enabled) Validate 

func (m Enabled) Validate(formats strfmt.Registry) error

Validate validates this enabled

type EnabledPolicies 

type EnabledPolicies struct {

	// policies
	// Required: true
	Policies []*EnabledPolicy `json:"policies"`
}

EnabledPolicies enabled policies

swagger:model EnabledPolicies

func (*EnabledPolicies) MarshalBinary 

func (m *EnabledPolicies) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EnabledPolicies) UnmarshalBinary 

func (m *EnabledPolicies) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EnabledPolicies) Validate 

func (m *EnabledPolicies) Validate(formats strfmt.Registry) error

Validate validates this enabled policies

type EnabledPolicy 

type EnabledPolicy struct {

	// body
	Body Body `json:"body,omitempty"`

	// dedup period minutes
	DedupPeriodMinutes DedupPeriodMinutes `json:"dedupPeriodMinutes,omitempty"`

	// id
	ID ID `json:"id,omitempty"`

	// mappings
	Mappings DataModelMappings `json:"mappings,omitempty"`

	// output ids
	OutputIds OutputIds `json:"outputIds,omitempty"`

	// reports
	Reports Reports `json:"reports,omitempty"`

	// resource types
	ResourceTypes TypeSet `json:"resourceTypes,omitempty"`

	// severity
	Severity Severity `json:"severity,omitempty"`

	// suppressions
	Suppressions Suppressions `json:"suppressions,omitempty"`

	// tags
	Tags Tags `json:"tags,omitempty"`

	// version Id
	VersionID VersionID `json:"versionId,omitempty"`
}

EnabledPolicy enabled policy

swagger:model EnabledPolicy

func (*EnabledPolicy) MarshalBinary 

func (m *EnabledPolicy) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EnabledPolicy) UnmarshalBinary 

func (m *EnabledPolicy) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EnabledPolicy) Validate 

func (m *EnabledPolicy) Validate(formats strfmt.Registry) error

Validate validates this enabled policy

type Error 

type Error struct {

	// Error message
	// Required: true
	Message *string `json:"message"`
}

Error error

swagger:model Error

func (*Error) MarshalBinary 

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error) UnmarshalBinary 

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error) Validate 

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type Field added in v1.13.0 

type Field string

Field field name used to map data in a DataModel

swagger:model field

func (Field) Validate added in v1.13.0 

func (m Field) Validate(formats strfmt.Registry) error

Validate validates this field

type Global added in v1.1.0 

type Global struct {

	// body
	// Required: true
	Body Body `json:"body"`

	// created at
	// Required: true
	// Format: date-time
	CreatedAt ModifyTime `json:"createdAt"`

	// created by
	// Required: true
	CreatedBy UserID `json:"createdBy"`

	// description
	// Required: true
	Description Description `json:"description"`

	// id
	// Required: true
	ID ID `json:"id"`

	// last modified
	// Required: true
	// Format: date-time
	LastModified ModifyTime `json:"lastModified"`

	// last modified by
	// Required: true
	LastModifiedBy UserID `json:"lastModifiedBy"`

	// tags
	// Required: true
	Tags Tags `json:"tags"`

	// version Id
	// Required: true
	VersionID VersionID `json:"versionId"`
}

Global global

swagger:model Global

func (*Global) MarshalBinary added in v1.1.0 

func (m *Global) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Global) UnmarshalBinary added in v1.1.0 

func (m *Global) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Global) Validate added in v1.1.0 

func (m *Global) Validate(formats strfmt.Registry) error

Validate validates this global

type GlobalList added in v1.3.0 

type GlobalList struct {

	// globals
	// Required: true
	Globals []*GlobalSummary `json:"globals"`

	// paging
	// Required: true
	Paging *Paging `json:"paging"`
}

GlobalList global list

swagger:model GlobalList

func (*GlobalList) MarshalBinary added in v1.3.0 

func (m *GlobalList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GlobalList) UnmarshalBinary added in v1.3.0 

func (m *GlobalList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GlobalList) Validate added in v1.3.0 

func (m *GlobalList) Validate(formats strfmt.Registry) error

Validate validates this global list

type GlobalSummary added in v1.3.0 

type GlobalSummary struct {

	// id
	// Required: true
	ID ID `json:"id"`

	// last modified
	// Required: true
	// Format: date-time
	LastModified ModifyTime `json:"lastModified"`

	// tags
	// Required: true
	Tags Tags `json:"tags"`
}

GlobalSummary global summary

swagger:model GlobalSummary

func (*GlobalSummary) MarshalBinary added in v1.3.0 

func (m *GlobalSummary) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*GlobalSummary) UnmarshalBinary added in v1.3.0 

func (m *GlobalSummary) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*GlobalSummary) Validate added in v1.3.0 

func (m *GlobalSummary) Validate(formats strfmt.Registry) error

Validate validates this global summary

type ID 

type ID string

ID User-specified unique rule/policy ID

swagger:model id

func (ID) Validate 

func (m ID) Validate(formats strfmt.Registry) error

Validate validates this id

type Mapping added in v1.13.0 

type Mapping struct {

	// field
	Field Field `json:"field,omitempty"`

	// method
	Method Method `json:"method,omitempty"`

	// name
	// Required: true
	Name SourceName `json:"name"`
}

Mapping mapping

swagger:model Mapping

func (*Mapping) MarshalBinary added in v1.13.0 

func (m *Mapping) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Mapping) UnmarshalBinary added in v1.13.0 

func (m *Mapping) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Mapping) Validate added in v1.13.0 

func (m *Mapping) Validate(formats strfmt.Registry) error

Validate validates this mapping

type Mappings added in v1.13.0 

type Mappings []*Mapping

Mappings yml schema mappings

swagger:model Mappings

func (Mappings) Validate added in v1.13.0 

func (m Mappings) Validate(formats strfmt.Registry) error

Validate validates this mappings

type Method added in v1.13.0 

type Method string

Method method name used to map data in a DataModel

swagger:model method

func (Method) Validate added in v1.13.0 

func (m Method) Validate(formats strfmt.Registry) error

Validate validates this method

type ModifyTime 

type ModifyTime strfmt.DateTime

ModifyTime Policy modification timestamp

swagger:model modifyTime

func (*ModifyTime) MarshalBinary 

func (m *ModifyTime) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (ModifyTime) MarshalJSON 

func (m ModifyTime) MarshalJSON() ([]byte, error)

MarshalJSON retrieves a ModifyTime value as JSON output

func (*ModifyTime) UnmarshalBinary 

func (m *ModifyTime) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ModifyTime) UnmarshalJSON 

func (m *ModifyTime) UnmarshalJSON(b []byte) error

UnmarshalJSON sets a ModifyTime value from JSON input

func (ModifyTime) Validate 

func (m ModifyTime) Validate(formats strfmt.Registry) error

Validate validates this modify time

type OutputIds added in v1.6.0 

type OutputIds []string

OutputIds A list of destinations IDs to send an alert that overrides the severity rating triggers set in the destination itself.

swagger:model outputIds

func (OutputIds) Validate added in v1.6.0 

func (m OutputIds) Validate(formats strfmt.Registry) error

Validate validates this output ids

type Paging 

type Paging struct {

	// this page
	// Required: true
	// Minimum: 1
	ThisPage *int64 `json:"thisPage"`

	// total items
	// Required: true
	// Minimum: 1
	TotalItems *int64 `json:"totalItems"`

	// total pages
	// Required: true
	// Minimum: 1
	TotalPages *int64 `json:"totalPages"`
}

Paging paging

swagger:model Paging

func (*Paging) MarshalBinary 

func (m *Paging) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Paging) UnmarshalBinary 

func (m *Paging) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Paging) Validate 

func (m *Paging) Validate(formats strfmt.Registry) error

Validate validates this paging

type Policy 

type Policy struct {

	// auto remediation Id
	// Required: true
	AutoRemediationID AutoRemediationID `json:"autoRemediationId"`

	// auto remediation parameters
	// Required: true
	AutoRemediationParameters AutoRemediationParameters `json:"autoRemediationParameters"`

	// body
	// Required: true
	Body Body `json:"body"`

	// compliance status
	// Required: true
	ComplianceStatus ComplianceStatus `json:"complianceStatus"`

	// created at
	// Required: true
	// Format: date-time
	CreatedAt ModifyTime `json:"createdAt"`

	// created by
	// Required: true
	CreatedBy UserID `json:"createdBy"`

	// description
	// Required: true
	Description Description `json:"description"`

	// display name
	// Required: true
	DisplayName DisplayName `json:"displayName"`

	// enabled
	// Required: true
	Enabled Enabled `json:"enabled"`

	// id
	// Required: true
	ID ID `json:"id"`

	// last modified
	// Required: true
	// Format: date-time
	LastModified ModifyTime `json:"lastModified"`

	// last modified by
	// Required: true
	LastModifiedBy UserID `json:"lastModifiedBy"`

	// output ids
	// Required: true
	OutputIds OutputIds `json:"outputIds"`

	// reference
	// Required: true
	Reference Reference `json:"reference"`

	// reports
	// Required: true
	Reports Reports `json:"reports"`

	// resource types
	// Required: true
	ResourceTypes TypeSet `json:"resourceTypes"`

	// runbook
	// Required: true
	Runbook Runbook `json:"runbook"`

	// severity
	// Required: true
	Severity Severity `json:"severity"`

	// suppressions
	// Required: true
	Suppressions Suppressions `json:"suppressions"`

	// tags
	// Required: true
	Tags Tags `json:"tags"`

	// tests
	// Required: true
	Tests TestSuite `json:"tests"`

	// version Id
	// Required: true
	VersionID VersionID `json:"versionId"`
}

Policy policy

swagger:model Policy

func (*Policy) MarshalBinary 

func (m *Policy) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Policy) UnmarshalBinary 

func (m *Policy) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Policy) Validate 

func (m *Policy) Validate(formats strfmt.Registry) error

Validate validates this policy

type PolicyList 

type PolicyList struct {

	// paging
	// Required: true
	Paging *Paging `json:"paging"`

	// policies
	// Required: true
	Policies []*PolicySummary `json:"policies"`
}

PolicyList policy list

swagger:model PolicyList

func (*PolicyList) MarshalBinary 

func (m *PolicyList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PolicyList) UnmarshalBinary 

func (m *PolicyList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PolicyList) Validate 

func (m *PolicyList) Validate(formats strfmt.Registry) error

Validate validates this policy list

type PolicySummary 

type PolicySummary struct {

	// auto remediation Id
	// Required: true
	AutoRemediationID AutoRemediationID `json:"autoRemediationId"`

	// auto remediation parameters
	// Required: true
	AutoRemediationParameters AutoRemediationParameters `json:"autoRemediationParameters"`

	// compliance status
	// Required: true
	ComplianceStatus ComplianceStatus `json:"complianceStatus"`

	// display name
	// Required: true
	DisplayName DisplayName `json:"displayName"`

	// enabled
	// Required: true
	Enabled Enabled `json:"enabled"`

	// id
	// Required: true
	ID ID `json:"id"`

	// last modified
	// Required: true
	// Format: date-time
	LastModified ModifyTime `json:"lastModified"`

	// output ids
	// Required: true
	OutputIds OutputIds `json:"outputIds"`

	// reports
	// Required: true
	Reports Reports `json:"reports"`

	// resource types
	// Required: true
	ResourceTypes TypeSet `json:"resourceTypes"`

	// severity
	// Required: true
	Severity Severity `json:"severity"`

	// suppressions
	// Required: true
	Suppressions Suppressions `json:"suppressions"`

	// tags
	// Required: true
	Tags Tags `json:"tags"`

	// threshold
	Threshold Threshold `json:"threshold,omitempty"`
}

PolicySummary policy summary

swagger:model PolicySummary

func (*PolicySummary) MarshalBinary 

func (m *PolicySummary) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PolicySummary) UnmarshalBinary 

func (m *PolicySummary) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PolicySummary) Validate 

func (m *PolicySummary) Validate(formats strfmt.Registry) error

Validate validates this policy summary

type Reference 

type Reference string

Reference External documentation motivating the need for this policy

swagger:model reference

func (Reference) Validate 

func (m Reference) Validate(formats strfmt.Registry) error

Validate validates this reference

type Reports added in v1.4.0 

type Reports map[string][]string

Reports reports

swagger:model reports

func (Reports) Validate added in v1.4.0 

func (m Reports) Validate(formats strfmt.Registry) error

Validate validates this reports

type Rule 

type Rule struct {

	// body
	// Required: true
	Body Body `json:"body"`

	// created at
	// Required: true
	// Format: date-time
	CreatedAt ModifyTime `json:"createdAt"`

	// created by
	// Required: true
	CreatedBy UserID `json:"createdBy"`

	// dedup period minutes
	// Required: true
	DedupPeriodMinutes DedupPeriodMinutes `json:"dedupPeriodMinutes"`

	// description
	// Required: true
	Description Description `json:"description"`

	// display name
	// Required: true
	DisplayName DisplayName `json:"displayName"`

	// enabled
	// Required: true
	Enabled Enabled `json:"enabled"`

	// id
	// Required: true
	ID ID `json:"id"`

	// last modified
	// Required: true
	// Format: date-time
	LastModified ModifyTime `json:"lastModified"`

	// last modified by
	// Required: true
	LastModifiedBy UserID `json:"lastModifiedBy"`

	// log types
	// Required: true
	LogTypes TypeSet `json:"logTypes"`

	// output ids
	// Required: true
	OutputIds OutputIds `json:"outputIds"`

	// reference
	// Required: true
	Reference Reference `json:"reference"`

	// reports
	// Required: true
	Reports Reports `json:"reports"`

	// runbook
	// Required: true
	Runbook Runbook `json:"runbook"`

	// severity
	// Required: true
	Severity Severity `json:"severity"`

	// tags
	// Required: true
	Tags Tags `json:"tags"`

	// tests
	// Required: true
	Tests TestSuite `json:"tests"`

	// threshold
	// Required: true
	Threshold Threshold `json:"threshold"`

	// version Id
	// Required: true
	VersionID VersionID `json:"versionId"`
}

Rule rule

swagger:model Rule

func (*Rule) MarshalBinary 

func (m *Rule) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Rule) UnmarshalBinary 

func (m *Rule) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Rule) Validate 

func (m *Rule) Validate(formats strfmt.Registry) error

Validate validates this rule

type RuleList 

type RuleList struct {

	// paging
	// Required: true
	Paging *Paging `json:"paging"`

	// rules
	// Required: true
	Rules []*RuleSummary `json:"rules"`
}

RuleList rule list

swagger:model RuleList

func (*RuleList) MarshalBinary 

func (m *RuleList) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RuleList) UnmarshalBinary 

func (m *RuleList) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RuleList) Validate 

func (m *RuleList) Validate(formats strfmt.Registry) error

Validate validates this rule list

type RuleResult added in v1.12.0 

type RuleResult struct {

	// alert context error
	AlertContextError string `json:"alertContextError,omitempty"`

	// alert context output
	AlertContextOutput string `json:"alertContextOutput,omitempty"`

	// dedup error
	DedupError string `json:"dedupError,omitempty"`

	// dedup output
	DedupOutput string `json:"dedupOutput,omitempty"`

	// True if the result includes an error.
	Errored bool `json:"errored,omitempty"`

	// An error produced before running any of the rule functions, like import or syntax error.
	GenericError string `json:"genericError,omitempty"`

	// id
	ID string `json:"id,omitempty"`

	// True if the test returned the expected result. Always false if the result includes an error.
	Passed bool `json:"passed,omitempty"`

	// rule error
	RuleError string `json:"ruleError,omitempty"`

	// rule Id
	RuleID string `json:"ruleId,omitempty"`

	// rule output
	RuleOutput bool `json:"ruleOutput,omitempty"`

	// test name
	TestName string `json:"testName,omitempty"`

	// title error
	TitleError string `json:"titleError,omitempty"`

	// title output
	TitleOutput string `json:"titleOutput,omitempty"`
}

RuleResult rule result

swagger:model ruleResult

func (*RuleResult) MarshalBinary added in v1.12.0 

func (m *RuleResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RuleResult) UnmarshalBinary added in v1.12.0 

func (m *RuleResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RuleResult) Validate added in v1.12.0 

func (m *RuleResult) Validate(formats strfmt.Registry) error

Validate validates this rule result

type RuleSummary 

type RuleSummary struct {

	// display name
	// Required: true
	DisplayName DisplayName `json:"displayName"`

	// enabled
	// Required: true
	Enabled Enabled `json:"enabled"`

	// id
	// Required: true
	ID ID `json:"id"`

	// last modified
	// Required: true
	// Format: date-time
	LastModified ModifyTime `json:"lastModified"`

	// log types
	// Required: true
	LogTypes TypeSet `json:"logTypes"`

	// output ids
	// Required: true
	OutputIds OutputIds `json:"outputIds"`

	// reports
	// Required: true
	Reports Reports `json:"reports"`

	// severity
	// Required: true
	Severity Severity `json:"severity"`

	// tags
	// Required: true
	Tags Tags `json:"tags"`

	// threshold
	// Required: true
	Threshold Threshold `json:"threshold"`
}

RuleSummary rule summary

swagger:model RuleSummary

func (*RuleSummary) MarshalBinary 

func (m *RuleSummary) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RuleSummary) UnmarshalBinary 

func (m *RuleSummary) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RuleSummary) Validate 

func (m *RuleSummary) Validate(formats strfmt.Registry) error

Validate validates this rule summary

type Runbook 

type Runbook string

Runbook Internal documenation about what to do when a policy fails

swagger:model runbook

func (Runbook) Validate 

func (m Runbook) Validate(formats strfmt.Registry) error

Validate validates this runbook

type Severity 

type Severity string

Severity Policy severity

swagger:model severity 

const (

	// SeverityINFO captures enum value "INFO"
	SeverityINFO Severity = "INFO"

	// SeverityLOW captures enum value "LOW"
	SeverityLOW Severity = "LOW"

	// SeverityMEDIUM captures enum value "MEDIUM"
	SeverityMEDIUM Severity = "MEDIUM"

	// SeverityHIGH captures enum value "HIGH"
	SeverityHIGH Severity = "HIGH"

	// SeverityCRITICAL captures enum value "CRITICAL"
	SeverityCRITICAL Severity = "CRITICAL"
)

func (Severity) Validate 

func (m Severity) Validate(formats strfmt.Registry) error

Validate validates this severity

type SourceName added in v1.13.0 

type SourceName string

SourceName standardized field name used in DataModel

swagger:model sourceName

func (SourceName) Validate added in v1.13.0 

func (m SourceName) Validate(formats strfmt.Registry) error

Validate validates this source name

type Suppress 

type Suppress struct {

	// policy ids
	// Required: true
	// Min Items: 1
	PolicyIds []ID `json:"policyIds"`

	// resource patterns
	// Required: true
	ResourcePatterns Suppressions `json:"resourcePatterns"`
}

Suppress suppress

swagger:model Suppress

func (*Suppress) MarshalBinary 

func (m *Suppress) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Suppress) UnmarshalBinary 

func (m *Suppress) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Suppress) Validate 

func (m *Suppress) Validate(formats strfmt.Registry) error

Validate validates this suppress

type Suppressions 

type Suppressions []string

Suppressions List of resource ID regexes that are excepted from this policy. The policy will still be evaluated, but failures will not trigger alerts nor remediations.

swagger:model suppressions

func (Suppressions) Validate 

func (m Suppressions) Validate(formats strfmt.Registry) error

Validate validates this suppressions

type Tags 

type Tags []string

Tags List of tags to categorize the policy

swagger:model tags

func (Tags) Validate 

func (m Tags) Validate(formats strfmt.Registry) error

Validate validates this tags

type TestErrorResult 

type TestErrorResult struct {

	// error message
	ErrorMessage string `json:"errorMessage,omitempty"`

	// name
	Name string `json:"name,omitempty"`
}

TestErrorResult A combination of a test name and the error the test raised

swagger:model testErrorResult

func (*TestErrorResult) MarshalBinary 

func (m *TestErrorResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TestErrorResult) UnmarshalBinary 

func (m *TestErrorResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TestErrorResult) Validate 

func (m *TestErrorResult) Validate(formats strfmt.Registry) error

Validate validates this test error result

type TestExpectedResult 

type TestExpectedResult bool

TestExpectedResult The expected outcome when running a unit test

swagger:model testExpectedResult

func (TestExpectedResult) Validate 

func (m TestExpectedResult) Validate(formats strfmt.Registry) error

Validate validates this test expected result

type TestName 

type TestName string

TestName The name of a unit test

swagger:model testName

func (TestName) Validate 

func (m TestName) Validate(formats strfmt.Registry) error

Validate validates this test name

type TestPolicy 

type TestPolicy struct {

	// analysis type
	// Required: true
	AnalysisType AnalysisType `json:"analysisType"`

	// body
	// Required: true
	Body Body `json:"body"`

	// resource types
	// Required: true
	ResourceTypes TypeSet `json:"resourceTypes"`

	// tests
	// Required: true
	Tests TestSuite `json:"tests"`
}

TestPolicy test policy

swagger:model TestPolicy

func (*TestPolicy) MarshalBinary 

func (m *TestPolicy) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TestPolicy) UnmarshalBinary 

func (m *TestPolicy) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TestPolicy) Validate 

func (m *TestPolicy) Validate(formats strfmt.Registry) error

Validate validates this test policy

type TestPolicyResult 

type TestPolicyResult struct {

	// test summary
	// Required: true
	TestSummary TestSummary `json:"testSummary"`

	// tests errored
	// Required: true
	TestsErrored TestsErrored `json:"testsErrored"`

	// tests failed
	// Required: true
	TestsFailed TestsFailed `json:"testsFailed"`

	// tests passed
	// Required: true
	TestsPassed TestsPassed `json:"testsPassed"`
}

TestPolicyResult test policy result

swagger:model TestPolicyResult

func (*TestPolicyResult) MarshalBinary 

func (m *TestPolicyResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TestPolicyResult) UnmarshalBinary 

func (m *TestPolicyResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TestPolicyResult) Validate 

func (m *TestPolicyResult) Validate(formats strfmt.Registry) error

Validate validates this test policy result

type TestResource 

type TestResource string

TestResource The resource (or log event) the unit test is running against

swagger:model testResource

func (TestResource) Validate 

func (m TestResource) Validate(formats strfmt.Registry) error

Validate validates this test resource

type TestRuleResult added in v1.12.0 

type TestRuleResult struct {

	// results
	Results []*RuleResult `json:"results"`

	// True if all tests passed
	TestSummary bool `json:"testSummary,omitempty"`
}

TestRuleResult test rule result

swagger:model TestRuleResult

func (*TestRuleResult) MarshalBinary added in v1.12.0 

func (m *TestRuleResult) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TestRuleResult) UnmarshalBinary added in v1.12.0 

func (m *TestRuleResult) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TestRuleResult) Validate added in v1.12.0 

func (m *TestRuleResult) Validate(formats strfmt.Registry) error

Validate validates this test rule result

type TestSuite 

type TestSuite []*UnitTest

TestSuite test suite

swagger:model TestSuite

func (TestSuite) Validate 

func (m TestSuite) Validate(formats strfmt.Registry) error

Validate validates this test suite

type TestSummary 

type TestSummary bool

TestSummary True if all tests passed

swagger:model testSummary

func (TestSummary) Validate 

func (m TestSummary) Validate(formats strfmt.Registry) error

Validate validates this test summary

type TestsErrored 

type TestsErrored []*TestErrorResult

TestsErrored List of names of tests that raised an error, along with their error message

swagger:model testsErrored

func (TestsErrored) Validate 

func (m TestsErrored) Validate(formats strfmt.Registry) error

Validate validates this tests errored

type TestsFailed 

type TestsFailed []string

TestsFailed List of names of tests that failed

swagger:model testsFailed

func (TestsFailed) Validate 

func (m TestsFailed) Validate(formats strfmt.Registry) error

Validate validates this tests failed

type TestsPassed 

type TestsPassed []string

TestsPassed List of names of tests that passed

swagger:model testsPassed

func (TestsPassed) Validate 

func (m TestsPassed) Validate(formats strfmt.Registry) error

Validate validates this tests passed

type Threshold added in v1.6.0 

type Threshold int64

Threshold The threshold (number of events) that will have to be reached during the dedupPeriodMinutes in order for the rule to fire an alarm

swagger:model threshold

func (Threshold) Validate added in v1.6.0 

func (m Threshold) Validate(formats strfmt.Registry) error

Validate validates this threshold

type TypeSet 

type TypeSet []string

TypeSet List of resource/log types to which this policy applies

swagger:model TypeSet

func (TypeSet) Validate 

func (m TypeSet) Validate(formats strfmt.Registry) error

Validate validates this type set

type UnitTest 

type UnitTest struct {

	// expected result
	// Required: true
	ExpectedResult TestExpectedResult `json:"expectedResult"`

	// name
	// Required: true
	Name TestName `json:"name"`

	// resource
	// Required: true
	Resource TestResource `json:"resource"`
}

UnitTest unit test

swagger:model UnitTest

func (*UnitTest) MarshalBinary 

func (m *UnitTest) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UnitTest) UnmarshalBinary 

func (m *UnitTest) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UnitTest) Validate 

func (m *UnitTest) Validate(formats strfmt.Registry) error

Validate validates this unit test

type UpdateDataModel added in v1.13.0 

type UpdateDataModel struct {

	// body
	Body Body `json:"body,omitempty"`

	// description
	Description Description `json:"description,omitempty"`

	// display name
	DisplayName DisplayName `json:"displayName,omitempty"`

	// enabled
	// Required: true
	Enabled Enabled `json:"enabled"`

	// id
	// Required: true
	ID ID `json:"id"`

	// log types
	LogTypes TypeSet `json:"logTypes,omitempty"`

	// mappings
	// Required: true
	Mappings DataModelMappings `json:"mappings"`

	// user Id
	// Required: true
	UserID UserID `json:"userId"`
}

UpdateDataModel update data model

swagger:model UpdateDataModel

func (*UpdateDataModel) MarshalBinary added in v1.13.0 

func (m *UpdateDataModel) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdateDataModel) UnmarshalBinary added in v1.13.0 

func (m *UpdateDataModel) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdateDataModel) Validate added in v1.13.0 

func (m *UpdateDataModel) Validate(formats strfmt.Registry) error

Validate validates this update data model

type UpdateGlobal added in v1.1.0 

type UpdateGlobal struct {

	// body
	// Required: true
	Body Body `json:"body"`

	// description
	Description Description `json:"description,omitempty"`

	// id
	// Required: true
	ID ID `json:"id"`

	// tags
	Tags Tags `json:"tags,omitempty"`

	// user Id
	// Required: true
	UserID UserID `json:"userId"`
}

UpdateGlobal update global

swagger:model UpdateGlobal

func (*UpdateGlobal) MarshalBinary added in v1.1.0 

func (m *UpdateGlobal) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdateGlobal) UnmarshalBinary added in v1.1.0 

func (m *UpdateGlobal) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdateGlobal) Validate added in v1.1.0 

func (m *UpdateGlobal) Validate(formats strfmt.Registry) error

Validate validates this update global

type UpdatePolicy 

type UpdatePolicy struct {

	// auto remediation Id
	AutoRemediationID AutoRemediationID `json:"autoRemediationId,omitempty"`

	// auto remediation parameters
	AutoRemediationParameters AutoRemediationParameters `json:"autoRemediationParameters,omitempty"`

	// body
	// Required: true
	Body Body `json:"body"`

	// description
	Description Description `json:"description,omitempty"`

	// display name
	DisplayName DisplayName `json:"displayName,omitempty"`

	// enabled
	// Required: true
	Enabled Enabled `json:"enabled"`

	// id
	// Required: true
	ID ID `json:"id"`

	// output ids
	OutputIds OutputIds `json:"outputIds,omitempty"`

	// reference
	Reference Reference `json:"reference,omitempty"`

	// resource types
	ResourceTypes TypeSet `json:"resourceTypes,omitempty"`

	// runbook
	Runbook Runbook `json:"runbook,omitempty"`

	// severity
	// Required: true
	Severity Severity `json:"severity"`

	// suppressions
	Suppressions Suppressions `json:"suppressions,omitempty"`

	// tags
	Tags Tags `json:"tags,omitempty"`

	// tests
	Tests TestSuite `json:"tests,omitempty"`

	// user Id
	// Required: true
	UserID UserID `json:"userId"`
}

UpdatePolicy update policy

swagger:model UpdatePolicy

func (*UpdatePolicy) MarshalBinary 

func (m *UpdatePolicy) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdatePolicy) UnmarshalBinary 

func (m *UpdatePolicy) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdatePolicy) Validate 

func (m *UpdatePolicy) Validate(formats strfmt.Registry) error

Validate validates this update policy

type UpdateRule 

type UpdateRule struct {

	// body
	// Required: true
	Body Body `json:"body"`

	// dedup period minutes
	DedupPeriodMinutes DedupPeriodMinutes `json:"dedupPeriodMinutes,omitempty"`

	// description
	Description Description `json:"description,omitempty"`

	// display name
	DisplayName DisplayName `json:"displayName,omitempty"`

	// enabled
	// Required: true
	Enabled Enabled `json:"enabled"`

	// id
	// Required: true
	ID ID `json:"id"`

	// log types
	LogTypes TypeSet `json:"logTypes,omitempty"`

	// output ids
	OutputIds OutputIds `json:"outputIds,omitempty"`

	// reference
	Reference Reference `json:"reference,omitempty"`

	// reports
	Reports Reports `json:"reports,omitempty"`

	// runbook
	Runbook Runbook `json:"runbook,omitempty"`

	// severity
	// Required: true
	Severity Severity `json:"severity"`

	// tags
	Tags Tags `json:"tags,omitempty"`

	// tests
	Tests TestSuite `json:"tests,omitempty"`

	// threshold
	Threshold Threshold `json:"threshold,omitempty"`

	// user Id
	// Required: true
	UserID UserID `json:"userId"`
}

UpdateRule update rule

swagger:model UpdateRule

func (*UpdateRule) MarshalBinary 

func (m *UpdateRule) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*UpdateRule) UnmarshalBinary 

func (m *UpdateRule) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*UpdateRule) Validate 

func (m *UpdateRule) Validate(formats strfmt.Registry) error

Validate validates this update rule

type UserID 

type UserID string

UserID Panther user ID that created or modified the policy

swagger:model userId

func (UserID) Validate 

func (m UserID) Validate(formats strfmt.Registry) error

Validate validates this user Id

type VersionID 

type VersionID string

VersionID Policy version ID

swagger:model versionId

func (VersionID) Validate 

func (m VersionID) Validate(formats strfmt.Registry) error

Validate validates this version Id

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.