cdrom

Documentation

Index

• type CloseFTPRequest
  • func (req *CloseFTPRequest) Validate() error
• type CreateRequest
  • func (req *CreateRequest) Validate() error
• type DeleteRequest
  • func (req *DeleteRequest) Validate() error
• type DownloadRequest
  • func (req *DownloadRequest) Validate() error
• type FindRequest
  • func (req *FindRequest) ToRequestParameter() (*sacloud.FindCondition, error)
  • func (req *FindRequest) Validate() error
• type OpenFTPRequest
  • func (req *OpenFTPRequest) Validate() error
• type ReadRequest
  • func (req *ReadRequest) Validate() error
• type Service
  • func New(caller sacloud.APICaller) *Service
  • func (s *Service) CloseFTP(req *CloseFTPRequest) error
  • func (s *Service) CloseFTPWithContext(ctx context.Context, req *CloseFTPRequest) error
  • func (s *Service) Create(req *CreateRequest) (*sacloud.CDROM, error)
  • func (s *Service) CreateWithContext(ctx context.Context, req *CreateRequest) (*sacloud.CDROM, error)
  • func (s *Service) Delete(req *DeleteRequest) error
  • func (s *Service) DeleteWithContext(ctx context.Context, req *DeleteRequest) error
  • func (s *Service) Download(req *DownloadRequest) error
  • func (s *Service) DownloadWithContext(ctx context.Context, req *DownloadRequest) error
  • func (s *Service) Find(req *FindRequest) ([]*sacloud.CDROM, error)
  • func (s *Service) FindWithContext(ctx context.Context, req *FindRequest) ([]*sacloud.CDROM, error)
  • func (s *Service) OpenFTP(req *OpenFTPRequest) (*sacloud.FTPServer, error)
  • func (s *Service) OpenFTPWithContext(ctx context.Context, req *OpenFTPRequest) (*sacloud.FTPServer, error)
  • func (s *Service) Read(req *ReadRequest) (*sacloud.CDROM, error)
  • func (s *Service) ReadWithContext(ctx context.Context, req *ReadRequest) (*sacloud.CDROM, error)
  • func (s *Service) Update(req *UpdateRequest) (*sacloud.CDROM, error)
  • func (s *Service) UpdateWithContext(ctx context.Context, req *UpdateRequest) (*sacloud.CDROM, error)
  • func (s *Service) Upload(req *UploadRequest) error
  • func (s *Service) UploadWithContext(ctx context.Context, req *UploadRequest) error
• type UpdateRequest
  • func (req *UpdateRequest) ToRequestParameter(current *sacloud.CDROM) (*sacloud.CDROMUpdateRequest, error)
  • func (req *UpdateRequest) Validate() error
• type UploadRequest
  • func (req *UploadRequest) Validate() error

Types

type CloseFTPRequest

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

func (*CloseFTPRequest) Validate

func (req *CloseFTPRequest) Validate() 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
	SizeGB       int
	SourcePath   string `validate:"omitempty,file"`
	SourceReader io.Reader
}

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:"-"`
}

func (*DeleteRequest) Validate

func (req *DeleteRequest) Validate() error

type DownloadRequest

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

	Path   string    `request:"-"`
	Writer io.Writer `request:"-"`
}

func (*DownloadRequest) Validate

func (req *DownloadRequest) Validate() error

type FindRequest

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

	Names []string     `request:"-"`
	Tags  []string     `request:"-"`
	Scope types.EScope `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 OpenFTPRequest

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

	ChangePassword bool
}

func (*OpenFTPRequest) Validate

func (req *OpenFTPRequest) 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 Service

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

Service provides a high-level API of for CDROM

func New

func New(caller sacloud.APICaller) *Service

New returns new service instance of CDROM

func (*Service) CloseFTP

func (s *Service) CloseFTP(req *CloseFTPRequest) error

func (*Service) CloseFTPWithContext

func (s *Service) CloseFTPWithContext(ctx context.Context, req *CloseFTPRequest) error

func (*Service) Create

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

func (*Service) CreateWithContext

func (s *Service) CreateWithContext(ctx context.Context, req *CreateRequest) (*sacloud.CDROM, 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) Download

func (s *Service) Download(req *DownloadRequest) error

func (*Service) DownloadWithContext

func (s *Service) DownloadWithContext(ctx context.Context, req *DownloadRequest) error

func (*Service) Find

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

func (*Service) FindWithContext

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

func (*Service) OpenFTP

func (s *Service) OpenFTP(req *OpenFTPRequest) (*sacloud.FTPServer, error)

func (*Service) OpenFTPWithContext

func (s *Service) OpenFTPWithContext(ctx context.Context, req *OpenFTPRequest) (*sacloud.FTPServer, error)

func (*Service) Read

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

func (*Service) ReadWithContext

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

func (*Service) Update

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

func (*Service) UpdateWithContext

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

func (*Service) Upload

func (s *Service) Upload(req *UploadRequest) error

func (*Service) UploadWithContext

func (s *Service) UploadWithContext(ctx context.Context, req *UploadRequest) error

type UpdateRequest

type UpdateRequest struct {
	Zone string   `request:"-" validate:"required"`
	ID   types.ID `request:"-" 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) ToRequestParameter

func (req *UpdateRequest) ToRequestParameter(current *sacloud.CDROM) (*sacloud.CDROMUpdateRequest, error)

func (*UpdateRequest) Validate

func (req *UpdateRequest) Validate() error

type UploadRequest

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

	Path   string `validate:"omitempty,file"`
	Reader io.Reader
}

func (*UploadRequest) Validate

func (req *UploadRequest) Validate() error