swytch

Documentation

Index

• type CreateRequest
  • func (req *CreateRequest) ToRequestParameter() (*sacloud.SwitchCreateRequest, error)
  • func (req *CreateRequest) Validate() error
• type DeleteRequest
  • func (req *DeleteRequest) Validate() error
• type FindRequest
  • func (req *FindRequest) ToRequestParameter() (*sacloud.FindCondition, error)
  • func (req *FindRequest) Validate() error
• type ReadRequest
  • func (req *ReadRequest) Validate() error
• type Service
  • func New(caller sacloud.APICaller) *Service
  • func (s *Service) Create(req *CreateRequest) (*sacloud.Switch, error)
  • func (s *Service) CreateWithContext(ctx context.Context, req *CreateRequest) (*sacloud.Switch, error)
  • func (s *Service) Delete(req *DeleteRequest) error
  • func (s *Service) DeleteWithContext(ctx context.Context, req *DeleteRequest) error
  • func (s *Service) Find(req *FindRequest) ([]*sacloud.Switch, error)
  • func (s *Service) FindWithContext(ctx context.Context, req *FindRequest) ([]*sacloud.Switch, error)
  • func (s *Service) Read(req *ReadRequest) (*sacloud.Switch, error)
  • func (s *Service) ReadWithContext(ctx context.Context, req *ReadRequest) (*sacloud.Switch, error)
  • func (s *Service) Update(req *UpdateRequest) (*sacloud.Switch, error)
  • func (s *Service) UpdateWithContext(ctx context.Context, req *UpdateRequest) (*sacloud.Switch, error)
• type UpdateRequest
  • func (req *UpdateRequest) ToRequestParameter(current *sacloud.Switch) (*sacloud.SwitchUpdateRequest, error)
  • func (req *UpdateRequest) Validate() error

Types

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
	NetworkMaskLen int
	DefaultRoute   string
}

func (*CreateRequest) ToRequestParameter

func (req *CreateRequest) ToRequestParameter() (*sacloud.SwitchCreateRequest, error)

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

	WaitForRelease        bool `request:"-"` // trueの場合、他リソースから参照されている間は削除を待ち合わせし続ける
	WaitForReleaseTimeout int  // WaitForReleaseがtrueの場合の待ち時間タイムアウト(デフォルト:1時間)
	WaitForReleaseTick    int  // WaitForReleaseがtrueの場合の待ち処理のポーリング間隔(デフォルト:5秒)
}

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 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 Switch

func New

func New(caller sacloud.APICaller) *Service

New returns new service instance of Switch

func (*Service) Create

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

func (*Service) CreateWithContext

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

func (*Service) FindWithContext

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

func (*Service) Read

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

func (*Service) ReadWithContext

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

func (*Service) Update

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

func (*Service) UpdateWithContext

func (s *Service) UpdateWithContext(ctx context.Context, req *UpdateRequest) (*sacloud.Switch, 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"`
	NetworkMaskLen *int        `request:",omitempty"`
	DefaultRoute   *string     `request:",omitempty"`
}

func (*UpdateRequest) ToRequestParameter

func (req *UpdateRequest) ToRequestParameter(current *sacloud.Switch) (*sacloud.SwitchUpdateRequest, error)

func (*UpdateRequest) Validate

func (req *UpdateRequest) Validate() error