kubernetesmonitors

package
v2.89.0 Latest Latest
Warning

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

Go to latest
Published: Nov 12, 2025 License: Apache-2.0 Imports: 4 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DeleteByID

func DeleteByID(client newclient.Client, spaceID string, ID string) error

DeleteByID deletes a Kubernetes Monitor based on the provided ID.

Types

type GetKubernetesMonitorResponse

type GetKubernetesMonitorResponse struct {
	Resource KubernetesMonitor `json:"Resource" validate:"required"`
}

GetKubernetesMonitorResponse represents the response to a request for a Kubernetes monitor.

func GetByID

func GetByID(client newclient.Client, spaceID string, ID string) (*GetKubernetesMonitorResponse, error)

GetByID returns the Kubernetes Monitor that matches the input ID. If one cannot be found, it returns nil and an error.

func (*GetKubernetesMonitorResponse) Validate

func (k *GetKubernetesMonitorResponse) Validate() error

Validate checks the state of the Kubernetes Monitor response and returns an error if invalid.

type KubernetesMonitor

type KubernetesMonitor struct {
	ID             string     `json:"Id" validate:"required"`
	SpaceID        string     `json:"SpaceId" validate:"required"`
	InstallationID *uuid.UUID `json:"InstallationId" validate:"required"`
	MachineID      string     `json:"MachineId" validate:"required"`
}

KubernetesMonitor represents an installation of the Kubernetes Monitor.

func (*KubernetesMonitor) Validate

func (k *KubernetesMonitor) Validate() error

Validate checks the state of the Kubernetes monitor and returns an error if invalid.

type RegisterKubernetesMonitorCommand

type RegisterKubernetesMonitorCommand struct {
	InstallationID              *uuid.UUID `json:"InstallationId" validate:"required"`
	MachineID                   string     `json:"MachineId" validate:"required"`
	SpaceID                     string     `json:"SpaceId,omitempty"`
	PreserveAuthenticationToken *bool      `json:"PreserveAuthenticationToken,omitempty"`
}

RegisterKubernetesMonitorCommand represents a command to register a Kubernetes monitor.

func NewRegisterKubernetesMonitorCommand

func NewRegisterKubernetesMonitorCommand(
	installationID *uuid.UUID, machineID string,
) *RegisterKubernetesMonitorCommand

NewRegisterKubernetesMonitorCommand creates a new Kubernetes monitor registration command with the specified parameters.

func (*RegisterKubernetesMonitorCommand) Validate

Validate checks the state of the Kubernetes monitor registration command and returns an error if invalid.

type RegisterKubernetesMonitorResponse

type RegisterKubernetesMonitorResponse struct {
	Resource              KubernetesMonitor `json:"Resource" validate:"required"`
	AuthenticationToken   *string           `json:"AuthenticationToken,omitempty"`
	CertificateThumbprint string            `json:"CertificateThumbprint" validate:"required"`
}

RegisterKubernetesMonitorResponse represents the successful response to a completed registration command for a Kubernetes Monitor.

func NewRegisterKubernetesMonitorResponse

func NewRegisterKubernetesMonitorResponse(
	monitor KubernetesMonitor, authenticationToken *string, certificateThumbprint string,
) *RegisterKubernetesMonitorResponse

NewRegisterKubernetesMonitorResponse creates a new Kubernetes monitor registration response with the specified parameters.

func Register

Register registers the given Kubernetes Monitor parameters with the Octopus Deploy server.

func (*RegisterKubernetesMonitorResponse) Validate

Validate checks the state of the Kubernetes monitor registration command and returns an error if invalid.

Jump to

Keyboard shortcuts

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