models

Documentation

Overview

Package models ...

Package models ...

Package models ...

Package models ...

Package models ...

Package models ...

Package models ...

Package models ...

Package models ...

Package models ...

Package models ...

Package models ...

Index

• Constants
• type EncryptionKey
• type Error
  • func (e Error) Error() string
• type ErrorCode
  • func (ec ErrorCode) String() string
• type ErrorItem
  • func (ei ErrorItem) Error() string
• type ErrorTarget
• type ErrorType
  • func (et ErrorType) String() string
• type HReference
• type IksError
  • func (ikserr IksError) Error() string
• type InitialOwner
• type ListSecurityGroupFilters
• type ListShareFilters
• type ListShareTargetFilters
• type ListSubnetFilters
• type Profile
• type ResourceGroup
• type SecurityGroup
• type SecurityGroupList
• type Share
• type ShareList
• type ShareTarget
  • func NewShareTarget(volumeAccessPointRequest provider.VolumeAccessPointRequest) ShareTarget
  • func (va *ShareTarget) ToVolumeAccessPointResponse() *provider.VolumeAccessPointResponse
• type ShareTargetList
• type StatusType
• type Subnet
• type SubnetList
• type SubnetRef
• type VirtualNetworkInterface
• type Zone

Constants

const (
	// APIVersion is the target RIaaS API spec version
	APIVersion = "2023-07-11"

	// APIGeneration ...
	APIGeneration = 1

	// UserAgent identifies IKS to the RIaaS API
	UserAgent = "IBM-Kubernetes-Service"
)

Types

type EncryptionKey

type EncryptionKey struct {
	CRN string `json:"crn,omitempty"`
}

EncryptionKey ...

type Error

type Error struct {
	Errors []ErrorItem `json:"errors"`
	Trace  string      `json:"trace,omitempty"`
}

Error ...

func (Error) Error

func (e Error) Error() string

Error ...

type ErrorCode

type ErrorCode string

ErrorCode ...

const (
	ErrorCodeInvalidState ErrorCode = "invalid_state"
	ErrorCodeNotFound     ErrorCode = "not_found"
	ErrorCodeTokenInvalid ErrorCode = "token_invalid"
)

Error codes

func (ErrorCode) String

func (ec ErrorCode) String() string

type ErrorItem

type ErrorItem struct {
	Code     ErrorCode    `json:"code,omitempty"`
	Message  string       `json:"message,omitempty"`
	MoreInfo string       `json:"more_info,omitempty"`
	Target   *ErrorTarget `json:"reqID,omitempty"`
}

ErrorItem ...

func (ErrorItem) Error

func (ei ErrorItem) Error() string

Error ...

type ErrorTarget

type ErrorTarget struct {
	Name string    `json:"name,omitempty"`
	Type ErrorType `json:"type,omitempty"`
}

ErrorTarget ...

type ErrorType

type ErrorType string

ErrorType ...

const (
	ErrorTypeField     ErrorType = "field"
	ErrorTypeParameter ErrorType = "parameter"
	ErrorTypeHeader    ErrorType = "header"
)

Error types

func (ErrorType) String

func (et ErrorType) String() string

type HReference

type HReference struct {
	Href string `json:"href,omitempty"`
}

HReference ...

type IksError

type IksError struct {
	ReqID       string    `json:"incidentID" binding:"required"`
	Code        string    `json:"code" binding:"required"`
	Err         string    `json:"description" binding:"required"`
	Type        ErrorType `json:"type" binding:"required"`
	RecoveryCLI string    `json:"recoveryCLI,omitempty"`
	RecoveryUI  string    `json:"recoveryUI,omitempty"`
	RC          int       `json:"rc,omitempty"`
}

IksError ...

func (IksError) Error

func (ikserr IksError) Error() string

Error ...

type InitialOwner

type InitialOwner struct {
	GroupID int64 `json:"gid,omitempty"`
	UserID  int64 `json:"uid,omitempty"`
}

InitialOwner ...

type ListSecurityGroupFilters

type ListSecurityGroupFilters struct {
	ResourceGroupID string `json:"resource_group.id,omitempty"`
	VPCID           string `json:"vpc.id,omitempty"`
}

ListSecurityGroupFilters ...

type ListShareFilters

type ListShareFilters struct {
	ResourceGroupID string `json:"resource_group.id,omitempty"`
	ShareName       string `json:"name,omitempty"`
}

ListShareFilters ...

type ListShareTargetFilters

type ListShareTargetFilters struct {
	ShareTargetName string `json:"name,omitempty"`
}

ListShareTargerFilters ...

type ListSubnetFilters

type ListSubnetFilters struct {
	ResourceGroupID string `json:"resource_group.id,omitempty"`
	VPCID           string `json:"vpc.id,omitempty"`
	ZoneName        string `json:"zone.name,omitempty"`
}

ListSubnetFilters ...

type Profile

type Profile struct {
	CRN  string `json:"crn,omitempty"`
	Href string `json:"href,omitempty"`
	Name string `json:"name,omitempty"`
}

Profile ...

type ResourceGroup

