scope

package
v1.69.0 Latest Latest
Warning

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

 Go to latest Published: Oct 10, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var FilterTypes = struct {
	CustomDeviceGroupName FilterType
	EntityID              FilterType
	HostGroupName         FilterType
	HostName              FilterType
	ManagementZone        FilterType
	Name                  FilterType
	ProcessGroupID        FilterType
	ProcessGroupName      FilterType
	Tag                   FilterType
}{
	"CUSTOM_DEVICE_GROUP_NAME",
	"ENTITY_ID",
	"HOST_GROUP_NAME",
	"HOST_NAME",
	"MANAGEMENT_ZONE",
	"NAME",
	"PROCESS_GROUP_ID",
	"PROCESS_GROUP_NAME",
	"TAG",
}

FilterTypes offers the known enum values

View Source 
var Operators = struct {
	ContainsCaseInsensitive Operator
	ContainsCaseSensitive   Operator
	Equals                  Operator
}{
	"CONTAINS_CASE_INSENSITIVE",
	"CONTAINS_CASE_SENSITIVE",
	"EQUALS",
}

Operators offers the known enum values

Functions

This section is empty.

Types

type AlertingScope 

type AlertingScope interface {
	GetType() FilterType
}

AlertingScope A single filter for the alerting scope. This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.

type AlertingScopes 

type AlertingScopes []AlertingScope

func (AlertingScopes) MarshalHCL 

func (me AlertingScopes) MarshalHCL(properties hcl.Properties) error

func (AlertingScopes) Schema 

func (me AlertingScopes) Schema() map[string]*schema.Schema

func (*AlertingScopes) UnmarshalHCL 

func (me *AlertingScopes) UnmarshalHCL(decoder hcl.Decoder) error

func (*AlertingScopes) UnmarshalJSON 

func (me *AlertingScopes) UnmarshalJSON(data []byte) error

type BaseAlertingScope 

type BaseAlertingScope struct {
	FilterType FilterType                 `json:"filterType"` // Defines the actual set of fields depending on the value. See one of the following objects:  * `ENTITY_ID` -> EntityIdAlertingScope  * `MANAGEMENT_ZONE` -> ManagementZoneAlertingScope  * `TAG` -> TagFilterAlertingScope  * `NAME` -> NameAlertingScope  * `CUSTOM_DEVICE_GROUP_NAME` -> CustomDeviceGroupNameAlertingScope  * `HOST_GROUP_NAME` -> HostGroupNameAlertingScope  * `HOST_NAME` -> HostNameAlertingScope  * `PROCESS_GROUP_ID` -> ProcessGroupIdAlertingScope  * `PROCESS_GROUP_NAME` -> ProcessGroupNameAlertingScope
	Unknowns   map[string]json.RawMessage `json:"-"`
}

BaseAlertingScope A single filter for the alerting scope. This is the base version of the filter, depending on the type, the actual JSON may contain additional fields.

func (*BaseAlertingScope) GetType 

func (me *BaseAlertingScope) GetType() FilterType

func (*BaseAlertingScope) MarshalHCL 

func (me *BaseAlertingScope) MarshalHCL(properties hcl.Properties) error

func (*BaseAlertingScope) MarshalJSON 

func (me *BaseAlertingScope) MarshalJSON() ([]byte, error)

func (*BaseAlertingScope) Schema 

func (me *BaseAlertingScope) Schema() map[string]*schema.Schema

func (*BaseAlertingScope) UnmarshalHCL 

func (me *BaseAlertingScope) UnmarshalHCL(decoder hcl.Decoder) error

func (*BaseAlertingScope) UnmarshalJSON 

func (me *BaseAlertingScope) UnmarshalJSON(data []byte) error

type CustomDeviceGroupName 

type CustomDeviceGroupName struct {
	BaseAlertingScope
	NameFilter *Filter `json:"nameFilter"` // A filter for a string value based on the given operator.
}

CustomDeviceGroupName A scope filter for the related custom device group name.

func (*CustomDeviceGroupName) GetType 

func (me *CustomDeviceGroupName) GetType() FilterType

func (*CustomDeviceGroupName) MarshalHCL 

func (me *CustomDeviceGroupName) MarshalHCL(properties hcl.Properties) error

func (*CustomDeviceGroupName) MarshalJSON 

func (me *CustomDeviceGroupName) MarshalJSON() ([]byte, error)

func (*CustomDeviceGroupName) Schema 

