nfs

package
v2.32.3 Latest Latest
Warning

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

Go to latest
Published: Mar 22, 2022 License: Apache-2.0 Imports: 13 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApplyRequest added in v2.9.0

type ApplyRequest struct {
	ID   types.ID // for update
	Zone string   `request:"-" validate:"required"`

	Name           string `validate:"required"`
	Description    string `validate:"min=0,max=512"`
	Tags           types.Tags
	IconID         types.ID
	SwitchID       types.ID       `validate:"required"`
	Plan           types.ID       `validate:"required,oneof=1 2"` // types.NFSPlans.HDD or types.NFSPlans.SSD
	Size           types.ENFSSize `validate:"required"`           // types.NFSPlans.HDD or types.NFSPlans.SSD
	IPAddresses    []string       `validate:"required,min=1,max=2,dive,ipv4"`
	NetworkMaskLen int            `validate:"required"`
	DefaultRoute   string         `validate:"omitempty,ipv4"`

	NoWait bool
}

func (*ApplyRequest) Builder added in v2.9.0

func (req *ApplyRequest) Builder(caller sacloud.APICaller) *Builder

func (*ApplyRequest) Validate added in v2.9.0

func (req *ApplyRequest) Validate() error

type BootRequest

type BootRequest struct {
	Zone string   `request:"-" validate:"required"`
	ID   types.ID `request:"-" validate:"required"`

	NoWait bool `request:"-"`
}

func (*BootRequest) Validate

func (req *BootRequest) Validate() error

type Builder

type Builder struct {
	ID   types.ID
	Zone string

	Name        string
	Description string
	Tags        types.Tags
	IconID      types.ID
	SwitchID    types.ID

	Plan types.ID
	Size types.ENFSSize

	IPAddresses    []string
	NetworkMaskLen int
	DefaultRoute   string

	Caller sacloud.APICaller
	NoWait bool
}

func (*Builder) Build

func (b *Builder) Build(ctx context.Context) (*sacloud.NFS, error)

type CreateRequest

type CreateRequest struct {
	Zone string `request:"-" validate:"required"`

	Name           string `validate:"required"`
	Description    string `validate:"min=0,max=512"`
	Tags           types.Tags
	IconID         types.ID
	SwitchID       types.ID       `validate:"required"`
	Plan           types.ID       `validate:"required,oneof=1 2"` // types.NFSPlans.HDD or types.NFSPlans.SSD
	Size           types.ENFSSize `validate:"required"`           // types.NFSPlans.HDD or types.NFSPlans.SSD
	IPAddresses    []string       `validate:"required,min=1,max=2,dive,ipv4"`
	NetworkMaskLen int            `validate:"required"`
	DefaultRoute   string         `validate:"omitempty,ipv4"`
	NoWait         bool
}

func (*CreateRequest) Builder

func (req *CreateRequest) Builder(caller sacloud.APICaller) *Builder

func (*CreateRequest) Validate

func (req *CreateRequest) Validate() error

type DeleteRequest

type DeleteRequest struct {
	Zone string   `request:"-" validate:"required"`
	ID   types.ID `request:"-" validate:"required"`

	FailIfNotFound bool `request:"-"`
	Force          bool `request:"-"` // trueの場合は電源OFF(強制終了)してから削除
}

func (*DeleteRequest) Validate

func (req *DeleteRequest) Validate() error

type FindRequest

type FindRequest struct {
	Zone string `request:"-" validate:"required"`

	Names []string `request:"-"`
	Tags  []string `request:"-"`

	Sort  search.SortKeys
	Count int
	From  int
}

func (*FindRequest) ToRequestParameter

func (req *FindRequest) ToRequestParameter() (*sacloud.FindCondition, error)

func (*FindRequest) Validate

func (req *FindRequest) Validate() error

type MonitorFreeDiskSizeRequest

type MonitorFreeDiskSizeRequest struct {
	Zone string   `request:"-" validate:"required"`
	ID   types.ID `request:"-" validate:"required"`

	Start time.Time
	End   time.Time
}

func (*MonitorFreeDiskSizeRequest) Validate

func (req *MonitorFreeDiskSizeRequest) Validate() error

type MonitorInterfaceRequest

type MonitorInterfaceRequest struct {
	Zone string   `request:"-" validate:"required"`
	ID   types.ID `request:"-" validate:"required"`

	Start time.Time
	End   time.Time
}

func (*MonitorInterfaceRequest) Validate

func (req *MonitorInterfaceRequest) Validate() error

type ReadRequest

type ReadRequest struct {
	Zone string   `request:"-" validate:"required"`
	ID   types.ID `request:"-" validate:"required"`
}

func (*ReadRequest) Validate

func (req *ReadRequest) Validate() error

type ResetRequest

type ResetRequest struct {
	Zone string   `request:"-" validate:"required"`
	ID   types.ID `request:"-" validate:"required"`
}

func (*ResetRequest) Validate

func (req *ResetRequest) Validate() error

type Service

type Service struct {
	// contains filtered or unexported fields
}

Service provides a high-level API of for NFS

func New

func New(caller sacloud.APICaller) *Service

New returns new service instance of NFS

