profile

Documentation

Index

• Constants
• func ConfigFilePath(profileName string) (string, error)
• func CurrentName() (string, error)
• func List() ([]string, error)
• func Load(profileName string, configValue interface{}) error
• func Remove(profileName string) error
• func Save(profileName string, val interface{}) error
• func SetCurrentName(profileName string) error
• func ValidateName(profileName string, invalidRunes ...rune) error
• type ConfigValue

Constants

const (
	// DirectoryNameEnv プロファイルの格納先を指定する環境変数
	DirectoryNameEnv = "SAKURACLOUD_PROFILE_DIR"
	// DirectoryNameEnvOld プロファイルの格納先を指定する環境変数(後方互換)
	DirectoryNameEnvOld = "USACLOUD_PROFILE_DIR"
	// DefaultProfileName デフォルトのプロファイル名
	DefaultProfileName = "default"
)

Functions

func ConfigFilePath

func ConfigFilePath(profileName string) (string, error)

ConfigFilePath 指定のプロファイル名のコンフィグファイルパスを取得

func CurrentName

func CurrentName() (string, error)

CurrentName カレントプロファイル名

func List

func List() ([]string, error)

List プロファイル名の一覧を返す

func Load

func Load(profileName string, configValue interface{}) error

Load 指定のプロファイル名からロードする

configValueには*profile.ConfigValue(派生)への参照を渡す

指定したプロファイル名に対応するコンフィグファイルが存在しない場合はエラーを返す ただしデフォルトのプロファイル名の場合はファイルが存在しなくてもエラーにしない

func Remove

func Remove(profileName string) error

Remove 指定のプロファイルのコンフィグを削除する

プロファイルディレクトリが空になる場合はディレクトリも合わせて削除する Currentプロファイルが削除された場合はCurrentをデフォルトに設定する

func Save

func Save(profileName string, val interface{}) error

Save プロファイルコンフィグを保存

func SetCurrentName

func SetCurrentName(profileName string) error

SetCurrentName カレントプロファイル名を設定する

func ValidateName

func ValidateName(profileName string, invalidRunes ...rune) error

ValidateName プロファイル名が有効か検証

Types

type ConfigValue

type ConfigValue struct {
	// AccessToken アクセストークン
	AccessToken string
	// AccessTokenSecret アクセスシークレット
	AccessTokenSecret string

	// Zone デフォルトゾーン
	Zone string
	// Zones 利用可能なゾーン
	Zones []string

	// UserAgent ユーザーエージェント
	UserAgent string `json:",omitempty"`
	// AcceptLanguage リクエスト時のAccept-Languageヘッダ
	AcceptLanguage string `json:",omitempty"`

	// RetryMax 423/503時のリトライ回数
	RetryMax int `json:",omitempty"`
	// RetryMin 423/503時のリトライ間隔(最小) 単位:秒
	RetryWaitMin int `json:",omitempty"`
	// RetryMax 423/503時のリトライ間隔(最大) 単位:秒
	RetryWaitMax int `json:",omitempty"`

	// StatePollingTimeout StatePollWaiterでのタイムアウト 単位:秒
	StatePollingTimeout int `json:",omitempty"`
	// StatePollingInterval StatePollWaiterでのポーリング間隔 単位:秒
	StatePollingInterval int `json:",omitempty"`

	// HTTPRequestTimeout APIリクエスト時のHTTPタイムアウト 単位:秒
	HTTPRequestTimeout int
	// HTTPRequestRateLimit APIリクエスト時の1秒あたりのリクエスト上限数
	HTTPRequestRateLimit int

	// APIRootURL APIのルートURL
	APIRootURL string `json:",omitempty"`

	// TraceMode トレースモード
	TraceMode string `json:",omitempty"`
	// FakeMode フェイクモード有効化
	FakeMode bool `json:",omitempty"`
	// FakeStorePath フェイクモードでのファイルストアパス
	FakeStorePath string `json:",omitempty"`
}

ConfigValue プロファイル コンフィグ