maintenancewindow

package
v1.54.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DayOfWeekTypes = struct {
	Friday    DayOfWeekType
	Monday    DayOfWeekType
	Saturday  DayOfWeekType
	Sunday    DayOfWeekType
	Thursday  DayOfWeekType
	Tuesday   DayOfWeekType
	Wednesday DayOfWeekType
}{
	"FRIDAY",
	"MONDAY",
	"SATURDAY",
	"SUNDAY",
	"THURSDAY",
	"TUESDAY",
	"WEDNESDAY",
}
View Source 
var MaintenanceTypes = struct {
	Planned   MaintenanceType
	Unplanned MaintenanceType
}{
	"PLANNED",
	"UNPLANNED",
}
View Source 
var ScheduleTypes = struct {
	Daily   ScheduleType
	Monthly ScheduleType
	Once    ScheduleType
	Weekly  ScheduleType
}{
	"DAILY",
	"MONTHLY",
	"ONCE",
	"WEEKLY",
}
View Source 
var SuppressionTypes = struct {
	DetectProblemsAndAlert  SuppressionType
	DetectProblemsDontAlert SuppressionType
	DontDetectProblems      SuppressionType
}{
	"DETECT_PROBLEMS_AND_ALERT",
	"DETECT_PROBLEMS_DONT_ALERT",
	"DONT_DETECT_PROBLEMS",
}

Functions

This section is empty.

Types

type DailyRecurrence 

type DailyRecurrence struct {
	RecurrenceRange *RecurrenceRange `json:"recurrenceRange"` // The recurrence date range of the maintenance window
	TimeWindow      *TimeWindow      `json:"timeWindow"`      // The time window of the maintenance window
}

func (*DailyRecurrence) MarshalHCL 

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

func (*DailyRecurrence) Schema 

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

func (*DailyRecurrence) UnmarshalHCL 

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

type DayOfWeekType 

type DayOfWeekType string

type Filter 

type Filter struct {
	EntityID        *string  `json:"entityId,omitempty"`        // A specific entity that should match this maintenance window.. **Note**: If an entity type filter value is set, it must be equal to the type of the selected entity. Otherwise this maintenance window will not match.
	EntityTags      []string `json:"entityTags,omitempty"`      // Entities which contain all of the configured tags will match this maintenance window.
	EntityType      *string  `json:"entityType,omitempty"`      // Type of entities this maintenance window should match.. If no entity type is selected all entities regardless of the type will match.
	ManagementZones []string `json:"managementZones,omitempty"` // Entities which are part of all the configured management zones will match this maintenance window.
}

Filter. Configured values of one filter are evaluated together (**AND**).. The maintenance window is applied onto an entity if it matches all of the values of at least one filter.

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 Filters 

type Filters []*Filter

func (Filters) MarshalHCL 

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

func (*Filters) Schema 

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

func (*Filters) UnmarshalHCL 

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

type GeneralProperties 

type GeneralProperties struct {
	Description                      *string         `json:"description,omitempty"`            // A short description of the maintenance purpose.
	DisableSyntheticMonitorExecution bool            `json:"disableSyntheticMonitorExecution"` // Disables the execution of the synthetic monitors that are within [the scope of this maintenance window](https://dt-url.net/0e0341m).
	MaintenanceType                  MaintenanceType `json:"maintenanceType"`                  // The type of the maintenance, possible values: `PLANNED` or `UNPLANNED`
	Name                             string          `json:"name"`                             // The name of the maintenance window, displayed in the UI
	Suppression                      SuppressionType `json:"suppression"`                      // The type of suppression of alerting and problem detection during the maintenance. Possible Values: `DETECT_PROBLEMS_AND_ALERT`, `DETECT_PROBLEMS_DONT_ALERT`, `DONT_DETECT_PROBLEMS`
}

func (*GeneralProperties) MarshalHCL 

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

func (*GeneralProperties) Schema 

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

func (*GeneralProperties) UnmarshalHCL 

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

type MaintenanceType 

type MaintenanceType string

type MonthlyRecurrence 

type MonthlyRecurrence struct {
	DayOfMonth      int              `json:"dayOfMonth"`      // The day of the month for monthly maintenance. If the selected day does not fall within the month, the maintenance window will be active on the last day of the month.
	RecurrenceRange *RecurrenceRange `json:"recurrenceRange"` // The recurrence date range of the maintenance window
	TimeWindow      *TimeWindow      `json:"timeWindow"`      // The time window of the maintenance window
}

func (*MonthlyRecurrence) MarshalHCL 

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

func (*MonthlyRecurrence) Schema 

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

func (*MonthlyRecurrence) UnmarshalHCL 

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

type OnceRecurrence 

