Documentation ¶
Index ¶
- Variables
- type Context
- type DayOfWeek
- type Filter
- type FilterType
- type Recurrence
- type RecurrenceType
- type Schedule
- type Scope
- type Suppression
- type TagCombination
- type TagInfo
- func (me *TagInfo) Equals(other any) bool
- func (me *TagInfo) MarshalHCL(properties hcl.Properties) error
- func (me *TagInfo) MarshalJSON() ([]byte, error)
- func (me *TagInfo) Schema() map[string]*schema.Schema
- func (me *TagInfo) UnmarshalHCL(decoder hcl.Decoder) error
- func (me *TagInfo) UnmarshalJSON(data []byte) error
- type TagInfos
- type Window
- func (me *Window) Deprecated() string
- func (me *Window) MarshalHCL(properties hcl.Properties) error
- func (me *Window) MarshalJSON() ([]byte, error)
- func (me *Window) Schema() map[string]*schema.Schema
- func (me *Window) UnmarshalHCL(decoder hcl.Decoder) error
- func (me *Window) UnmarshalJSON(data []byte) error
- type WindowType
Constants ¶
This section is empty.
Variables ¶
var Contexts = struct { AWS Context AWSGeneric Context Azure Context CloudFoundry Context Contextless Context Environment Context GoogleCloud Context Kubernetes Context }{ "AWS", "AWS_GENERIC", "AZURE", "CLOUD_FOUNDRY", "CONTEXTLESS", "ENVIRONMENT", "GOOGLE_CLOUD", "KUBERNETES", }
Contexts offers the known enum values
var DayOfWeeks = struct { Friday DayOfWeek Monday DayOfWeek Saturday DayOfWeek Sunday DayOfWeek Thursday DayOfWeek Tuesday DayOfWeek Wednesday DayOfWeek }{ "FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY", }
DayOfWeeks offers the known enum values
var FilterTypes = struct { ApmSecurityGateway FilterType Application FilterType ApplicationMethod FilterType ApplicationMethodGroup FilterType AppMonServer FilterType AppMonSystemProfile FilterType AutoScalingGroup FilterType AuxiliarySyntheticTest FilterType AWSApplicationLoadBalancer FilterType AWSAvailabilityZone FilterType AWSCredentials FilterType AWSLambdaFunction FilterType AWSNetworkLoadBalancer FilterType AzureAPIManagementService FilterType AzureApplicationGateway FilterType AzureCosmosDB FilterType AzureCredentials FilterType AzureEventHub FilterType AzureEventHubNamespace FilterType AzureFunctionApp FilterType AzureIotHub FilterType AzureLoadBalancer FilterType AzureMgmtGroup FilterType AzureRedisCache FilterType AzureRegion FilterType AzureServiceBusNamespace FilterType AzureServiceBusQueue FilterType AzureServiceBusTopic FilterType AzureSQLDatabase FilterType AzureSQLElasticPool FilterType AzureSQLServer FilterType AzureStorageAccount FilterType AzureSubscription FilterType AzureTenant FilterType AzureVM FilterType AzureVMScaleSet FilterType AzureWebApp FilterType CfApplication FilterType CfFoundation FilterType CinderVolume FilterType CloudApplication FilterType CloudApplicationInstance FilterType CloudApplicationNamespace FilterType ContainerGroup FilterType ContainerGroupInstance FilterType CustomApplication FilterType CustomDevice FilterType CustomDeviceGroup FilterType DCRumApplication FilterType DCRumService FilterType DCRumServiceInstance FilterType DeviceApplicationMethod FilterType Disk FilterType DockerContainerGroup FilterType DockerContainerGroupInstance FilterType DynamoDBTable FilterType EbsVolume FilterType EC2Instance FilterType ElasticLoadBalancer FilterType Environment FilterType ExternalSyntheticTestStep FilterType GcpZone FilterType Geolocation FilterType GeolocSite FilterType GoogleComputeEngine FilterType Host FilterType HostGroup FilterType HTTPCheck FilterType HTTPCheckStep FilterType Hypervisor FilterType KubernetesCluster FilterType KubernetesNode FilterType MobileApplication FilterType NetworkInterface FilterType NeutronSubnet FilterType OpenStackProject FilterType OpenStackRegion FilterType OpenStackVM FilterType OS FilterType ProcessGroup FilterType ProcessGroupInstance FilterType RelationalDatabaseService FilterType Service FilterType ServiceInstance FilterType ServiceMethod FilterType ServiceMethodGroup FilterType SwiftContainer FilterType SyntheticLocation FilterType SyntheticTest FilterType SyntheticTestStep FilterType Virtualmachine FilterType VmwareDatacenter FilterType }{ "APM_SECURITY_GATEWAY", "APPLICATION", "APPLICATION_METHOD", "APPLICATION_METHOD_GROUP", "APPMON_SERVER", "APPMON_SYSTEM_PROFILE", "AUTO_SCALING_GROUP", "AUXILIARY_SYNTHETIC_TEST", "AWS_APPLICATION_LOAD_BALANCER", "AWS_AVAILABILITY_ZONE", "AWS_CREDENTIALS", "AWS_LAMBDA_FUNCTION", "AWS_NETWORK_LOAD_BALANCER", "AZURE_API_MANAGEMENT_SERVICE", "AZURE_APPLICATION_GATEWAY", "AZURE_COSMOS_DB", "AZURE_CREDENTIALS", "AZURE_EVENT_HUB", "AZURE_EVENT_HUB_NAMESPACE", "AZURE_FUNCTION_APP", "AZURE_IOT_HUB", "AZURE_LOAD_BALANCER", "AZURE_MGMT_GROUP", "AZURE_REDIS_CACHE", "AZURE_REGION", "AZURE_SERVICE_BUS_NAMESPACE", "AZURE_SERVICE_BUS_QUEUE", "AZURE_SERVICE_BUS_TOPIC", "AZURE_SQL_DATABASE", "AZURE_SQL_ELASTIC_POOL", "AZURE_SQL_SERVER", "AZURE_STORAGE_ACCOUNT", "AZURE_SUBSCRIPTION", "AZURE_TENANT", "AZURE_VM", "AZURE_VM_SCALE_SET", "AZURE_WEB_APP", "CF_APPLICATION", "CF_FOUNDATION", "CINDER_VOLUME", "CLOUD_APPLICATION", "CLOUD_APPLICATION_INSTANCE", "CLOUD_APPLICATION_NAMESPACE", "CONTAINER_GROUP", "CONTAINER_GROUP_INSTANCE", "CUSTOM_APPLICATION", "CUSTOM_DEVICE", "CUSTOM_DEVICE_GROUP", "DCRUM_APPLICATION", "DCRUM_SERVICE", "DCRUM_SERVICE_INSTANCE", "DEVICE_APPLICATION_METHOD", "DISK", "DOCKER_CONTAINER_GROUP", "DOCKER_CONTAINER_GROUP_INSTANCE", "DYNAMO_DB_TABLE", "EBS_VOLUME", "EC2_INSTANCE", "ELASTIC_LOAD_BALANCER", "ENVIRONMENT", "EXTERNAL_SYNTHETIC_TEST_STEP", "GCP_ZONE", "GEOLOCATION", "GEOLOC_SITE", "GOOGLE_COMPUTE_ENGINE", "HOST", "HOST_GROUP", "HTTP_CHECK", "HTTP_CHECK_STEP", "HYPERVISOR", "KUBERNETES_CLUSTER", "KUBERNETES_NODE", "MOBILE_APPLICATION", "NETWORK_INTERFACE", "NEUTRON_SUBNET", "OPENSTACK_PROJECT", "OPENSTACK_REGION", "OPENSTACK_VM", "OS", "PROCESS_GROUP", "PROCESS_GROUP_INSTANCE", "RELATIONAL_DATABASE_SERVICE", "SERVICE", "SERVICE_INSTANCE", "SERVICE_METHOD", "SERVICE_METHOD_GROUP", "SWIFT_CONTAINER", "SYNTHETIC_LOCATION", "SYNTHETIC_TEST", "SYNTHETIC_TEST_STEP", "VIRTUALMACHINE", "VMWARE_DATACENTER", }
FilterTypes offers the known enum values
var MaintenanceWindowTypes = struct { Planned WindowType Unplanned WindowType }{ "PLANNED", "UNPLANNED", }
MaintenanceWindowTypes offers the known enum values
var RecurrenceTypes = struct { Daily RecurrenceType Monthly RecurrenceType Once RecurrenceType Weekly RecurrenceType }{ "DAILY", "MONTHLY", "ONCE", "WEEKLY", }
RecurrenceTypes offers the known enum values
var Suppressions = struct { DetectProblemsAndAlert Suppression DetectProblemsDontAlert Suppression DontDetectProblems Suppression }{ "DETECT_PROBLEMS_AND_ALERT", "DETECT_PROBLEMS_DONT_ALERT", "DONT_DETECT_PROBLEMS", }
Suppressions offers the known enum values
var TagCombinations = struct { And TagCombination Or TagCombination }{ "AND", "OR", }
TagCombinations offers the known enum values
Functions ¶
This section is empty.
Types ¶
type Context ¶
type Context string
Context The origin of the tag, such as AWS or Cloud Foundry.
Custom tags use the `CONTEXTLESS` value.
type DayOfWeek ¶
type DayOfWeek string
DayOfWeek The day of the week for weekly maintenance. The format is the full name of the day in upper case, for example `THURSDAY`.
type Filter ¶
type Filter struct { Type *FilterType `json:"type,omitempty"` // The type of the Dynatrace entities (for example, hosts or services) you want to pick up by matching. MzID *string `json:"mzId,omitempty"` // The ID of a management zone to which the matched entities must belong. TagCombination *TagCombination `json:"tagCombination,omitempty"` // The logic that applies when several tags are specified: AND/OR. If not set, the OR logic is used. Tags TagInfos `json:"tags"` // The tag you want to use for matching. You can use custom tags from the UI, AWS tags, Cloud Foundry tags, OpenShift/Kubernetes, and tags based on environment variables. Unknowns map[string]json.RawMessage `json:"-"` }
Filter A matching rule for Dynatrace entities.
func (*Filter) MarshalHCL ¶
func (me *Filter) MarshalHCL(properties hcl.Properties) error
func (*Filter) MarshalJSON ¶
func (*Filter) UnmarshalJSON ¶
type FilterType ¶
type FilterType string
FilterType The type of the Dynatrace entities (for example, hosts or services) you want to pick up by matching.
func (FilterType) Ref ¶
func (me FilterType) Ref() *FilterType
type Recurrence ¶
type Recurrence struct { DayOfMonth *int32 `json:"dayOfMonth,omitempty"` // The day of the month for monthly maintenance. The value of `31` is treated as the last day of the month for months that don't have a 31st day. The value of `30` is also treated as the last day of the month for February. DayOfWeek *DayOfWeek `json:"dayOfWeek,omitempty"` // The day of the week for weekly maintenance. The format is the full name of the day in upper case, for example `THURSDAY`. DurationMinutes int32 `json:"durationMinutes"` // The duration of the maintenance window in minutes. StartTime string `json:"startTime"` // The start time of the maintenance window in HH:mm format. Unknowns map[string]json.RawMessage `json:"-"` }
Recurrence The recurrence of the maintenance window.
func (*Recurrence) MarshalHCL ¶
func (me *Recurrence) MarshalHCL(properties hcl.Properties) error
func (*Recurrence) MarshalJSON ¶
func (me *Recurrence) MarshalJSON() ([]byte, error)
func (*Recurrence) UnmarshalHCL ¶
func (me *Recurrence) UnmarshalHCL(decoder hcl.Decoder) error
func (*Recurrence) UnmarshalJSON ¶
func (me *Recurrence) UnmarshalJSON(data []byte) error
type RecurrenceType ¶
type RecurrenceType string
RecurrenceType The type of the schedule recurrence.
type Schedule ¶
type Schedule struct { Start string `json:"start"` // The start date and time of the maintenance window validity period in yyyy-mm-dd HH:mm format. End string `json:"end"` // The end date and time of the maintenance window validity period in yyyy-mm-dd HH:mm format. ZoneID string `json:"zoneId"` // The time zone of the start and end time. Default time zone is UTC. You can use either UTC offset `UTC+01:00` format or the IANA Time Zone Database format (for example, `Europe/Vienna`). Recurrence *Recurrence `json:"recurrence,omitempty"` // The recurrence of the maintenance window. RecurrenceType RecurrenceType `json:"recurrenceType"` // The type of the schedule recurrence. Unknowns map[string]json.RawMessage `json:"-"` }
Schedule The schedule of the maintenance window.
func (*Schedule) MarshalHCL ¶
func (me *Schedule) MarshalHCL(properties hcl.Properties) error
func (*Schedule) MarshalJSON ¶
func (*Schedule) UnmarshalJSON ¶
type Scope ¶
type Scope struct { Entities []string `json:"entities"` // A list of Dynatrace entities (for example, hosts or services) to be included in the scope. Allowed values are Dynatrace entity IDs. Matches []*Filter `json:"matches"` // A list of matching rules for dynamic scope formation. If several rules are set, the OR logic applies. Unknowns map[string]json.RawMessage `json:"-"` }
Scope The scope of the maintenance window.
The scope restricts the alert/problem detection suppression to certain Dynatrace entities. It can contain a list of entities and/or matching rules for dynamic formation of the scope. If no scope is specified, the alert/problem detection suppression applies to the entire environment.
func (*Scope) MarshalHCL ¶
func (me *Scope) MarshalHCL(properties hcl.Properties) error
func (*Scope) MarshalJSON ¶
func (*Scope) UnmarshalJSON ¶
type Suppression ¶
type Suppression string
Suppression The type of suppression of alerting and problem detection during the maintenance.
type TagCombination ¶
type TagCombination string
TagCombination The logic that applies when several tags are specified: AND/OR. If not set, the OR logic is used.
func (TagCombination) Ref ¶
func (me TagCombination) Ref() *TagCombination
type TagInfo ¶
type TagInfo struct { Context Context `json:"context"` // The origin of the tag, such as AWS or Cloud Foundry. Custom tags use the `CONTEXTLESS` value. Key string `json:"key"` // The key of the tag. Custom tags have the tag value here. Value *string `json:"value,omitempty"` // The value of the tag. Not applicable to custom tags. Unknowns map[string]json.RawMessage `json:"-"` }
TagInfo Tag of a Dynatrace entity.
func (*TagInfo) MarshalHCL ¶
func (me *TagInfo) MarshalHCL(properties hcl.Properties) error
func (*TagInfo) MarshalJSON ¶
func (*TagInfo) UnmarshalJSON ¶
type Window ¶
type Window struct { Name string `json:"name"` // The name of the maintenance window, displayed in the UI. Description string `json:"description"` // A short description of the maintenance purpose. Schedule *Schedule `json:"schedule"` // The schedule of the maintenance window. Scope *Scope `json:"scope,omitempty"` // The scope of the maintenance window. The scope restricts the alert/problem detection suppression to certain Dynatrace entities. It can contain a list of entities and/or matching rules for dynamic formation of the scope. If no scope is specified, the alert/problem detection suppression applies to the entire environment. Suppression Suppression `json:"suppression"` // The type of suppression of alerting and problem detection during the maintenance. Type WindowType `json:"type"` // The type of the maintenance: planned or unplanned SuppressSyntheticMonitorsExecution *bool `json:"suppressSyntheticMonitorsExecution,omitempty"` // Suppress execution of synthetic monitors during the maintenance Enabled bool `json:"enabled"` Unknowns map[string]json.RawMessage `json:"-"` }
Window Configuration of a maintenance window.
func (*Window) Deprecated ¶ added in v1.36.0
func (*Window) MarshalHCL ¶
func (me *Window) MarshalHCL(properties hcl.Properties) error
func (*Window) MarshalJSON ¶
func (*Window) UnmarshalJSON ¶
type WindowType ¶
type WindowType string
WindowType The type of the maintenance: planned or unplanned.