models

package
v1.9.0-RC2 Latest Latest
Warning

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

Go to latest
Published: Oct 1, 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 ActiveSuppressCount

type ActiveSuppressCount struct {

	// active
	// Required: true
	Active *StatusCount `json:"active"`

	// suppressed
	// Required: true
	Suppressed *StatusCount `json:"suppressed"`
}

ActiveSuppressCount active suppress count

swagger:model ActiveSuppressCount

func (*ActiveSuppressCount) MarshalBinary

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

MarshalBinary interface implementation

func (*ActiveSuppressCount) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ActiveSuppressCount) Validate

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

Validate validates this active suppress count

type ComplianceStatus

type ComplianceStatus struct {

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

	// expires at
	// Required: true
	ExpiresAt ExpiresAt `json:"expiresAt"`

	// integration Id
	// Required: true
	IntegrationID IntegrationID `json:"integrationId"`

	// last updated
	// Required: true
	// Format: date-time
	LastUpdated LastUpdated `json:"lastUpdated"`

	// policy Id
	// Required: true
	PolicyID PolicyID `json:"policyId"`

	// policy severity
	// Required: true
	PolicySeverity PolicySeverity `json:"policySeverity"`

	// resource Id
	// Required: true
	ResourceID ResourceID `json:"resourceId"`

	// resource type
	// Required: true
	ResourceType ResourceType `json:"resourceType"`

	// status
	// Required: true
	Status Status `json:"status"`

	// suppressed
	// Required: true
	Suppressed Suppressed `json:"suppressed"`
}

ComplianceStatus compliance status

swagger:model ComplianceStatus

func (*ComplianceStatus) MarshalBinary

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

MarshalBinary interface implementation

func (*ComplianceStatus) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ComplianceStatus) Validate

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

Validate validates this compliance status

type DeletePolicy

type DeletePolicy struct {

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

	// Only delete entries with these specific resource types
	ResourceTypes []string `json:"resourceTypes"`
}

DeletePolicy delete policy

swagger:model DeletePolicy

func (*DeletePolicy) MarshalBinary

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

MarshalBinary interface implementation

func (*DeletePolicy) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*DeletePolicy) Validate

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

Validate validates this delete policy

type DeleteResource

type DeleteResource struct {

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

DeleteResource delete resource

swagger:model DeleteResource

func (*DeleteResource) MarshalBinary

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

MarshalBinary interface implementation

func (*DeleteResource) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*DeleteResource) Validate

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

Validate validates this delete resource

type DeleteStatus

type DeleteStatus struct {

	// policy
	Policy *DeletePolicy `json:"policy,omitempty"`

	// resource
	Resource *DeleteResource `json:"resource,omitempty"`
}

DeleteStatus delete status

swagger:model DeleteStatus

func (*DeleteStatus) MarshalBinary

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

MarshalBinary interface implementation

func (*DeleteStatus) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*DeleteStatus) Validate

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

Validate validates this delete status

type DeleteStatusBatch

type DeleteStatusBatch struct {

	// entries
	// Required: true
	// Min Items: 1
	Entries []*DeleteStatus `json:"entries"`
}

DeleteStatusBatch delete status batch

swagger:model DeleteStatusBatch

func (*DeleteStatusBatch) MarshalBinary

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

MarshalBinary interface implementation

func (*DeleteStatusBatch) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*DeleteStatusBatch) Validate

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

Validate validates this delete status batch

type EntireOrg

type EntireOrg struct {

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

	// resources
	// Required: true
	Resources []*ItemSummary `json:"resources"`
}

EntireOrg entire org

swagger:model EntireOrg

func (*EntireOrg) MarshalBinary

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

MarshalBinary interface implementation

func (*EntireOrg) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*EntireOrg) Validate

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

Validate validates this entire org

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 ErrorMessage

type ErrorMessage string

ErrorMessage Error message when policy was applied to this resource

swagger:model errorMessage

func (ErrorMessage) Validate

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

Validate validates this error message

type ExpiresAt

type ExpiresAt int64

ExpiresAt Dynamo TTL - unix time when the status will be automatically cleared

swagger:model expiresAt

func (ExpiresAt) Validate

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

Validate validates this expires at

type IgnoreSet

type IgnoreSet []string

IgnoreSet Resource glob patterns which should be suppressed

swagger:model IgnoreSet

func (IgnoreSet) Validate

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

Validate validates this ignore set

type IntegrationID

type IntegrationID string