type ResourceGroup struct {
	Href string `json:"href,omitempty"`
	ID   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

ResourceGroup ...

type SecurityGroup

type SecurityGroup struct {
	CRN           string         `json:"crn,omitempty"`
	Href          string         `json:"href,omitempty"`
	ID            string         `json:"id,omitempty"`
	Name          string         `json:"name,omitempty"`
	ResourceGroup *ResourceGroup `json:"resource_group,omitempty"`
	VPC           *provider.VPC  `json:"vpc,omitempty"`
}

SecurityGroup ...

type SecurityGroupList

type SecurityGroupList struct {
	First          *HReference     `json:"first,omitempty"`
	Next           *HReference     `json:"next,omitempty"`
	SecurityGroups []SecurityGroup `json:"security_groups,omitempty"`
	Limit          int             `json:"limit,omitempty"`
	TotalCount     int             `json:"total_count,omitempty"`
}

SecurityGroupList ...

type Share

type Share struct {
	CRN           string         `json:"crn,omitempty"`
	Href          string         `json:"href,omitempty"`
	ID            string         `json:"id,omitempty"`
	Name          string         `json:"name,omitempty"`
	Size          int64          `json:"size,omitempty"`
	Iops          int64          `json:"iops,omitempty"`
	EncryptionKey *EncryptionKey `json:"encryption_key,omitempty"`
	ResourceGroup *ResourceGroup `json:"resource_group,omitempty"`
	InitialOwner  *InitialOwner  `json:"initial_owner,omitempty"`
	Profile       *Profile       `json:"profile,omitempty"`
	CreatedAt     *time.Time     `json:"created_at,omitempty"`
	// Status of share named - deleted, deleting, failed, pending, stable, updating, waiting, suspended
	Status            StatusType     `json:"lifecycle_state,omitempty"`
	ShareTargets      *[]ShareTarget `json:"mount_targets,omitempty"`
	Zone              *Zone          `json:"zone,omitempty"`
	AccessControlMode string         `json:"access_control_mode,omitempty"`
}

Share ...

type ShareList

type ShareList struct {
	First      *HReference `json:"first,omitempty"`
	Next       *HReference `json:"next,omitempty"`
	Shares     []*Share    `json:"shares"`
	Limit      int         `json:"limit,omitempty"`
	TotalCount int         `json:"total_count,omitempty"`
}

ShareList ...

type ShareTarget

type ShareTarget struct {
	ID        string `json:"id,omitempty"`
	Href      string `json:"href,omitempty"`
	MountPath string `json:"mount_path,omitempty"`
	Name      string `json:"name,omitempty"`
	// Status of share target named - deleted, deleting, failed, pending, stable, updating, waiting, suspended
	Status string        `json:"lifecycle_state,omitempty"`
	VPC    *provider.VPC `json:"vpc,omitempty"`
	//EncryptionInTransit
	TransitEncryption       string                   `json:"transit_encryption,omitempty"`
	VirtualNetworkInterface *VirtualNetworkInterface `json:"virtual_network_interface,omitempty"`
	//Share ID this target is associated to
	ShareID   string     `json:"-"`
	Zone      *Zone      `json:"zone,omitempty"`
	CreatedAt *time.Time `json:"created_at,omitempty"`
}

ShareTarget for riaas client

func NewShareTarget

func NewShareTarget(volumeAccessPointRequest provider.VolumeAccessPointRequest) ShareTarget

NewShareTarget creates ShareTarget from VolumeAccessPointRequest

func (*ShareTarget) ToVolumeAccessPointResponse

func (va *ShareTarget) ToVolumeAccessPointResponse() *provider.VolumeAccessPointResponse

ToVolumeAccessPointResponse converts ShareTargetResponse to VolumeAccessPointResponse

type ShareTargetList

type ShareTargetList struct {
	First        *HReference    `json:"first,omitempty"`
	Next         *HReference    `json:"next,omitempty"`
	ShareTargets []*ShareTarget `json:"mount_targets,omitempty"`
	Limit        int            `json:"limit,omitempty"`
	TotalCount   int            `json:"total_count,omitempty"`
}

ShareTargetList ...

type StatusType

type StatusType string

StatusType ...

type Subnet

type Subnet struct {
	CRN           string         `json:"crn,omitempty"`
	Href          string         `json:"href,omitempty"`
	ID            string         `json:"id,omitempty"`
	Name          string         `json:"name,omitempty"`
	ResourceGroup *ResourceGroup `json:"resource_group,omitempty"`
	VPC           *provider.VPC  `json:"vpc,omitempty"`
	Zone          *Zone          `json:"zone,omitempty"`
}

Subnet ...

type SubnetList

type SubnetList struct {
	First      *HReference `json:"first,omitempty"`
	Next       *HReference `json:"next,omitempty"`
	Subnets    []Subnet    `json:"subnets,omitempty"`
	Limit      int         `json:"limit,omitempty"`
	TotalCount int         `json:"total_count,omitempty"`
}

SubnetList ...

type SubnetRef

type SubnetRef struct {
	CRN  string `json:"crn,omitempty"`
	ID   string `json:"id,omitempty"`
	Href string `json:"href,omitempty"`
}

SubnetRef ...

type VirtualNetworkInterface

type VirtualNetworkInterface struct {
	Name           string                    `json:"name,omitempty"`
	Subnet         *SubnetRef                `json:"subnet,omitempty"`
	SecurityGroups *[]provider.SecurityGroup `json:"security_groups,omitempty"`
	PrimaryIP      *provider.PrimaryIP       `json:"primary_ip,omitempty"`
	ResourceGroup  *provider.ResourceGroup   `json:"resource_group,omitempty"`
}

VirtualNetworkInterface

type Zone

type Zone struct {
	Name string `json:"name,omitempty"`
	Href string `json:"href,omitempty"`
}

Zone ...