client

package
v0.0.1 Latest Latest
Warning

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

Go to latest
Published: May 19, 2025 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package client provides primitives to interact with the openapi HTTP API.

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MaintenanceResourceId

type MaintenanceResourceId = string

MaintenanceResourceId The Id of a resource that can undergo maintenance (Id of a service, a Postgres instance, or a Redis instance)

type MaintenanceResourcesParam

type MaintenanceResourcesParam = []MaintenanceResourceId

MaintenanceResourcesParam defines model for maintenanceResourcesParam.

type MaintenanceRun

type MaintenanceRun struct {
	Id MaintenanceRunId `json:"id"`

	// PendingMaintenanceBy If present, the maintenance run cannot be scheduled for later than this date-time.
	PendingMaintenanceBy *time.Time       `json:"pendingMaintenanceBy,omitempty"`
	ScheduledAt          time.Time        `json:"scheduledAt"`
	State                MaintenanceState `json:"state"`
	Type                 string           `json:"type"`
}

MaintenanceRun defines model for maintenanceRun.

type MaintenanceRunId

type MaintenanceRunId = string

MaintenanceRunId defines model for maintenanceRunId.

type MaintenanceRunPATCH

type MaintenanceRunPATCH struct {
	// ScheduledAt The date-time at which the maintenance is scheduled to start. This must be before the pendingMaintenanceBy date-time.
	ScheduledAt *time.Time `json:"scheduledAt,omitempty"`
}

MaintenanceRunPATCH defines model for maintenanceRunPATCH.

type MaintenanceRunParam

type MaintenanceRunParam = MaintenanceRunId

MaintenanceRunParam defines model for maintenanceRunParam.

type MaintenanceRunWithResource

type MaintenanceRunWithResource struct {
	Id MaintenanceRunId `json:"id"`

	// PendingMaintenanceBy If present, the maintenance run cannot be scheduled for later than this date-time.
	PendingMaintenanceBy *time.Time `json:"pendingMaintenanceBy,omitempty"`

	// ResourceId The Id of a resource that can undergo maintenance (Id of a service, a Postgres instance, or a Redis instance)
	ResourceId  MaintenanceResourceId `json:"resourceId"`
	ScheduledAt time.Time             `json:"scheduledAt"`
	State       MaintenanceState      `json:"state"`
	Type        string                `json:"type"`
}

MaintenanceRunWithResource defines model for maintenanceRunWithResource.

type MaintenanceState

type MaintenanceState string

MaintenanceState defines model for maintenanceState.

const (
	Cancelled       MaintenanceState = "cancelled"
	Failed          MaintenanceState = "failed"
	InProgress      MaintenanceState = "in_progress"
	Scheduled       MaintenanceState = "scheduled"
	Succeeded       MaintenanceState = "succeeded"
	UserFixRequired MaintenanceState = "user_fix_required"
)

Defines values for MaintenanceState.

type MaintenanceStateParam

type MaintenanceStateParam = []MaintenanceState

MaintenanceStateParam defines model for maintenanceStateParam.

Jump to

Keyboard shortcuts

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