type OnceRecurrence struct {
	EndTime   string `json:"endTime"`   // The end time of the maintenance window validity period in YYYY-MM-DDThh:mm:ss format (for example, `2022-01-01T08:00:00`)
	StartTime string `json:"startTime"` // The start time of the maintenance window validity period in YYYY-MM-DDThh:mm:ss format (for example, `2022-01-01T08:00:00`)
	TimeZone  string `json:"timeZone"`  // 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`)
}

Maintenance window. The date time window when the maintenance will take place once.

func (*OnceRecurrence) MarshalHCL 

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

func (*OnceRecurrence) Schema 

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

func (*OnceRecurrence) UnmarshalHCL 

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

type RecurrenceRange 

type RecurrenceRange struct {
	ScheduleEndDate   string `json:"scheduleEndDate"`   // The end date of the recurrence range in YYYY-MM-DD format
	ScheduleStartDate string `json:"scheduleStartDate"` // The start date of the recurrence range in YYYY-MM-DD format
}

Recurrence range. The date range in which maintenance is activated during the specified time window.

func (*RecurrenceRange) MarshalHCL 

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

func (*RecurrenceRange) Schema 

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

func (*RecurrenceRange) UnmarshalHCL 

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

type Schedule 

type Schedule struct {
	DailyRecurrence   *DailyRecurrence   `json:"dailyRecurrence,omitempty"`   // The configuration for maintenance windows occuring daily
	MonthlyRecurrence *MonthlyRecurrence `json:"monthlyRecurrence,omitempty"` // The configuration for maintenance windows occuring monthly
	OnceRecurrence    *OnceRecurrence    `json:"onceRecurrence,omitempty"`    // The configuration for maintenance windows occuring daily once
	ScheduleType      ScheduleType       `json:"scheduleType"`                // The type maintenance window, possible values: `DAILY`, `MONTHLY`, `ONCE`, `WEEKLY`
	WeeklyRecurrence  *WeeklyRecurrence  `json:"weeklyRecurrence,omitempty"`  // The configuration for maintenance windows occuring weekly
}

func (*Schedule) HandlePreconditions 

func (me *Schedule) HandlePreconditions() error

func (*Schedule) MarshalHCL 

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

func (*Schedule) Schema 

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

func (*Schedule) UnmarshalHCL 

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

type ScheduleType 

type ScheduleType string

type Settings 

type Settings struct {
	Enabled           bool               `json:"enabled"`           // This setting is enabled (`true`) or disabled (`false`)
	Filters           Filters            `json:"filters,omitempty"` // ## Filters\nAdd filters to limit the scope of maintenance to only select matching entities. If no filter is defined, the maintenance window is valid for the whole environment. Each filter is evaluated separately (**OR**).
	GeneralProperties *GeneralProperties `json:"generalProperties"` // The general properties of the maintenance window
	Schedule          *Schedule          `json:"schedule"`          // The schedule of the maintenance window
	LegacyID          *string            `json:"-"`
}

func (*Settings) EnsurePredictableOrder 

func (me *Settings) EnsurePredictableOrder()

func (*Settings) MarshalHCL 

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

func (*Settings) Name 

func (me *Settings) Name() string

func (*Settings) Schema 

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

func (*Settings) UnmarshalHCL 

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

type SuppressionType 

type SuppressionType string

type TimeWindow 

type TimeWindow struct {
	EndTime   string `json:"endTime"`   // The end time of the maintenance window validity period in hh:mm:ss format
	StartTime string `json:"startTime"` // The start time of the maintenance window validity period in hh:mm:ss format
	TimeZone  string `json:"timeZone"`  // 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`)
}

Time window. The time window when the maintenance will take place.

func (*TimeWindow) MarshalHCL 

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

func (*TimeWindow) Schema 

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

func (*TimeWindow) UnmarshalHCL 

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

type WeeklyRecurrence 

type WeeklyRecurrence struct {
	DayOfWeek       DayOfWeekType    `json:"dayOfWeek"`       // The day of the week for weekly maintenance, possible values: `FRIDAY`, `MONDAY`, `SATURDAY`, `SUNDAY`, `THURSDAY`, `TUESDAY`, `WEDNESDAY`
	RecurrenceRange *RecurrenceRange `json:"recurrenceRange"` // The recurrence date range of the maintenance window
	TimeWindow      *TimeWindow      `json:"timeWindow"`      // The time window of the maintenance window
}

func (*WeeklyRecurrence) MarshalHCL 

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

func (*WeeklyRecurrence) Schema 

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

func (*WeeklyRecurrence) UnmarshalHCL 

func (me *WeeklyRecurrence) UnmarshalHCL(decoder hcl.Decoder) 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.