IntegrationID IntegrationID where the resource was discovered

swagger:model integrationId

func (IntegrationID) Validate

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

Validate validates this integration Id

type ItemSummary

type ItemSummary struct {

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

	// status
	// Required: true
	Status Status `json:"status"`
}

ItemSummary Summary of a single policy or resource compliance status

swagger:model ItemSummary

func (*ItemSummary) MarshalBinary

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

MarshalBinary interface implementation

func (*ItemSummary) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ItemSummary) Validate

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

Validate validates this item summary

type LastUpdated

type LastUpdated strfmt.DateTime

LastUpdated When the compliance state was last updated in the Panther database

swagger:model lastUpdated

func (*LastUpdated) MarshalBinary

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

MarshalBinary interface implementation

func (LastUpdated) MarshalJSON

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

MarshalJSON retrieves a LastUpdated value as JSON output

func (*LastUpdated) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*LastUpdated) UnmarshalJSON

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

UnmarshalJSON sets a LastUpdated value from JSON input

func (LastUpdated) Validate

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

Validate validates this last updated

type OrgSummary

type OrgSummary struct {

	// applied policies
	// Required: true
	AppliedPolicies *StatusCountBySeverity `json:"appliedPolicies"`

	// scanned resources
	// Required: true
	ScannedResources *ScannedResources `json:"scannedResources"`

	// top failing policies
	// Required: true
	TopFailingPolicies []*PolicySummary `json:"topFailingPolicies"`

	// top failing resources
	// Required: true
	TopFailingResources []*ResourceSummary `json:"topFailingResources"`
}

OrgSummary org summary

swagger:model OrgSummary

func (*OrgSummary) MarshalBinary

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

MarshalBinary interface implementation

func (*OrgSummary) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*OrgSummary) Validate

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

Validate validates this org summary

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 PolicyID

type PolicyID string

PolicyID Panther policy ID, unique within each customer's account

swagger:model policyId

func (PolicyID) Validate

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

Validate validates this policy Id

type PolicyResourceDetail

type PolicyResourceDetail struct {

	// items
	// Required: true
	Items []*ComplianceStatus `json:"items"`

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

	// status
	// Required: true
	Status Status `json:"status"`

	// totals
	// Required: true
	Totals *ActiveSuppressCount `json:"totals"`
}

PolicyResourceDetail policy resource detail

swagger:model PolicyResourceDetail

func (*PolicyResourceDetail) MarshalBinary

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

MarshalBinary interface implementation

func (*PolicyResourceDetail) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*PolicyResourceDetail) Validate

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

Validate validates this policy resource detail

type PolicySeverity

type PolicySeverity string

PolicySeverity Policy severity

swagger:model policySeverity

const (

	// PolicySeverityINFO captures enum value "INFO"
	PolicySeverityINFO PolicySeverity = "INFO"

	// PolicySeverityLOW captures enum value "LOW"
	PolicySeverityLOW PolicySeverity = "LOW"

	// PolicySeverityMEDIUM captures enum value "MEDIUM"
	PolicySeverityMEDIUM PolicySeverity = "MEDIUM"

	// PolicySeverityHIGH captures enum value "HIGH"
	PolicySeverityHIGH PolicySeverity = "HIGH"

	// PolicySeverityCRITICAL captures enum value "CRITICAL"
	PolicySeverityCRITICAL PolicySeverity = "CRITICAL"
)

func (PolicySeverity) Validate

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

Validate validates this policy severity

type PolicySummary

type PolicySummary struct {

	// count
	// Required: true
	Count *StatusCount `json:"count"`

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

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

PolicySummary Summary of a single policy compliance status

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 ResourceID

type ResourceID string

ResourceID Globally unique resource ID

swagger:model resourceId

func (ResourceID) Validate

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

Validate validates this resource Id

type ResourceOfType

type ResourceOfType struct {

	// count
	// Required: true
	Count *StatusCount `json:"count"`

	// type
	// Required: true
	Type ResourceType `json:"type"`
}

ResourceOfType resource of type

swagger:model ResourceOfType

func (*ResourceOfType) MarshalBinary

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

MarshalBinary interface implementation

func (*ResourceOfType) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ResourceOfType) Validate

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

Validate validates this resource of type

type ResourceSummary

type ResourceSummary struct {

	// count
	// Required: true
	Count *StatusCountBySeverity `json:"count"`

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

	// type
	// Required: true
	Type ResourceType `json:"type"`
}

ResourceSummary Summary of a single resource compliance status

