providers

type Detector interface {
	// Name returns the name of the provider.
	Name() string
	// Provider returns a non-empty string and no error,
	// if a provider is successfully detected.
	Provider(context.Context) (string, error)
	// PublicIPv4 returns a non-empty string and no error,
	// if a public IPv4 is successfully detected.
	PublicIPv4(context.Context) (string, error)
	// PrivateIPv4 returns a non-empty string and no error,
	// if a private IPv4 is successfully detected.
	PrivateIPv4(context.Context) (string, error)
	// VMEnvironment returns a non-empty string and no error,
	// if a VM environment is successfully detected.
	// e.g., "azEnvironment" as "AZUREPUBLICCLOUD" for Azure.
	VMEnvironment(context.Context) (string, error)
	// InstanceID returns an instance id generated by provider.
	InstanceID(ctx context.Context) (string, error)
}

type DetectorOption func(*detector)

type Info struct {
	Provider      string `json:"provider"`
	PublicIP      string `json:"public_ip"`
	PrivateIP     string `json:"private_ip"`
	Region        string `json:"region"`
	VMEnvironment string `json:"vm_environment"`
	InstanceID    string `json:"instance_id"`
	IMDSDetected  bool   `json:"-"`
}

type RegionDetector interface {
	// Region returns a non-empty provider-specific region and no error,
	// if a region is successfully detected.
	Region(context.Context) (string, error)
}