model

package
v1.6.8 Latest Latest
Warning

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

 Go to latest Published: May 8, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	EventTypeScheduled = "scheduled"
	EventTypeReminder  = "reminder"
	EventTypeImmediate = "immediate"
)

Maintenance event types

View Source 
const (
	CompletionStatusSuccess   = "success"
	CompletionStatusCancelled = "cancelled"
	CompletionStatusSkipped   = "skipped"
)

Completion status types

View Source 
const (
	// AmenityTypeKubernetesManifest is the type identifier for Kubernetes manifest amenities
	AmenityTypeKubernetesManifest = "KubernetesManifest"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Account 

type Account struct {
	ID              string `json:"id"`
	Name            string `json:"name"`
	Status          string `json:"status"`
	CloudProvider   string `json:"cloud_provider"`
	TargetAccountID string `json:"target_account_id"`
}

type AmenitiesConfiguration added in v0.14.18 

type AmenitiesConfiguration struct {
	// Organization identifier (comes from credentials)
	OrganizationID string `json:"organization_id"`

	// Environment this configuration applies to - using environment type instead of string
	EnvironmentType string `json:"environment_type"`

	// Configuration template data
	ConfigurationTemplate map[string]interface{} `json:"configuration_template"`

	// Metadata
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
	Version   string    `json:"version"`
}

AmenitiesConfiguration represents the organization-level amenities configuration

func (AmenitiesConfiguration) ToTableView added in v0.14.18 

func (ac AmenitiesConfiguration) ToTableView() AmenitiesConfigurationTableView

ToTableView converts AmenitiesConfiguration to table-friendly view

type AmenitiesConfigurationTableView added in v0.14.18 

type AmenitiesConfigurationTableView struct {
	OrganizationID  string    `json:"organization_id"`
	EnvironmentType string    `json:"environment_type"`
	Version         string    `json:"version"`
	UpdatedAt       time.Time `json:"updated_at"`
	ConfigCount     int       `json:"config_count"` // Number of configuration items
}

AmenitiesConfigurationTableView provides a simplified view for table display

type AmenitiesEnvironment added in v0.14.18 

type AmenitiesEnvironment struct {
	Name        string `json:"name"`
	DisplayName string `json:"display_name"`
	Description string `json:"description"`
}

AmenitiesEnvironment represents an environment configuration context

type Amenity added in v0.14.18 

type Amenity struct {
	Name        string                 `json:"name" yaml:"name"`
	Description *string                `json:"description,omitempty" yaml:"description,omitempty"`
	Type        *string                `json:"type,omitempty" yaml:"type,omitempty"`
	Properties  map[string]interface{} `json:"properties,omitempty" yaml:"properties,omitempty"`
}

Amenity represents an amenity in the deployment cell

func ProcessManifestAmenities added in v1.0.54 

func ProcessManifestAmenities(amenities []Amenity, baseDir string) ([]Amenity, error)

ProcessManifestAmenities processes all amenities and converts file-based manifest references to inline definitions. The baseDir is used to resolve relative file paths.

type AmenityConfig added in v0.14.18 

type AmenityConfig struct {
	Name        string                 `json:"name" yaml:"name"`
	Modifiable  *bool                  `json:"modifiable,omitempty" yaml:"modifiable,omitempty"`
	Description *string                `json:"description,omitempty" yaml:"description,omitempty"`
	IsManaged   *bool                  `json:"isManaged,omitempty" yaml:"isManaged,omitempty"`
	Type        *string                `json:"type,omitempty" yaml:"type,omitempty"`
	Properties  map[string]interface{} `json:"properties,omitempty" yaml:"properties,omitempty"`
}

AmenityConfig represents an amenity configuration in a more structured format

type ConfigurationDrift added in v0.14.18 

type ConfigurationDrift struct {
	Path         string      `json:"path"`          // JSON path to the drifted configuration
	CurrentValue interface{} `json:"current_value"` // Current value in deployment cell
	TargetValue  interface{} `json:"target_value"`  // Expected value from organization template
	DriftType    string      `json:"drift_type"`    // Type of drift: "missing", "extra", "different"
}

ConfigurationDrift represents a specific configuration drift

type CustomNetwork 

type CustomNetwork struct {
	CustomNetworkID              string `json:"custom_network_id"`
	CustomNetworkName            string `json:"custom_network_name"`
	CloudProvider                string `json:"cloud_provider"`
	Region                       string `json:"region"`
	CIDR                         string `json:"cidr"`
	OwningOrgID                  string `json:"owning_org_id"`
	OwningOrgName                string `json:"owning_org_name"`
	AwsAccountID                 string `json:"aws_account_id"`
	CloudProviderNativeNetworkId string `json:"cloud_provider_native_network_id"`
	GcpProjectID                 string `json:"gcp_project_id"`
	GcpProjectNumber             string `json:"gcp_project_number"`
	HostClusterID                string `json:"host_cluster_id"`
	Status                       string `json:"status"`
}

type CustomNetworkInfo 

type CustomNetworkInfo struct {
	ID      *string `json:"id,omitempty"`
	Name    *string `json:"name,omitempty"`
	CIDR    *string `json:"cidr,omitempty"`
	OrgName *string `json:"org_name,omitempty"`
}

CustomNetworkInfo represents custom network configuration

type DeploymentCell 

type DeploymentCell struct {
	// Basic identification
	ID          string `json:"id"`
	Key         string `json:"key,omitempty"` // Optional key for easier identification
	Status      string `json:"status"`
	Type        string `json:"type"`
	Description string `json:"description"`

	// Infrastructure details
	CloudProvider      string `json:"cloud_provider"`
	Region             string `json:"region"`
	RegionID           string `json:"region_id"`
	AccountID          string `json:"account_id"`
	AccountConfigID    string `json:"account_config_id"`
	IsCustomDeployment bool   `json:"is_custom_deployment"`

	// Deployment information
	CurrentNumberOfDeployments int64 `json:"current_number_of_deployments"`

	// Health status summary
	HealthStatus DeploymentCellHealthStatus `json:"health_status"`

	// Network configuration
	CustomNetwork *CustomNetworkInfo `json:"custom_network,omitempty"`

	// Kubernetes details
	KubernetesDashboardEndpoint *string `json:"kubernetes_dashboard_endpoint,omitempty"`

	// Helm packages
	HelmPackages []HelmPackageInfo `json:"helm_packages,omitempty"`

	Amenities []Amenity `json:"amenities,omitempty"`

	InSyncWithTemplate bool `json:"in_sync_with_template,omitempty"`

	// Additional metadata
	Role      *string `json:"role,omitempty"`
	ModelType *string `json:"model_type,omitempty"`

	// Customer metadata
	CustomerEmail            *string `json:"customer_email,omitempty"`
	CustomerOrganizationName *string `json:"customer_organization_name,omitempty"`
}

DeploymentCell represents a complete view of a host cluster/deployment cell

func (DeploymentCell) ToTableView 

func (dc DeploymentCell) ToTableView() DeploymentCellTableView

ToTableView converts a DeploymentCell to a table-friendly view

type DeploymentCellAmenitiesStatus added in v0.14.18 

type DeploymentCellAmenitiesStatus struct {
	// Deployment cell identifier
	DeploymentCellID string `json:"deployment_cell_id"`

	// Current configuration
	CurrentConfiguration map[string]interface{} `json:"current_configuration,omitempty"`

	// Target configuration from organization template
	TargetConfiguration map[string]interface{} `json:"target_configuration,omitempty"`

	// Drift detection results
	HasConfigurationDrift bool                 `json:"has_configuration_drift"`
	DriftDetails          []ConfigurationDrift `json:"drift_details,omitempty"`

	// Pending changes information
	HasPendingChanges bool                         `json:"has_pending_changes"`
	PendingChanges    []PendingConfigurationChange `json:"pending_changes,omitempty"`

	// Status and timestamps
	Status    string    `json:"status"`
	LastCheck time.Time `json:"last_check"`
}

DeploymentCellAmenitiesStatus represents the status of amenities configuration for a deployment cell

func (DeploymentCellAmenitiesStatus) ToTableView added in v0.14.18 

func (dcas DeploymentCellAmenitiesStatus) ToTableView() DeploymentCellAmenitiesTableView

ToTableView converts DeploymentCellAmenitiesStatus to table-friendly view

type DeploymentCellAmenitiesTableView added in v0.14.18 

type DeploymentCellAmenitiesTableView struct {
	DeploymentCellID      string    `json:"deployment_cell_id"`
	Status                string    `json:"status"`
	HasConfigurationDrift bool      `json:"has_configuration_drift"`
	HasPendingChanges     bool      `json:"has_pending_changes"`
	DriftCount            int       `json:"drift_count"`
	PendingChangesCount   int       `json:"pending_changes_count"`
	LastCheck             time.Time `json:"last_check"`
}

DeploymentCellAmenitiesTableView provides a simplified view for table display

type DeploymentCellHealthStatus 

type DeploymentCellHealthStatus struct {
	OverallStatus                 string             `json:"overall_status"`
	StatusMessage                 *string            `json:"status_message,omitempty"`
	TotalEntities                 int64              `json:"total_entities"`
	HealthyEntities               int64              `json:"healthy_entities"`
	FailedEntities                int64              `json:"failed_entities"`
	EntitiesByType                map[string]int64   `json:"entities_by_type,omitempty"`
	HealthyEntitiesByType         map[string]int64   `json:"healthy_entities_by_type,omitempty"`
	FailedEntitiesByType          map[string]int64   `json:"failed_entities_by_type,omitempty"`
	FailedEntityDetails           []EntityHealthInfo `json:"failed_entity_details,omitempty"`
	KubernetesControlPlaneVersion string             `json:"kubernetes_control_plane_version,omitempty"`
}

DeploymentCellHealthStatus represents the health status of a deployment cell

func (DeploymentCellHealthStatus) String 

func (h DeploymentCellHealthStatus) String() string

String provides a readable representation of the health status for table display

type DeploymentCellTableView 

type DeploymentCellTableView struct {
	ID                         string  `json:"id"`
	CustomerEmail              *string `json:"customer_email"`
	CustomerOrganizationName   *string `json:"customer_organization_name"`
	Status                     string  `json:"status"`
	Type                       string  `json:"type"`
	CloudProvider              string  `json:"cloud_provider"`
	Region                     string  `json:"region"`
	CurrentNumberOfDeployments int64   `json:"current_number_of_deployments"`
	HealthStatus               string  `json:"health_status"`
}

DeploymentCellTableView returns a simplified view of the deployment cell for table display

type DeploymentCellTemplate added in v0.14.18 

type DeploymentCellTemplate struct {
	ManagedAmenities []Amenity `json:"managed_amenities,omitempty" yaml:"managedAmenities,omitempty"`
	CustomAmenities  []Amenity `json:"custom_amenities,omitempty" yaml:"customAmenities,omitempty"`
}

DeploymentCellTemplate represents a template structure for API responses

type DetailedEnvironment 

type DetailedEnvironment struct {
	EnvironmentID    string `json:"environment_id,omitempty"`
	EnvironmentName  string `json:"environment_name,omitempty"`
	EnvironmentType  string `json:"environment_type,omitempty"`
	ServiceID        string `json:"service_id,omitempty"`
	ServiceName      string `json:"service_name,omitempty"`
	SourceEnvName    string `json:"source_env_name,omitempty"`
	PromoteStatus    string `json:"promote_status,omitempty"`
	SaaSPortalStatus string `json:"saas_portal_status,omitempty"`
	SaaSPortalURL    string `json:"saas_portal_url,omitempty"`
}

type Domain 

type Domain struct {
	EnvironmentType string `json:"environment_type"`
	Name            string `json:"name"`
	Domain          string `json:"domain"`
	Status          string `json:"status"`
	ClusterEndpoint string `json:"cluster_endpoint"`
}

type EntityHealthInfo 

type EntityHealthInfo struct {
	Identifier string  `json:"identifier"`
	Type       string  `json:"type"`
	SyncStatus string  `json:"sync_status"`
	Error      *string `json:"error,omitempty"`
}

EntityHealthInfo represents detailed health information for a specific entity

type Environment 

type Environment struct {
	EnvironmentID   string `json:"environment_id"`
	EnvironmentName string `json:"environment_name"`
	EnvironmentType string `json:"environment_type"`
	ServiceID       string `json:"service_id"`
	ServiceName     string `json:"service_name"`
	SourceEnvName   string `json:"source_env_name"`
}

type HelmPackageInfo 

type HelmPackageInfo struct {
	ChartName     string                 `json:"chart_name"`
	ChartVersion  string                 `json:"chart_version"`
	ChartRepoName string                 `json:"chart_repo_name"`
	ChartRepoURL  string                 `json:"chart_repo_url"`
	Namespace     string                 `json:"namespace"`
	ChartValues   map[string]interface{} `json:"chart_values,omitempty"`
}

HelmPackageInfo represents a Helm package installed on the cluster

type Instance 

type Instance struct {
	InstanceID     string `json:"instance_id"`
	Service        string `json:"service"`
	Environment    string `json:"environment"`
	Plan           string `json:"plan"`
	Version        string `json:"version"`
	Resource       string `json:"resource"`
	CloudProvider  string `json:"cloud_provider"`
	Region         string `json:"region"`
	Status         string `json:"status"`
	SubscriptionID string `json:"subscription_id"`
	Tags           string `json:"tags"`
}

type InternalAmenity added in v0.14.18 

type InternalAmenity struct {
	Name        string                 `json:"name" yaml:"name"`
	Description *string                `json:"description,omitempty" yaml:"description,omitempty"`
	Type        *string                `json:"type,omitempty" yaml:"type,omitempty"`
	IsManaged   *bool                  `json:"isManaged,omitempty" yaml:"isManaged,omitempty"`
	Properties  map[string]interface{} `json:"properties,omitempty" yaml:"properties,omitempty"`
}

type ManifestEntry added in v1.0.54 

type ManifestEntry struct {
	File string                 `json:"file,omitempty" yaml:"file,omitempty"`
	Def  map[string]interface{} `json:"def,omitempty" yaml:"def,omitempty"`
}

ManifestEntry represents a single manifest entry which can be either a file reference or an inline definition

func (ManifestEntry) Validate added in v1.0.54 

func (e ManifestEntry) Validate(index int) error

Validate checks that the manifest entry has exactly one of file or def set

type ManifestProperties added in v1.0.54 

type ManifestProperties struct {
	Manifests []ManifestEntry `json:"manifests,omitempty" yaml:"manifests,omitempty"`
}

ManifestProperties represents the properties structure for a manifest amenity

func (ManifestProperties) Validate added in v1.0.54 

func (p ManifestProperties) Validate() error

Validate checks that the manifest properties are valid

type NodepoolDescribeView added in v1.0.34 

type NodepoolDescribeView struct {
	Name          string `json:"name"`
	Type          string `json:"type"`
	MachineType   string `json:"machineType,omitempty"`
	ImageType     string `json:"imageType,omitempty"`
	MinNodes      int64  `json:"minNodes"`
	MaxNodes      int64  `json:"maxNodes"`
	CurrentNodes  int64  `json:"currentNodes"`
	Location      string `json:"location,omitempty"`
	AutoRepair    bool   `json:"autoRepair,omitempty"`
	AutoUpgrade   bool   `json:"autoUpgrade,omitempty"`
	AutoScaling   bool   `json:"autoScaling,omitempty"`
	CapacityType  string `json:"capacityType,omitempty"`
	PrivateSubnet bool   `json:"privateSubnet,omitempty"`
}

NodepoolDescribeView represents a table view of a nodepool for describe operations

type NodepoolTableView added in v1.0.34 

type NodepoolTableView struct {
	Name          string `json:"name"`
	Type          string `json:"type"`
	MachineType   string `json:"machineType,omitempty"`
	ImageType     string `json:"imageType,omitempty"`
	MinNodes      int64  `json:"minNodes"`
	MaxNodes      int64  `json:"maxNodes"`
	Location      string `json:"location,omitempty"`
	AutoRepair    bool   `json:"autoRepair,omitempty"`
	AutoUpgrade   bool   `json:"autoUpgrade,omitempty"`
	AutoScaling   bool   `json:"autoScaling,omitempty"`
	CapacityType  string `json:"capacityType,omitempty"`
	PrivateSubnet bool   `json:"privateSubnet,omitempty"`
}

NodepoolTableView represents a table view of a nodepool for list operations

type PendingConfigurationChange added in v0.14.18 

type PendingConfigurationChange struct {
	Path      string      `json:"path"`                // JSON path of the configuration
	Operation string      `json:"operation"`           // Operation type: "add", "update", "delete"
	OldValue  interface{} `json:"old_value,omitempty"` // Current value (for update/delete)
	NewValue  interface{} `json:"new_value,omitempty"` // New value (for add/update)
}

PendingConfigurationChange represents a pending change to be applied

type Promotion 

type Promotion struct {
	ServiceID             string `json:"service_id"`
	ServiceName           string `json:"service_name"`
	SourceEnvironmentID   string `json:"source_environment_id"`
	SourceEnvironmentName string `json:"source_environment_name"`
	TargetEnvID           string `json:"target_env_id"`
	TargetEnvName         string `json:"target_env_name"`
	PromoteStatus         string `json:"promote_status"`
}

type Resource 

type Resource struct {
	ResourceID                  string `json:"resource_id,omitempty"`
	ResourceName                string `json:"resource_name,omitempty"`
	ResourceDescription         string `json:"resource_description,omitempty"`
	ResourceType                string `json:"resource_type,omitempty"`
	ActionHooks                 any    `json:"action_hooks,omitempty"`
	AdditionalSecurityContext   any    `json:"additional_security_context,omitempty"`
	BackupConfiguration         any    `json:"backup_configuration,omitempty"`
	Capabilities                any    `json:"capabilities,omitempty"`
	CustomLabels                any    `json:"custom_labels,omitempty"`
	CustomSysCTLs               any    `json:"custom_sysctls,omitempty"`
	CustomULimits               any    `json:"custom_ulimits,omitempty"`
	Dependencies                any    `json:"dependencies,omitempty"`
	EnvironmentVariables        any    `json:"environment_variables,omitempty"`
	FileSystemConfiguration     any    `json:"file_system_configuration,omitempty"`
	HelmChartConfiguration      any    `json:"helm_chart_configuration,omitempty"`
	KustomizeConfiguration      any    `json:"kustomize_configuration,omitempty"`
	L4LoadBalancerConfiguration any    `json:"l4_load_balancer_configuration,omitempty"`
	L7LoadBalancerConfiguration any    `json:"l7_load_balancer_configuration,omitempty"`
	OperatorCRDConfiguration    any    `json:"operator_crd_configuration,omitempty"`
}

type ResourceChangeSet 

type ResourceChangeSet struct {
	ResourceName              string `json:"resource_name,omitempty"`
	ResourceChanges           any    `json:"resource_changes,omitempty"`
	ProductTierFeatureChanges any    `json:"product_tier_feature_changes,omitempty"`
	ImageConfigChanges        any    `json:"image_config_changes,omitempty"`
	InfraConfigChanges        any    `json:"infra_config_changes,omitempty"`
}

type ResourceStatus added in v1.0.17 

type ResourceStatus string

ResourceStatus represents the status of a resource as a string 

const (
	ResourceStatusUnknown   ResourceStatus = "UNKNOWN"
	ResourceStatusCompleted ResourceStatus = "COMPLETED"
	ResourceStatusFailed    ResourceStatus = "FAILED"
	ResourceStatusPending   ResourceStatus = "PENDING"
	ResourceStatusRunning   ResourceStatus = "RUNNING"
)

func (ResourceStatus) String added in v1.0.17 

func (v ResourceStatus) String() string

type Secret added in v0.13.31 

type Secret struct {
	EnvironmentType string `json:"environment_type"`
	Name            string `json:"name"`
	Value           string `json:"value,omitempty"`
}

type SecretList added in v0.13.31 

type SecretList struct {
	Secrets []Secret `json:"secrets"`
}

type Service 

type Service struct {
	ID           string `json:"id"`
	Name         string `json:"name"`
	Environments string `json:"environments"`
}

type ServicePlan 

type ServicePlan struct {
	PlanID         string `json:"plan_id,omitempty"`
	PlanName       string `json:"plan_name,omitempty"`
	ServiceID      string `json:"service_id,omitempty"`
	ServiceName    string `json:"service_name,omitempty"`
	Environment    string `json:"environment,omitempty"`
	DeploymentType string `json:"deployment_type,omitempty"`
	TenancyType    string `json:"tenancy_type,omitempty"`
}

type ServicePlanDetails 

type ServicePlanDetails struct {
	PlanID          string                       `json:"plan_id,omitempty"`
	PlanName        string                       `json:"plan_name,omitempty"`
	ServiceID       string                       `json:"service_id,omitempty"`
	ServiceName     string                       `json:"service_name,omitempty"`
	Environment     string                       `json:"environment,omitempty"`
	DeploymentType  string                       `json:"deployment_type,omitempty"`
	TenancyType     string                       `json:"tenancy_type,omitempty"`
	EnabledFeatures any                          `json:"enabled_features,omitempty"`
	Resources       []Resource                   `json:"resources,omitempty"`
	PendingChanges  map[string]ResourceChangeSet `json:"pending_changes,omitempty"`
}

type ServicePlanVersion 

type ServicePlanVersion struct {
	PlanID                         string `json:"plan_id,omitempty"`
	PlanName                       string `json:"plan_name,omitempty"`
	ServiceID                      string `json:"service_id,omitempty"`
	ServiceName                    string `json:"service_name,omitempty"`
	Environment                    string `json:"environment,omitempty"`
	Version                        string `json:"version,omitempty"`
	ReleaseDescription             string `json:"release_description,omitempty"`
	VersionSetStatus               string `json:"version_set_status,omitempty"`
	IsNewServicePlanVersionCreated bool   `json:"is_new_service_plan_version_created,omitempty"`
}

type ServicePlanVersionDetails 

type ServicePlanVersionDetails struct {
	PlanID             string     `json:"plan_id,omitempty"`
	PlanName           string     `json:"plan_name,omitempty"`
	ServiceID          string     `json:"service_id,omitempty"`
	ServiceName        string     `json:"service_name,omitempty"`
	Environment        string     `json:"environment,omitempty"`
	Version            string     `json:"version,omitempty"`
	ReleaseDescription string     `json:"release_description,omitempty"`
	VersionSetStatus   string     `json:"version_set_status,omitempty"`
	EnabledFeatures    any        `json:"enabled_features,omitempty"`
	Resources          []Resource `json:"resources,omitempty"`
}

type ServiceProviderOrg added in v0.14.18 

type ServiceProviderOrg struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

ServiceProviderOrg represents a service provider organization

type Subscription 

type Subscription struct {
	SubscriptionID         string `json:"subscription_id"`
	ServiceID              string `json:"service_id"`
	ServiceName            string `json:"service_name"`
	PlanID                 string `json:"plan_id"`
	PlanName               string `json:"plan_name"`
	Environment            string `json:"environment"`
	SubscriptionOwnerName  string `json:"subscription_owner_name"`
	SubscriptionOwnerEmail string `json:"subscription_owner_email"`
	Status                 string `json:"status"`
}

type Upgrade 

type Upgrade struct {
	UpgradeID             string  `json:"upgrade_id"`
	SourceVersion         string  `json:"source_version"`
	TargetVersion         string  `json:"target_version"`
	InstanceIDs           string  `json:"instance_ids"`
	ScheduledDate         *string `json:"scheduled_date,omitempty"`
	NotifyCustomer        bool    `json:"notify_customer"`
	MaxConcurrentUpgrades *int    `json:"max_concurrent_upgrades,omitempty"`
}

type UpgradeMaintenanceAction 

type UpgradeMaintenanceAction string
const (
	PauseAction          UpgradeMaintenanceAction = "pause"
	ResumeAction         UpgradeMaintenanceAction = "resume"
	CancelAction         UpgradeMaintenanceAction = "cancel"
	NotifyCustomerAction UpgradeMaintenanceAction = "notify-customer"
	SkipInstancesAction  UpgradeMaintenanceAction = "skip-instances"
)

Maintenance actions

func (UpgradeMaintenanceAction) String 

func (a UpgradeMaintenanceAction) String() string

type UpgradePathStatus 

type UpgradePathStatus string

UpgradePathStatus represents the status of an upgrade path 

const (
	InProgress UpgradePathStatus = "IN_PROGRESS"
	Scheduled  UpgradePathStatus = "SCHEDULED"
	Complete   UpgradePathStatus = "COMPLETE"
	Failed     UpgradePathStatus = "FAILED"
	Cancelled  UpgradePathStatus = "CANCELLED"
	Skipped    UpgradePathStatus = "SKIPPED"
	Verifying  UpgradePathStatus = "VERIFYING"
)

func (UpgradePathStatus) String 

func (v UpgradePathStatus) String() string

type UpgradeStatus 

type UpgradeStatus struct {
	UpgradeID      string `json:"upgrade_id"`
	Total          int64  `json:"total"`
	Pending        int64  `json:"pending"`
	InProgress     int64  `json:"in_progress"`
	Completed      int64  `json:"completed"`
	Failed         int64  `json:"failed"`
	Scheduled      *int   `json:"scheduled,omitempty"`
	Skipped        int64  `json:"skipped"`
	Status         string `json:"status"`
	NotifyCustomer bool   `json:"notify_customer"`
}

type UpgradeStatusDetail 

type UpgradeStatusDetail struct {
	UpgradeID            string  `json:"upgrade_id"`
	InstanceID           string  `json:"instance_id"`
	UpgradeStartTime     string  `json:"upgrade_start_time"`
	PlannedExecutionDate *string `json:"planned_execution_date"`
	UpgradeEndTime       string  `json:"upgrade_end_time"`
	UpgradeStatus        string  `json:"upgrade_status"`
}

type WorkflowStatus added in v1.0.17 

type WorkflowStatus string

WorkflowStatus represents the status of a workflow as a string (for consistency with UpgradePathStatus) 

const (
	WorkflowStatusUnknown   WorkflowStatus = "UNKNOWN"
	WorkflowStatusCompleted WorkflowStatus = "COMPLETED"
	WorkflowStatusFailed    WorkflowStatus = "FAILED"
	WorkflowStatusPending   WorkflowStatus = "PENDING"
	WorkflowStatusRunning   WorkflowStatus = "RUNNING"
)

func ParseWorkflowStatus added in v1.0.17 

func ParseWorkflowStatus(apiStatus string) WorkflowStatus

func (WorkflowStatus) String added in v1.0.17 

func (v WorkflowStatus) String() string

type WorkflowStep added in v1.0.17 

type WorkflowStep string

WorkflowStep represents a workflow step as a string 

const (
	WorkflowStepBootstrap   WorkflowStep = "BOOTSTRAP"
	WorkflowStepStorage     WorkflowStep = "STORAGE"
	WorkflowStepNetwork     WorkflowStep = "NETWORK"
	WorkflowStepCompute     WorkflowStep = "COMPUTE"
	WorkflowStepDeployment  WorkflowStep = "DEPLOYMENT"
	WorkflowStepMonitoring  WorkflowStep = "MONITORING"
	WorkflowStepUnknownStep WorkflowStep = "UNKNOWN"
)

func (WorkflowStep) String added in v1.0.17 

func (v WorkflowStep) String() string

type WorkflowStepEventType added in v1.0.17 

type WorkflowStepEventType string

WorkflowStepEventType represents the type of a workflow step event 

const (
	WorkflowStepFailed    WorkflowStepEventType = "WorkflowStepFailed"
	WorkflowStepCompleted WorkflowStepEventType = "WorkflowStepCompleted"
	WorkflowStepDebug     WorkflowStepEventType = "WorkflowStepDebug"
	WorkflowStepStarted   WorkflowStepEventType = "WorkflowStepStarted"
	WorkflowStepPending   WorkflowStepEventType = "WorkflowStepPending"
	WorkflowStepUnknown   WorkflowStepEventType = "WorkflowStepUnknown"
)

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.