swagger:model ResourceSummary

func (*ResourceSummary) MarshalBinary

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

MarshalBinary interface implementation

func (*ResourceSummary) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ResourceSummary) Validate

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

Validate validates this resource summary

type ResourceType

type ResourceType string

ResourceType Resource type

swagger:model resourceType

func (ResourceType) Validate

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

Validate validates this resource type

type ScannedResources

type ScannedResources struct {

	// by type
	// Required: true
	ByType []*ResourceOfType `json:"byType"`
}

ScannedResources scanned resources

swagger:model ScannedResources

func (*ScannedResources) MarshalBinary

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

MarshalBinary interface implementation

func (*ScannedResources) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ScannedResources) Validate

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

Validate validates this scanned resources

type SetStatus

type SetStatus struct {

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

	// integration Id
	// Required: true
	IntegrationID IntegrationID `json:"integrationId"`

	// policy Id
	// Required: true
	PolicyID PolicyID `json:"policyId"`

	// policy severity
	// Required: true
	PolicySeverity PolicySeverity `json:"policySeverity"`

	// resource Id
	// Required: true
	ResourceID ResourceID `json:"resourceId"`

	// resource type
	// Required: true
	ResourceType ResourceType `json:"resourceType"`

	// status
	// Required: true
	Status Status `json:"status"`

	// suppressed
	// Required: true
	Suppressed Suppressed `json:"suppressed"`
}

SetStatus set status

swagger:model SetStatus

func (*SetStatus) MarshalBinary

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

MarshalBinary interface implementation

func (*SetStatus) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*SetStatus) Validate

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

Validate validates this set status

type SetStatusBatch

type SetStatusBatch struct {

	// entries
	// Required: true
	// Min Items: 1
	Entries []*SetStatus `json:"entries"`
}

SetStatusBatch set status batch

swagger:model SetStatusBatch

func (*SetStatusBatch) MarshalBinary

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

MarshalBinary interface implementation

func (*SetStatusBatch) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*SetStatusBatch) Validate

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

Validate validates this set status batch

type Status

type Status string

Status Compliance status for one or more policy/resource pairs. A list has the collective status ERROR or FAIL if any of them individually error or fail.

swagger:model status

const (

	// StatusERROR captures enum value "ERROR"
	StatusERROR Status = "ERROR"

	// StatusFAIL captures enum value "FAIL"
	StatusFAIL Status = "FAIL"

	// StatusPASS captures enum value "PASS"
	StatusPASS Status = "PASS"
)

func (Status) Validate

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

Validate validates this status

type StatusCount

type StatusCount struct {

	// error
	// Minimum: 0
	Error *int64 `json:"error,omitempty"`

	// fail
	// Minimum: 0
	Fail *int64 `json:"fail,omitempty"`

	// pass
	// Minimum: 0
	Pass *int64 `json:"pass,omitempty"`
}

StatusCount status count

swagger:model StatusCount

func (*StatusCount) MarshalBinary

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

MarshalBinary interface implementation

func (*StatusCount) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*StatusCount) Validate

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

Validate validates this status count

type StatusCountBySeverity

type StatusCountBySeverity struct {

	// critical
	Critical *StatusCount `json:"critical,omitempty"`

	// high
	High *StatusCount `json:"high,omitempty"`

	// info
	Info *StatusCount `json:"info,omitempty"`

	// low
	Low *StatusCount `json:"low,omitempty"`

	// medium
	Medium *StatusCount `json:"medium,omitempty"`
}

StatusCountBySeverity status count by severity

swagger:model StatusCountBySeverity

func (*StatusCountBySeverity) MarshalBinary

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

MarshalBinary interface implementation

func (*StatusCountBySeverity) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*StatusCountBySeverity) Validate

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

Validate validates this status count by severity

type Suppressed

type Suppressed bool

Suppressed True if this resource is ignored/suppressed by this specific policy. Suppressed resources are still analyzed and reported, but do not trigger alerts/remediations.

swagger:model suppressed

func (Suppressed) Validate

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

Validate validates this suppressed

type UpdateMetadata

type UpdateMetadata struct {

	// policy Id
	// Required: true
	PolicyID PolicyID `json:"policyId"`

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

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

UpdateMetadata update metadata

swagger:model UpdateMetadata

func (*UpdateMetadata) MarshalBinary

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

MarshalBinary interface implementation

func (*UpdateMetadata) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*UpdateMetadata) Validate

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

Validate validates this update metadata

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL