v1alpha1

package
v0.0.0-...-4f6fde9 Latest Latest
Warning

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

Go to latest
Published: Aug 31, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

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

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

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSpec

func GetSpec() (swagger *openapi3.T, err error)

GetSpec returns the OpenAPI specification corresponding to the generated code in this file. External references in the spec are resolved through PathToRawSpec; externally-referenced files must be embedded in their corresponding Go packages (via the import-mapping feature). URL-based external refs are not supported.

func GetSpecJSON

func GetSpecJSON() ([]byte, error)

GetSpecJSON returns the raw JSON bytes of the embedded OpenAPI specification: decompressed but not unmarshaled. External references are not resolved here; the bytes are the spec exactly as embedded by codegen. The result is cached at package init time, so repeated calls are cheap.

func GetSwagger deprecated

func GetSwagger() (*openapi3.T, error)

GetSwagger returns the OpenAPI specification corresponding to the generated code in this file.

Deprecated: GetSwagger predates kin-openapi renaming openapi3.Swagger to openapi3.T. Use GetSpec instead. This wrapper is retained for backwards compatibility.

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

func PostPath

func PostPath() (string, error)

PostPath returns the first path that defines a POST operation in the embedded OpenAPI specification. It is used to derive endpoint suffixes from the spec rather than hardcoding them.

Types

type CreateVolumeJSONRequestBody

type CreateVolumeJSONRequestBody = Volume

CreateVolumeJSONRequestBody defines body for CreateVolume for application/json ContentType.

type CreateVolumeParams

type CreateVolumeParams struct {
	// Id Optional client-specified DCM instance ID. When provided, it MUST
	// match spec.metadata.name. When omitted, the instance ID is taken from
	// spec.metadata.name (AEP-122).
	Id *string `form:"id,omitempty" json:"id,omitempty"`
}

CreateVolumeParams defines parameters for CreateVolume.

type Error

type Error struct {
	// Detail Human-readable explanation specific to this occurrence
	Detail *string `json:"detail,omitempty"`

	// Instance Unique identifier for this error occurrence
	Instance *string `json:"instance,omitempty"`

	// Status HTTP status code
	Status *int32 `json:"status,omitempty"`

	// Title Short human-readable summary
	Title string `json:"title"`

	// Type Error type code
	Type ErrorType `json:"type"`
}

Error RFC 9457 compliant error response

type ErrorType

type ErrorType string

ErrorType Error type code

const (
	ALREADYEXISTS      ErrorType = "ALREADY_EXISTS"
	FAILEDPRECONDITION ErrorType = "FAILED_PRECONDITION"
	INTERNAL           ErrorType = "INTERNAL"
	INVALIDARGUMENT    ErrorType = "INVALID_ARGUMENT"
	NOTFOUND           ErrorType = "NOT_FOUND"
	PERMISSIONDENIED   ErrorType = "PERMISSION_DENIED"
	UNAUTHENTICATED    ErrorType = "UNAUTHENTICATED"
	UNAVAILABLE        ErrorType = "UNAVAILABLE"
)

Defines values for ErrorType.

func (ErrorType) Valid

func (e ErrorType) Valid() bool

Valid indicates whether the value is a known member of the ErrorType enum.

type Health

type Health struct {
	// Path Canonical path of the resource
	//
	// Example: health
	Path *string `json:"path,omitempty"`

	// Status Health status
	//
	// Example: healthy
	Status string `json:"status"`

	// Type Resource type identifier
	//
	// Example: k8s-storage-service-provider.dcm.io/health
	Type *string `json:"type,omitempty"`

	// Uptime Seconds since the service provider started
	//
	// Example: 3600
	Uptime *int `json:"uptime,omitempty"`

	// Version Service provider build version
	//
	// Example: 1.0.0
	Version *string `json:"version,omitempty"`
}

Health Health status singleton resource

type KubernetesProviderHints

type KubernetesProviderHints struct {
	// AccessMode PVC access mode. Controls attachment scope and permissions at creation
	// time (Kubernetes-specific; see service type definitions).
	//
	//
	// Example: ReadWriteOnce
	AccessMode *VolumeAccessMode `json:"access_mode,omitempty"`

	// StorageClass StorageClass name (overrides SP default)
	StorageClass *string `json:"storage_class,omitempty"`

	// VolumeMode PVC volume mode
	VolumeMode *VolumeMode `json:"volume_mode,omitempty"`
}

KubernetesProviderHints Kubernetes-specific PVC settings

type ListVolumesParams

type ListVolumesParams struct {
	// MaxPageSize Maximum number of resources per page
	MaxPageSize *int32 `form:"max_page_size,omitempty" json:"max_page_size,omitempty"`

	// PageToken Token for the next page of results
	PageToken *string `form:"page_token,omitempty" json:"page_token,omitempty"`
}

ListVolumesParams defines parameters for ListVolumes.

type ProviderHints

type ProviderHints struct {
	// Kubernetes Kubernetes-specific PVC settings
	Kubernetes           *KubernetesProviderHints `json:"kubernetes,omitempty"`
	AdditionalProperties map[string]interface{}   `json:"-"`
}

ProviderHints Provider-specific hints from the catalog