func (me *CustomDeviceGroupName) Schema() map[string]*schema.Schema

func (*CustomDeviceGroupName) UnmarshalHCL 

func (me *CustomDeviceGroupName) UnmarshalHCL(decoder hcl.Decoder) error

func (*CustomDeviceGroupName) UnmarshalJSON 

func (me *CustomDeviceGroupName) UnmarshalJSON(data []byte) error

type EntityID 

type EntityID struct {
	BaseAlertingScope
	EntityID string `json:"entityId"` // The monitored entities id to match on.
}

EntityID A scope filter for a monitored entity identifier.

func (*EntityID) GetType 

func (me *EntityID) GetType() FilterType

func (*EntityID) MarshalHCL 

func (me *EntityID) MarshalHCL(properties hcl.Properties) error

func (*EntityID) MarshalJSON 

func (me *EntityID) MarshalJSON() ([]byte, error)

func (*EntityID) Schema 

func (me *EntityID) Schema() map[string]*schema.Schema

func (*EntityID) UnmarshalHCL 

func (me *EntityID) UnmarshalHCL(decoder hcl.Decoder) error

func (*EntityID) UnmarshalJSON 

func (me *EntityID) UnmarshalJSON(data []byte) error

type Filter 

type Filter struct {
	Value    string   `json:"value"`    // The value to match on.
	Operator Operator `json:"operator"` // The operator to match on.
}

MetricEventTextFilterMetricEventTextFilterOperatorDto A filter for a string value based on the given operator.

func (*Filter) MarshalHCL 

func (me *Filter) MarshalHCL(properties hcl.Properties) error

func (*Filter) Schema 

func (me *Filter) Schema() map[string]*schema.Schema

func (*Filter) UnmarshalHCL 

func (me *Filter) UnmarshalHCL(decoder hcl.Decoder) error

type FilterType 

type FilterType string

FilterType Defines the actual set of fields depending on the value. See one of the following objects: * `ENTITY_ID` -> EntityIdAlertingScope * `MANAGEMENT_ZONE` -> ManagementZoneAlertingScope * `TAG` -> TagFilterAlertingScope * `NAME` -> NameAlertingScope * `CUSTOM_DEVICE_GROUP_NAME` -> CustomDeviceGroupNameAlertingScope * `HOST_GROUP_NAME` -> HostGroupNameAlertingScope * `HOST_NAME` -> HostNameAlertingScope * `PROCESS_GROUP_ID` -> ProcessGroupIdAlertingScope * `PROCESS_GROUP_NAME` -> ProcessGroupNameAlertingScope

type HostGroupName 

type HostGroupName struct {
	BaseAlertingScope
	NameFilter *Filter `json:"nameFilter"` // A filter for a string value based on the given operator.
}

HostGroupName A scope filter for the related host group name.

func (*HostGroupName) GetType 

func (me *HostGroupName) GetType() FilterType

func (*HostGroupName) MarshalHCL 

func (me *HostGroupName) MarshalHCL(properties hcl.Properties) error

func (*HostGroupName) MarshalJSON 

func (me *HostGroupName) MarshalJSON() ([]byte, error)

func (*HostGroupName) Schema 

func (me *HostGroupName) Schema() map[string]*schema.Schema

func (*HostGroupName) UnmarshalHCL 

func (me *HostGroupName) UnmarshalHCL(decoder hcl.Decoder) error

func (*HostGroupName) UnmarshalJSON 

func (me *HostGroupName) UnmarshalJSON(data []byte) error

type HostName 

type HostName struct {
	BaseAlertingScope
	NameFilter *Filter `json:"nameFilter"` // A filter for a string value based on the given operator.
}

HostName A scope filter for the related host name.

func (*HostName) GetType 

func (me *HostName) GetType() FilterType

func (*HostName) MarshalHCL 

func (me *HostName) MarshalHCL(properties hcl.Properties) error

func (*HostName) MarshalJSON 

func (me *HostName) MarshalJSON() ([]byte, error)

func (*HostName) Schema 

func (me *HostName) Schema() map[string]*schema.Schema

func (*HostName) UnmarshalHCL 

func (me *HostName) UnmarshalHCL(decoder hcl.Decoder) error

func (*HostName) UnmarshalJSON 

func (me *HostName) UnmarshalJSON(data []byte) error

type ManagementZone 

type ManagementZone struct {
	BaseAlertingScope
	ID *string `json:"mzId,omitempty"` // The management zone id to match on.
}

