types

package
v0.0.9 Latest Latest
Warning

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

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

Documentation

Overview

Package types contains PUBLIC aliases for internal request/response structs.

NOTE: This package uses type aliases to internal definitions as a temporary measure. This should be revisited during a proper refactoring to define stable public types.

Package types contains PUBLIC aliases for internal request/response structs.

NOTE: This package uses type aliases to internal definitions as a temporary measure. This should be revisited during a proper refactoring to define stable public types.

Package types contains PUBLIC aliases for internal request/response structs.

NOTE: This package uses type aliases to internal definitions as a temporary measure. This should be revisited during a proper refactoring to define stable public types.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateUserResponse

type CreateUserResponse = internaltypes.CreateUserResponse

CreateUserResponse defines the structure for the response after creating a user (public alias).

type DeleteInstancesRequest

type DeleteInstancesRequest = internaltypes.DeleteInstancesRequest

DeleteInstancesRequest defines the structure for requesting instance deletion (public alias).

type InstanceRequest

type InstanceRequest = internaltypes.InstanceRequest

InstanceRequest defines the structure for requesting instance creation (public alias).

type ListResponse

type ListResponse[T any] struct {
	Rows  []*T `json:"rows"`
	Total int  `json:"total"`
}

ListResponse is a generic response structure for lists (public alias).

type PublicIPsResponse

type PublicIPsResponse = internaltypes.PublicIPsResponse

PublicIPsResponse defines the structure for the response containing public IPs (public alias).

type Slug added in v0.0.8

type Slug = internaltypes.Slug

Slug is a type alias for internaltypes.Slug.

const (
	SuccessSlug      Slug = internaltypes.SuccessSlug
	ErrorSlug        Slug = internaltypes.ErrorSlug
	InvalidInputSlug Slug = internaltypes.InvalidInputSlug
	ServerErrorSlug  Slug = internaltypes.ServerErrorSlug
	NotFoundSlug     Slug = internaltypes.NotFoundSlug
)

Slug constants (public aliases)

type SlugResponse

type SlugResponse = internaltypes.SlugResponse

SlugResponse represents a response containing a slug and potentially data (public alias). NOTE: We alias the internal type directly here as it's generic enough.

type TaskResponse

type TaskResponse = internaltypes.TaskResponse

TaskResponse represents the detailed response for a task operation (public alias).

type UserResponse

type UserResponse = internaltypes.UserResponse

UserResponse defines the structure for the response containing user details (public alias).

type VolumeConfig

type VolumeConfig = internaltypes.VolumeConfig

VolumeConfig represents the configuration for a volume

type VolumeDetails

type VolumeDetails = internaltypes.VolumeDetails

VolumeDetails represents detailed information about a created volume

Jump to

Keyboard shortcuts

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