metadata

Documentation

Index

• Variables
• func ExtractionRegion(metaZone string) (string, error)
• func ExtractionZone(metaZone string) (string, error)
• func GetInstanceAttribute(key string) (string, error)
• func GetProjectAttribute(key string) (string, error)
• func Hostname() (string, error)
• func InstanceID() (string, error)
• func InstanceName() (string, error)
• func NewErrInvalidArgument(message string, kv map[string]interface{}, err error) error
• func NewErrNotFound(message string, kv map[string]interface{}, err error) error
• func NumericProjectID() (string, error)
• func OnGCP() bool
• func ProjectID() (string, error)
• func Region() (string, error)
• func ServiceAccountDefaultToken() (string, error)
• func ServiceAccountEmail() (string, error)
• func ServiceAccountID() (string, error)
• func ServiceAccountName() (string, error)
• func Zone() (string, error)
• type Error
  • func (e *Error) Error() string
  • func (e *Error) Is(target error) bool
  • func (e *Error) Unwrap() error

Variables

var ErrInvalidArgument = &Error{
	Code:    "InvalidArgument",
	Message: "invalid argument",
	KV:      map[string]interface{}{},
}

ErrInvalidArgument is 引数がおかしい時に返す

var ErrNotFound = &Error{
	Code:    "NotFound",
	Message: "not found",
	KV:      map[string]interface{}{},
}

ErrNotFound is 見つからなかった時に返す

Functions

func ExtractionRegion

func ExtractionRegion(metaZone string) (string, error)

ExtractionRegion is Metadata Serverから取得する projects/[NUMERIC_PROJECT_ID]/zones/[ZONE] 形式の文字列から、Region部分を取り出す

func ExtractionZone

func ExtractionZone(metaZone string) (string, error)

ExtractionZone is Metadata Serverから取得する projects/[NUMERIC_PROJECT_ID]/zones/[ZONE] 形式の文字列から、Zone部分を取り出す

func GetInstanceAttribute

func GetInstanceAttribute(key string) (string, error)

GetInstanceAttribute is Instance Metadataを取得する GCP以外で動いている時は、環境変数を取得する

func GetProjectAttribute

func GetProjectAttribute(key string) (string, error)

GetProjectAttribute is Project Metadataを取得する GCP以外で動いている時は、環境変数を取得する

func Hostname

func Hostname() (string, error)

Hostname is Metadata ServerからHostnameを取得する /computeMetadata/v1/hostname {InstanceName}.{Zone}.c.{ProjectID}.internal

func InstanceID

func InstanceID() (string, error)

InstanceID is Metadata ServerからInstanceIDを取得する /computeMetadata/v1/instance/id Compute Engineが生成したVMを識別するための数値が返ってくる

func InstanceName

func InstanceName() (string, error)

InstanceName is Metadata ServerからInstanceNameを取得する /computeMetadata/v1/name Instance作成時に自分で着けたInstanceNameが返ってくる

func NewErrInvalidArgument

func NewErrInvalidArgument(message string, kv map[string]interface{}, err error) error

NewErrInvalidArgument is return ErrInvalidArgument

func NewErrNotFound

func NewErrNotFound(message string, kv map[string]interface{}, err error) error

NewErrNotFound is return ErrNotFound

func NumericProjectID

func NumericProjectID() (string, error)

NumericProjectID is Return current Numeric GCP ProjectID GCP上で動いている場合は、Project Metadataから取得し、そうでなければ、環境変数から取得する

func OnGCP

func OnGCP() bool

OnGCP is GCP上で動いているかどうかを返す GCP上と判断されるか確認したのは以下 Google App Engine Standard for Go 1.11 Google Compute Engine Google Kubernetes Engine

func ProjectID

func ProjectID() (string, error)

ProjectID is Return current GCP ProjectID GCP上で動いている場合は、Project Metadataから取得し、そうでなければ、環境変数から取得する

func Region

func Region() (string, error)

Region is Appが動いているRegionを取得する

func ServiceAccountDefaultToken

func ServiceAccountDefaultToken() (string, error)

ServiceAccountDefaultToken is Metadata ServerからServiceAccountDefaultTokenを取得する /computeMetadata/v1/instance/service-accounts/default/token

func ServiceAccountEmail

func ServiceAccountEmail() (string, error)

ServiceAccountEmail is Return current Service Account Email GCP上で動いている場合は、Metadataから取得し、そうでなければ、環境変数から取得する

func ServiceAccountID

func ServiceAccountID() (string, error)

ServiceAccountID is Return current Service Account ID fmt "projects/$PROJECT_ID/serviceAccounts/$SERVICE_ACCOUNT_EMAIL"

func ServiceAccountName

func ServiceAccountName() (string, error)

ServiceAccountName is Return current Service Account Name ServiceAccountEmailの@より前の部分を返す

func Zone

func Zone() (string, error)

Zone is Appが動いているZoneを取得する

Types

type Error

type Error struct {
	Code    string
	Message string
	KV      map[string]interface{}
	// contains filtered or unexported fields
}

Error is Error情報を保持する struct

func (*Error) Error

func (e *Error) Error() string

Error is error interface func

func (*Error) Is

func (e *Error) Is(target error) bool

Is is err equal check

func (*Error) Unwrap

func (e *Error) Unwrap() error

Unwrap is return unwrap error