maintenance

package
v1.32.1 Latest Latest
Warning

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

 Go to latest Published: Jun 7, 2023 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
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

View Source 
var MaintenanceWindowTypes = struct {
	Planned   WindowType
	Unplanned WindowType
}{
	"PLANNED",
	"UNPLANNED",
}

MaintenanceWindowTypes offers the known enum values

View Source 
var ScheduleTypes = struct {
	Once    ScheduleType
	Daily   ScheduleType
	Weekly  ScheduleType
	Monthly ScheduleType
}{
	"ONCE",
	"DAILY",
	"WEEKLY",
	"MONTHLY",
}

ScheduleTypes offers the known enum values

View Source 
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

Functions

This section is empty.

Types

type DailyRecurrence 

type DailyRecurrence struct {
	TimeWindow      *TimeWindow      `json:"timeWindow"`      // The time window of the maintenance window
	RecurrenceRange *RecurrenceRange `json:"recurrenceRange"` // The recurrence date range 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 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 {
	EntityType      *string  `json:"entityType,omitempty"`      // Type of entities this maintenance window should match
	EntityId        *string  `json:"entityId,omitempty"`        // A specific entity that should match this maintenance window
	EntityTags      []string `json:"entityTags,omitempty"`      // The tags you want to use for matching in the format key or key:value
	ManagementZones []string `json:"managementZones,omitempty"` // The IDs of management zones to which the matched entities must belong
}

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 {
	Name             string      `json:"name"`                             // The name of the maintenance window, displayed in the UI.
	Description      *string     `json:"description,omitempty"`            // A short description of the maintenance purpose.
	Type             WindowType  `json:"maintenanceType"`                  // The type of the maintenance: planned or unplanned
	Suppression      Suppression `json:"suppression"`                      // The type of suppression of alerting and problem detection during the maintenance.
	DisableSynthetic bool        `json:"disableSyntheticMonitorExecution"` // Suppress execution of synthetic monitors during the maintenance
}

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 MaintenanceWindow 

type MaintenanceWindow struct {
	Enabled           bool               `json:"enabled"`           // The maintenance window is enabled or disabled
	GeneralProperties *GeneralProperties `json:"generalProperties"` // The general properties of the maintenance window
	Schedule          *Schedule          `json:"schedule"`          // The schedule of the maintenance window
	Filters           Filters            `json:"filters,omitempty"` // The filters of the maintenance window
	LegacyID          *string            `json:"-"`
}

MaintenanceWindow TODO: documentation

func (*MaintenanceWindow) EnsurePredictableOrder 

func (me *MaintenanceWindow) EnsurePredictableOrder()

func (*MaintenanceWindow) MarshalHCL 

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

func (*MaintenanceWindow) Name 

func (me *MaintenanceWindow) Name() string

func (*MaintenanceWindow) Schema 

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

func (*MaintenanceWindow) UnmarshalHCL 

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

type MonthlyRecurrence 

type MonthlyRecurrence struct {
	DayOfMonth      *int32           `json:"dayOfMonth"`      // 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.	TimeWindow      TimeWindow      `json:"timeWindow"`
	TimeWindow      *TimeWindow      `json:"timeWindow"`      // The time window of the maintenance window
	RecurrenceRange *RecurrenceRange `json:"recurrenceRange"` // The recurrence date range 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 {
	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`)
	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`)
	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`)
}

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 {
	StartDate string `json:"scheduleStartDate"` // The start date of the recurrence range in YYYY-MM-DD format
	EndDate   string `json:"scheduleEndDate"`   // The end date of the recurrence range in YYYY-MM-DD format
}

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 {
	Type              ScheduleType       `json:"scheduleType"`
	OnceRecurrence    *OnceRecurrence    `json:"onceRecurrence,omitempty"`
	DailyRecurrence   *DailyRecurrence   `json:"dailyRecurrence,omitempty"`
	WeeklyRecurrence  *WeeklyRecurrence  `json:"weeklyRecurrence,omitempty"`
	MonthlyRecurrence *MonthlyRecurrence `json:"monthlyRecurrence,omitempty"`
}

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

ScheduleType The type of the maintenance: planned or unplanned.

type Suppression 

type Suppression string

Suppression The type of suppression of alerting and problem detection during the maintenance.

type TimeWindow 

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

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       DayOfWeek        `json:"dayOfWeek"`       // The day of the week for weekly maintenance.  The format is the full name of the day in upper case, for example `THURSDAY`.
	TimeWindow      *TimeWindow      `json:"timeWindow"`      // The time window of the maintenance window
	RecurrenceRange *RecurrenceRange `json:"recurrenceRange"` // The recurrence date range 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

type WindowType 

type WindowType string

WindowType The type of the maintenance: planned or unplanned.

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.