func (ProviderHints) Get

func (a ProviderHints) Get(fieldName string) (value interface{}, found bool)

Getter for additional properties for ProviderHints. Returns the specified element and whether it was found

func (ProviderHints) MarshalJSON

func (a ProviderHints) MarshalJSON() ([]byte, error)

Override default JSON handling for ProviderHints to handle AdditionalProperties

func (*ProviderHints) Set

func (a *ProviderHints) Set(fieldName string, value interface{})

Setter for additional properties for ProviderHints

func (*ProviderHints) UnmarshalJSON

func (a *ProviderHints) UnmarshalJSON(b []byte) error

Override default JSON handling for ProviderHints to handle AdditionalProperties

type StorageSpec

type StorageSpec struct {
	// Capacity Requested storage capacity (e.g., "100Gi")
	//
	// Example: 100Gi
	Capacity string `json:"capacity"`

	// Metadata Resource metadata for identification
	Metadata VolumeMetadata `json:"metadata"`

	// ProviderHints Provider-specific hints from the catalog
	ProviderHints *ProviderHints `json:"provider_hints,omitempty"`

	// ServiceType Service type identifier (must be "storage")
	ServiceType StorageSpecServiceType `json:"service_type"`
}

StorageSpec Storage specification for creating a PVC (implements the portable storage service type)

type StorageSpecServiceType

type StorageSpecServiceType string

StorageSpecServiceType Service type identifier (must be "storage")

const (
	Storage StorageSpecServiceType = "storage"
)

Defines values for StorageSpecServiceType.

func (StorageSpecServiceType) Valid

func (e StorageSpecServiceType) Valid() bool

Valid indicates whether the value is a known member of the StorageSpecServiceType enum.

type StorageStatus

type StorageStatus string

StorageStatus Current status of the storage instance (CloudEvents payload uses this enum)

const (
	DELETED      StorageStatus = "DELETED"
	DELETING     StorageStatus = "DELETING"
	FAILED       StorageStatus = "FAILED"
	PROVISIONING StorageStatus = "PROVISIONING"
	RUNNING      StorageStatus = "RUNNING"
)

Defines values for StorageStatus.

func (StorageStatus) Valid

func (e StorageStatus) Valid() bool

Valid indicates whether the value is a known member of the StorageStatus enum.

type Volume

type Volume struct {
	// CreateTime Timestamp when the volume was created
	CreateTime *time.Time `json:"create_time,omitempty"`

	// Id DCM instance ID (dcm-instance-id label)
	//
	// Example: app-data-volume
	Id *string `json:"id,omitempty"`

	// Path Resource path identifier
	//
	// Example: volumes/app-data-volume
	Path *string `json:"path,omitempty"`

	// Spec Storage specification for creating a PVC (implements the portable storage service type)
	Spec   StorageSpec    `json:"spec"`
	Status *StorageStatus `json:"status,omitempty"`

	// UpdateTime Timestamp when the volume was last updated
	UpdateTime *time.Time `json:"update_time,omitempty"`
}

Volume Volume resource representing a PVC instance

type VolumeAccessMode

type VolumeAccessMode string

VolumeAccessMode PVC access mode. Controls attachment scope and permissions at creation time (Kubernetes-specific; see service type definitions).

Example: ReadWriteOnce

const (
	ReadOnlyMany  VolumeAccessMode = "ReadOnlyMany"
	ReadWriteMany VolumeAccessMode = "ReadWriteMany"
	ReadWriteOnce VolumeAccessMode = "ReadWriteOnce"
)

Defines values for VolumeAccessMode.

func (VolumeAccessMode) Valid

func (e VolumeAccessMode) Valid() bool

Valid indicates whether the value is a known member of the VolumeAccessMode enum.

type VolumeIdPath

type VolumeIdPath = string

VolumeIdPath defines model for VolumeIdPath.

type VolumeList

type VolumeList struct {
	// NextPageToken Token for retrieving the next page of results
	NextPageToken *string   `json:"next_page_token,omitempty"`
	Volumes       *[]Volume `json:"volumes,omitempty"`
}

VolumeList Paginated list of volume instances

type VolumeMetadata

type VolumeMetadata struct {
	// Labels Custom key-value pairs for tagging and filtering
	Labels *map[string]string `json:"labels,omitempty"`

	// Name DCM instance ID and Kubernetes PVC name (AEP-122)
	Name string `json:"name"`

	// Namespace Kubernetes namespace where the PVC was created
	Namespace *string `json:"namespace,omitempty"`

	// StorageClass StorageClass name bound to the PVC
	StorageClass *string `json:"storage_class,omitempty"`

	// VolumeName Bound PersistentVolume name when available
	VolumeName *string `json:"volume_name,omitempty"`
}

VolumeMetadata Resource metadata for identification

type VolumeMode

type VolumeMode string

VolumeMode PVC volume mode

const (
	Block      VolumeMode = "Block"
	Filesystem VolumeMode = "Filesystem"
)

Defines values for VolumeMode.

func (VolumeMode) Valid

func (e VolumeMode) Valid() bool

Valid indicates whether the value is a known member of the VolumeMode enum.

Jump to

Keyboard shortcuts

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