sim

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: 12 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivateRequest 

type ActivateRequest struct {
	ID types.ID `request:"-" validate:"required"`
}

func (*ActivateRequest) Validate 

func (req *ActivateRequest) Validate() error

type ApplyRequest 

type ApplyRequest struct {
	ID          types.ID `request:"-"`
	Name        string   `validate:"required"`
	Description string   `validate:"min=0,max=512"`
	Tags        types.Tags
	IconID      types.ID
	ICCID       string `validate:"required"`
	PassCode    string // Update時などは空になるためrequiredをはずしておく
	Activate    bool
	IMEI        string
	Carriers    []*sacloud.SIMNetworkOperatorConfig
}

func (*ApplyRequest) Validate 

func (req *ApplyRequest) Validate() error

type CreateRequest 

type CreateRequest struct {
	Name        string `validate:"required"`
	Description string `validate:"min=0,max=512"`
	Tags        types.Tags
	IconID      types.ID
	ICCID       string `validate:"required"`
	PassCode    string `validate:"required"`

	Activate bool
	IMEI     string
	Carriers []*sacloud.SIMNetworkOperatorConfig
}

func (*CreateRequest) ApplyRequest added in v2.9.0 

func (req *CreateRequest) ApplyRequest() *ApplyRequest

func (*CreateRequest) Validate 

func (req *CreateRequest) Validate() error

type DeactivateRequest 

type DeactivateRequest struct {
	ID types.ID `request:"-" validate:"required"`
}

func (*DeactivateRequest) Validate 

func (req *DeactivateRequest) Validate() error

type DeleteRequest 

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

	FailIfNotFound bool `request:"-"`

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

func (*DeleteRequest) Validate 

func (req *DeleteRequest) Validate() error

type FindRequest 

type FindRequest struct {
	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 LogsRequest 

type LogsRequest struct {
	ID types.ID `request:"-" validate:"required"`
}

func (*LogsRequest) Validate 

func (req *LogsRequest) Validate() error

type MonitorSIMRequest 

type MonitorSIMRequest struct {
	ID types.ID `request:"-" validate:"required"`

	Start time.Time
	End   time.Time
}

func (*MonitorSIMRequest) Validate 

func (req *MonitorSIMRequest) Validate() error

type NetworkOperatorsRequest 

type NetworkOperatorsRequest struct {
	ID types.ID `request:"-" validate:"required"`
}

func (*NetworkOperatorsRequest) Validate 

func (req *NetworkOperatorsRequest) Validate() error

type ReadRequest 

type ReadRequest struct {
	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 SIM

func New 

func New(caller sacloud.APICaller) *Service

New returns new service instance of SIM

func (*Service) Activate 

func (s *Service) Activate(req *ActivateRequest) error

func (*Service) ActivateWithContext 

func (s *Service) ActivateWithContext(ctx context.Context, req *ActivateRequest) error

func (*Service) Apply 

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

func (*Service) ApplyWithContext 

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

func (*Service) Create 

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

func (*Service) CreateWithContext 

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

func (*Service) Deactivate 

func (s *Service) Deactivate(req *DeactivateRequest) error

func (*Service) DeactivateWithContext 

func (s *Service) DeactivateWithContext(ctx context.Context, req *DeactivateRequest) 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.SIM, error)

func (*Service) FindWithContext 

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

func (*Service) Logs 

func (s *Service) Logs(req *LogsRequest) ([]*sacloud.SIMLog, error)

func (*Service) LogsWithContext 

func (s *Service) LogsWithContext(ctx context.Context, req *LogsRequest) ([]*sacloud.SIMLog, error)

func (*Service) MonitorSIM 

func (s *Service) MonitorSIM(req *MonitorSIMRequest) ([]*sacloud.MonitorLinkValue, error)

func (*Service) MonitorSIMWithContext 

func (s *Service) MonitorSIMWithContext(ctx context.Context, req *MonitorSIMRequest) ([]*sacloud.MonitorLinkValue, error)

func (*Service) NetworkOperators 

func (s *Service) NetworkOperators(req *NetworkOperatorsRequest) ([]*sacloud.SIMNetworkOperatorConfig, error)

func (*Service) NetworkOperatorsWithContext 

func (s *Service) NetworkOperatorsWithContext(ctx context.Context, req *NetworkOperatorsRequest) ([]*sacloud.SIMNetworkOperatorConfig, error)

func (*Service) Read 

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

func (*Service) ReadWithContext 

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

func (*Service) Update 

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

func (*Service) UpdateWithContext 

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

type UpdateRequest 

type UpdateRequest struct {
	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"`

	Activate *bool                                `request:",omitempty"`
	IMEI     *string                              `request:",omitempty"`
	Carriers *[]*sacloud.SIMNetworkOperatorConfig `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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.