ManagementZone A scope filter for a management zone identifier.

func (*ManagementZone) GetType 

func (me *ManagementZone) GetType() FilterType

func (*ManagementZone) MarshalHCL 

func (me *ManagementZone) MarshalHCL(properties hcl.Properties) error

func (*ManagementZone) MarshalJSON 

func (me *ManagementZone) MarshalJSON() ([]byte, error)

func (*ManagementZone) Schema 

func (me *ManagementZone) Schema() map[string]*schema.Schema

func (*ManagementZone) UnmarshalHCL 

func (me *ManagementZone) UnmarshalHCL(decoder hcl.Decoder) error

func (*ManagementZone) UnmarshalJSON 

func (me *ManagementZone) UnmarshalJSON(data []byte) error

type Name 

type Name struct {
	BaseAlertingScope
	NameFilter *Filter `json:"nameFilter"` // A filter for a string value based on the given operator.
}

Name A scope filter for a monitored entity name.

func (*Name) GetType 

func (me *Name) GetType() FilterType

func (*Name) MarshalHCL 

func (me *Name) MarshalHCL(properties hcl.Properties) error

func (*Name) MarshalJSON 

func (me *Name) MarshalJSON() ([]byte, error)

func (*Name) Schema 

func (me *Name) Schema() map[string]*schema.Schema

func (*Name) UnmarshalHCL 

func (me *Name) UnmarshalHCL(decoder hcl.Decoder) error

func (*Name) UnmarshalJSON 

func (me *Name) UnmarshalJSON(data []byte) error

type Operator 

type Operator string

Operator The operator to match on.

type ProcessGroupID 

type ProcessGroupID struct {
	BaseAlertingScope
	ID string `json:"processGroupId"` // The process groups id to match on.
}

ProcessGroupID A scope filter for a process group identifier.

func (*ProcessGroupID) GetType 

func (me *ProcessGroupID) GetType() FilterType

func (*ProcessGroupID) MarshalHCL 

func (me *ProcessGroupID) MarshalHCL(properties hcl.Properties) error

func (*ProcessGroupID) MarshalJSON 

func (me *ProcessGroupID) MarshalJSON() ([]byte, error)

func (*ProcessGroupID) Schema 

func (me *ProcessGroupID) Schema() map[string]*schema.Schema

func (*ProcessGroupID) UnmarshalHCL 

func (me *ProcessGroupID) UnmarshalHCL(decoder hcl.Decoder) error

func (*ProcessGroupID) UnmarshalJSON 

func (me *ProcessGroupID) UnmarshalJSON(data []byte) error

type ProcessGroupName 

type ProcessGroupName struct {
	BaseAlertingScope
	NameFilter *Filter `json:"nameFilter"` // A filter for a string value based on the given operator.
}

ProcessGroupNameAlertingScope A scope filter for the related process group name.

func (*ProcessGroupName) GetType 

func (me *ProcessGroupName) GetType() FilterType

func (*ProcessGroupName) MarshalHCL 

func (me *ProcessGroupName) MarshalHCL(properties hcl.Properties) error

func (*ProcessGroupName) MarshalJSON 

func (me *ProcessGroupName) MarshalJSON() ([]byte, error)

func (*ProcessGroupName) Schema 

func (me *ProcessGroupName) Schema() map[string]*schema.Schema

func (*ProcessGroupName) UnmarshalHCL 

func (me *ProcessGroupName) UnmarshalHCL(decoder hcl.Decoder) error

func (*ProcessGroupName) UnmarshalJSON 

func (me *ProcessGroupName) UnmarshalJSON(data []byte) error

type TagFilter 

type TagFilter struct {
	BaseAlertingScope
	TagFilter *common.TagFilter `json:"tagFilter"` // A tag-based filter of monitored entities.
}

TagFilter A scope filter for tags on entities.

func (*TagFilter) GetType 

func (me *TagFilter) GetType() FilterType

func (*TagFilter) MarshalHCL 

func (me *TagFilter) MarshalHCL(properties hcl.Properties) error

func (*TagFilter) MarshalJSON 

func (me *TagFilter) MarshalJSON() ([]byte, error)

func (*TagFilter) Schema 

func (me *TagFilter) Schema() map[string]*schema.Schema

func (*TagFilter) UnmarshalHCL 

func (me *TagFilter) UnmarshalHCL(decoder hcl.Decoder) error

func (*TagFilter) UnmarshalJSON 

func (me *TagFilter) UnmarshalJSON(data []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.