func (*Service) Apply added in v2.9.0

func (s *Service) Apply(req *ApplyRequest) (*sacloud.NFS, error)

func (*Service) ApplyWithContext added in v2.9.0

func (s *Service) ApplyWithContext(ctx context.Context, req *ApplyRequest) (*sacloud.NFS, error)

func (*Service) Boot

func (s *Service) Boot(req *BootRequest) error

func (*Service) BootWithContext

func (s *Service) BootWithContext(ctx context.Context, req *BootRequest) error

func (*Service) Create

func (s *Service) Create(req *CreateRequest) (*sacloud.NFS, error)

func (*Service) CreateWithContext

func (s *Service) CreateWithContext(ctx context.Context, req *CreateRequest) (*sacloud.NFS, error)

func (*Service) Delete

func (s *Service) Delete(req *DeleteRequest) error

func (*Service) DeleteWithContext

func (s *Service) DeleteWithContext(ctx context.Context, req *DeleteRequest) error

func (*Service) Find

func (s *Service) Find(req *FindRequest) ([]*sacloud.NFS, error)

func (*Service) FindWithContext

func (s *Service) FindWithContext(ctx context.Context, req *FindRequest) ([]*sacloud.NFS, error)

func (*Service) MonitorFreeDiskSize

func (s *Service) MonitorFreeDiskSize(req *MonitorFreeDiskSizeRequest) ([]*sacloud.MonitorFreeDiskSizeValue, error)

func (*Service) MonitorFreeDiskSizeWithContext

func (s *Service) MonitorFreeDiskSizeWithContext(ctx context.Context, req *MonitorFreeDiskSizeRequest) ([]*sacloud.MonitorFreeDiskSizeValue, error)

func (*Service) MonitorInterface

func (s *Service) MonitorInterface(req *MonitorInterfaceRequest) ([]*sacloud.MonitorInterfaceValue, error)

func (*Service) MonitorInterfaceWithContext

func (s *Service) MonitorInterfaceWithContext(ctx context.Context, req *MonitorInterfaceRequest) ([]*sacloud.MonitorInterfaceValue, error)

func (*Service) Read

func (s *Service) Read(req *ReadRequest) (*sacloud.NFS, error)

func (*Service) ReadWithContext

func (s *Service) ReadWithContext(ctx context.Context, req *ReadRequest) (*sacloud.NFS, error)

func (*Service) Reset

func (s *Service) Reset(req *ResetRequest) error

func (*Service) ResetWithContext

func (s *Service) ResetWithContext(ctx context.Context, req *ResetRequest) error

func (*Service) Shutdown

func (s *Service) Shutdown(req *ShutdownRequest) error

func (*Service) ShutdownWithContext

func (s *Service) ShutdownWithContext(ctx context.Context, req *ShutdownRequest) error

func (*Service) Update

func (s *Service) Update(req *UpdateRequest) (*sacloud.NFS, error)

func (*Service) UpdateWithContext

func (s *Service) UpdateWithContext(ctx context.Context, req *UpdateRequest) (*sacloud.NFS, error)

func (*Service) WaitBoot

func (s *Service) WaitBoot(req *WaitBootRequest) error

func (*Service) WaitBootWithContext

func (s *Service) WaitBootWithContext(ctx context.Context, req *WaitBootRequest) error

func (*Service) WaitShutdown

func (s *Service) WaitShutdown(req *WaitShutdownRequest) error

func (*Service) WaitShutdownWithContext

func (s *Service) WaitShutdownWithContext(ctx context.Context, req *WaitShutdownRequest) error

type ShutdownRequest

type ShutdownRequest struct {
	Zone string   `request:"-" validate:"required"`
	ID   types.ID `request:"-" validate:"required"`

	NoWait        bool `request:"-"`
	ForceShutdown bool `request:"-"`
}

func (*ShutdownRequest) Validate

func (req *ShutdownRequest) Validate() error

type UpdateRequest

type UpdateRequest struct {
	Zone string   `validate:"required"`
	ID   types.ID `validate:"required"`

	Name        *string     `request:",omitempty" validate:"omitempty,min=1"`
	Description *string     `request:",omitempty" validate:"omitempty,min=1,max=512"`
	Tags        *types.Tags `request:",omitempty"`
	IconID      *types.ID   `request:",omitempty"`
}

func (*UpdateRequest) ApplyRequest added in v2.9.0

func (req *UpdateRequest) ApplyRequest(ctx context.Context, caller sacloud.APICaller) (*ApplyRequest, error)

func (*UpdateRequest) Validate

func (req *UpdateRequest) Validate() error

type WaitBootRequest

type WaitBootRequest struct {
	Zone string   `request:"-" validate:"required"`
	ID   types.ID `request:"-" validate:"required"`
}

func (*WaitBootRequest) Validate

func (req *WaitBootRequest) Validate() error

type WaitShutdownRequest

type WaitShutdownRequest struct {
	Zone string   `request:"-" validate:"required"`
	ID   types.ID `request:"-" validate:"required"`
}

func (*WaitShutdownRequest) Validate

func (req *WaitShutdownRequest) Validate() error

Jump to

Keyboard shortcuts

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