mobilegateway

Documentation

Index

• type APIClient
  • func NewAPIClient(caller sacloud.APICaller) *APIClient
• type Builder
  • func BuilderFromResource(ctx context.Context, caller sacloud.APICaller, zone string, id types.ID) (*Builder, error)
  • func (b *Builder) Build(ctx context.Context, zone string) (*sacloud.MobileGateway, error)
  • func (b *Builder) Update(ctx context.Context, zone string, id types.ID) (*sacloud.MobileGateway, error)
  • func (b *Builder) Validate(ctx context.Context, zone string) error
• type PrivateInterfaceSetting
• type SIMRouteSetting
• type SIMSetting

Types

type APIClient

type APIClient struct {
	SIM           sacloud.SIMAPI
	MobileGateway sacloud.MobileGatewayAPI
	Zone          sacloud.ZoneAPI
}

APIClient builderが利用するAPIクライアント

func NewAPIClient

func NewAPIClient(caller sacloud.APICaller) *APIClient

NewAPIClient builderが利用するAPIクライアントを返す

type Builder

type Builder struct {
	Name                            string
	Description                     string
	Tags                            types.Tags
	IconID                          types.ID
	PrivateInterface                *PrivateInterfaceSetting
	StaticRoutes                    []*sacloud.MobileGatewayStaticRoute
	SIMRoutes                       []*SIMRouteSetting
	InternetConnectionEnabled       bool
	InterDeviceCommunicationEnabled bool
	DNS                             *sacloud.MobileGatewayDNSSetting
	SIMs                            []*SIMSetting
	TrafficConfig                   *sacloud.MobileGatewayTrafficControl

	SettingsHash string
	NoWait       bool

	SetupOptions *builder.RetryableSetupParameter
	Client       *APIClient
}

Builder モバイルゲートウェイの構築を行う

func BuilderFromResource

func BuilderFromResource(ctx context.Context, caller sacloud.APICaller, zone string, id types.ID) (*Builder, error)

BuilderFromResource 既存のMobileGatewayからBuilderを組み立てて返す

func (*Builder) Build

func (b *Builder) Build(ctx context.Context, zone string) (*sacloud.MobileGateway, error)

Build モバイルゲートウェイの作成や設定をまとめて行う

func (*Builder) Update

func (b *Builder) Update(ctx context.Context, zone string, id types.ID) (*sacloud.MobileGateway, error)

Update モバイルゲートウェイの更新

更新中、SIMルートが一時的にクリアされます。また、接続先スイッチが変更されていた場合は再起動されます。

func (*Builder) Validate

func (b *Builder) Validate(ctx context.Context, zone string) error

Validate 設定値の検証

type PrivateInterfaceSetting

type PrivateInterfaceSetting struct {
	SwitchID       types.ID
	IPAddress      string
	NetworkMaskLen int
}

PrivateInterfaceSetting モバイルゲートウェイのプライベート側インターフェース設定

type SIMRouteSetting

type SIMRouteSetting struct {
	SIMID  types.ID
	Prefix string
}

SIMRouteSetting SIMルート設定

type SIMSetting

type SIMSetting struct {
	SIMID     types.ID
	IPAddress string
}

SIMSetting モバイルゲートウェイに接続するSIM設定