api

package
v0.0.135 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 1, 2020 License: Apache-2.0 Imports: 15 Imported by: 7

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ErrNotFound = errors.New("Not Found")

ErrNotFound - Error to return when something is not found

View Source 
var ErrUnknown = errors.New("An unknown server error occured, please try again")

ErrUnknown - Error to return when an unknown server error occurs

Functions

func BoolPointer added in v0.0.98 

func BoolPointer(val bool) *bool

BoolPointer - Returns a pointer to a bool

func GetAccessToken 

func GetAccessToken(email, password, otp string) (string, error)

func IntPointer added in v0.0.98 

func IntPointer(val int) *int

IntPointer - Returns a pointer to an int

func IsClientError 

func IsClientError(err error) bool

func IsNotAuthenticatedError 

func IsNotAuthenticatedError(err error) bool

func IsNotFoundError 

func IsNotFoundError(err error) bool

func IsServerError 

func IsServerError(err error) bool

func SetBaseURL 

func SetBaseURL(url string)

func SetErrorLog added in v0.0.135 

func SetErrorLog(log bool)

func StringPointer added in v0.0.110 

func StringPointer(val string) *string

StringPointer - Returns a pointer to a string

Types

type AllocateIPAddressInput 

type AllocateIPAddressInput struct {
	AppID string `json:"appId"`
	Type  string `json:"type"`
}

type AllocationEvent 

type AllocationEvent struct {
	Timestamp time.Time
	Type      string
	Message   string
}

type AllocationStatus 

type AllocationStatus struct {
	ID                 string
	IDShort            string
	Version            int
	Region             string
	Status             string
	DesiredStatus      string
	Healthy            bool
	Canary             bool
	Failed             bool
	Restarts           int
	CreatedAt          time.Time
	UpdatedAt          time.Time
	Checks             []CheckState
	Events             []AllocationEvent
	LatestVersion      bool
	PassingCheckCount  int
	WarningCheckCount  int
	CriticalCheckCount int
	Transitioning      bool
	RecentLogs         []LogEntry
}

type ApiError 

type ApiError struct {
	WrappedError error
	Message      string
	Status       int
}

func ErrorFromResp 

func ErrorFromResp(resp *http.Response) *ApiError

func (*ApiError) Error 

func (e *ApiError) Error() string

type App 

type App struct {
	ID             string
	Name           string
	Status         string
	Deployed       bool
	Hostname       string
	AppURL         string
	Version        int
	Release        *Release
	Organization   Organization
	Secrets        []Secret
	CurrentRelease *Release
	Releases       struct {
		Nodes []Release
	}
	IPAddresses struct {
		Nodes []IPAddress
	}
	IPAddress *IPAddress
	Builds    struct {
		Nodes []Build
	}
	Changes struct {
		Nodes []AppChange
	}
	Certificates struct {
		Nodes []AppCertificate
	}
	Certificate      AppCertificate
	Services         []Service
	Config           AppConfig
	ParseConfig      AppConfig
	Allocations      []*AllocationStatus
	Allocation       *AllocationStatus
	DeploymentStatus *DeploymentStatus
	Autoscaling      *AutoscalingConfig
	VMSize           VMSize
	Regions          *[]Region
}

type AppCertificate 

type AppCertificate struct {
	ID                        string
	AcmeDNSConfigured         bool
	AcmeALPNConfigured        bool
	Configured                bool
	CertificateAuthority      string
	CreatedAt                 time.Time
	DNSProvider               string
	DNSValidationInstructions string
	DNSValidationHostname     string
	DNSValidationTarget       string
	Hostname                  string
	Source                    string
	ClientStatus              string
	Issued                    struct {
		Nodes []struct {
			ExpiresAt time.Time
			Type      string
		}
	}
}

type AppChange 

type AppChange struct {
	ID        string
	CreatedAt time.Time
	UpdatedAt time.Time
	Actor     struct {
		Type string
	}
	Status      string
	Description string
	Reason      string
	User        User
}

type AppCompact added in v0.0.135 

type AppCompact struct {
	ID           string
	Name         string
	Status       string
	Deployed     bool
	Hostname     string
	AppURL       string
	Version      int
	Release      *Release
	Organization Organization
	IPAddresses  struct {
		Nodes []IPAddress
	}
	Services []Service
}

type AppConfig 

type AppConfig struct {
	Definition Definition
	Services   []Service
	Valid      bool
	Errors     []string
}

type AppStatus added in v0.0.135 

type AppStatus struct {
	ID               string
	Name             string
	Deployed         bool
	Status           string
	Hostname         string
	Version          int
	AppURL           string
	Organization     Organization
	DeploymentStatus *DeploymentStatus
	Allocations      []*AllocationStatus
}

type AutoscaleRegionConfigInput added in v0.0.98 

type AutoscaleRegionConfigInput struct {
	Code     string `json:"code"`
	MinCount *int   `json:"minCount"`
	Weight   *int   `json:"weight"`
	Reset    *bool  `json:"reset"`
}

type AutoscalingConfig added in v0.0.98 

type AutoscalingConfig struct {
	BalanceRegions bool
	Enabled        bool
	MaxCount       int
	MinCount       int
	Regions        []AutoscalingRegionConfig
}

type AutoscalingRegionConfig added in v0.0.98 

type AutoscalingRegionConfig struct {
	Code     string
	MinCount int
	Weight   int
}

type Build 

type Build struct {
	ID         string
	InProgress bool
	Status     string
	User       User
	Logs       string
	Image      string
	CreatedAt  time.Time
	UpdatedAt  time.Time
}

type BuildArgInput added in v0.0.111 

type BuildArgInput struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type CLISessionAuth 

type CLISessionAuth struct {
	ID          string `json:"id"`
	AuthURL     string `json:"auth_url"`
	AccessToken string `json:"access_token"`
}

func GetAccessTokenForCLISession 

func GetAccessTokenForCLISession(id string) (CLISessionAuth, error)

func StartCLISessionWebAuth 

func StartCLISessionWebAuth(machineName string, signup bool) (CLISessionAuth, error)

type Check 

type Check struct {
	Type              string       `json:"type"`
	Interval          *uint64      `json:"interval"`
	Timeout           *uint64      `json:"timeout"`
	HTTPMethod        *string      `json:"httpMethod"`
	HTTPPath          *string      `json:"httpPath"`
	HTTPProtocol      *string      `json:"httpProtocol"`
	HTTPSkipTLSVerify *bool        `json:"httpTlsSkipVerify"`
	HTTPHeaders       []HTTPHeader `json:"httpHeaders"`
}

type CheckState 

type CheckState struct {
	Name        string
	Status      string
	Output      string
	ServiceName string
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

func NewClient 

func NewClient(accessToken string, version string) *Client

func (*Client) AddCertificate 

func (c *Client) AddCertificate(appName string, hostname string) (*AppCertificate, error)

func (*Client) AllocateIPAddress 

func (c *Client) AllocateIPAddress(appName string, addrType string) (*IPAddress, error)

func (*Client) AppAutoscalingConfig added in v0.0.98 

func (c *Client) AppAutoscalingConfig(appName string) (*AutoscalingConfig, error)

func (*Client) AppVMSize added in v0.0.98 

func (c *Client) AppVMSize(appName string) (VMSize, error)

func (*Client) CheckAppCertificate 

func (c *Client) CheckAppCertificate(appName string, hostname string) (*AppCertificate, error)

func (*Client) ConfigureRegions added in v0.0.121 

func (c *Client) ConfigureRegions(input ConfigureRegionsInput) ([]Region, error)

func (*Client) CreateApp 

func (client *Client) CreateApp(name string, orgId string) (*App, error)

func (*Client) CreateSignedUrls 

func (c *Client) CreateSignedUrls(appId string, filename string) (getUrl string, putUrl string, err error)

func (*Client) DeleteApp 

func (client *Client) DeleteApp(appName string) error

func (*Client) DeleteCertificate 

func (c *Client) DeleteCertificate(appName string, hostname string) (*DeleteCertificatePayload, error)

func (*Client) DeployImage 

func (client *Client) DeployImage(input DeployImageInput) (*Release, error)

func (*Client) FindIPAddress 

func (c *Client) FindIPAddress(appName string, address string) (*IPAddress, error)

func (*Client) GetAllocationStatus added in v0.0.109 

func (c *Client) GetAllocationStatus(appName string, allocID string, logLimit int) (*AllocationStatus, error)

func (*Client) GetApp 

func (client *Client) GetApp(appName string) (*App, error)

func (*Client) GetAppCertificate 

func (c *Client) GetAppCertificate(appName string, hostname string) (*AppCertificate, error)

func (*Client) GetAppCertificates 

func (c *Client) GetAppCertificates(appName string) ([]AppCertificate, error)

func (*Client) GetAppChanges 

func (c *Client) GetAppChanges(appName string) ([]AppChange, error)

func (*Client) GetAppCompact added in v0.0.135 

func (client *Client) GetAppCompact(appName string) (*AppCompact, error)

func (*Client) GetAppID added in v0.0.124 

func (client *Client) GetAppID(appName string) (string, error)

func (*Client) GetAppLogs 

func (c *Client) GetAppLogs(appName string, nextToken string, region string, instanceId string) ([]LogEntry, string, error)

func (*Client) GetAppReleases 

func (c *Client) GetAppReleases(appName string, limit int) ([]Release, error)

func (*Client) GetAppSecrets 

func (c *Client) GetAppSecrets(appName string) ([]Secret, error)

func (*Client) GetAppServices 

func (c *Client) GetAppServices(appName string) ([]Service, error)

func (*Client) GetAppStatus 

func (c *Client) GetAppStatus(appName string, showCompleted bool) (*AppStatus, error)

func (*Client) GetApps 

func (client *Client) GetApps() ([]App, error)

func (*Client) GetBuild 

func (c *Client) GetBuild(buildId string) (*Build, error)

func (*Client) GetConfig 

func (client *Client) GetConfig(appName string) (*AppConfig, error)

func (*Client) GetCurrentUser 

func (c *Client) GetCurrentUser() (*User, error)

func (*Client) GetDeploymentStatus 

func (c *Client) GetDeploymentStatus(appName string, deploymentID string) (*DeploymentStatus, error)

func (*Client) GetIPAddresses 

func (c *Client) GetIPAddresses(appName string) ([]IPAddress, error)

func (*Client) GetOrganizations 

func (client *Client) GetOrganizations() ([]Organization, error)

func (*Client) ListAppRegions added in v0.0.121 

func (c *Client) ListAppRegions(appName string) ([]Region, error)

func (*Client) ListBuilds 

func (c *Client) ListBuilds(appName string) ([]Build, error)

func (*Client) MoveApp 

func (client *Client) MoveApp(appName string, orgID string) (*App, error)

func (*Client) NewRequest 

func (c *Client) NewRequest(q string) *graphql.Request

func (*Client) OptimizeImage 

func (client *Client) OptimizeImage(appId string, image string) (string, error)

func (*Client) ParseConfig 

func (client *Client) ParseConfig(appName string, definition Definition) (*AppConfig, error)

func (*Client) PlatformRegions added in v0.0.95 

func (c *Client) PlatformRegions() ([]Region, error)

func (*Client) PlatformRegionsAll added in v0.0.133 

func (c *Client) PlatformRegionsAll() ([]Region, error)

func (*Client) PlatformVMSizes added in v0.0.98 

func (c *Client) PlatformVMSizes() ([]VMSize, error)

func (*Client) ReleaseIPAddress 

func (c *Client) ReleaseIPAddress(id string) error

func (*Client) RestartApp added in v0.0.128 

func (client *Client) RestartApp(appName string) (*App, error)

RestartApp - Send GQL mutation to restart app

func (*Client) ResumeApp added in v0.0.124 

func (client *Client) ResumeApp(appName string) (*App, error)

ResumeApp - Send GQL mutation to pause app

func (*Client) Run 

func (c *Client) Run(req *graphql.Request) (Query, error)

func (*Client) RunWithContext 

func (c *Client) RunWithContext(ctx context.Context, req *graphql.Request) (Query, error)

func (*Client) ScaleApp added in v0.0.94 

func (c *Client) ScaleApp(appID string, regions []ScaleRegionInput) ([]ScaleRegionChange, error)

func (*Client) SetAppVMSize added in v0.0.98 

func (c *Client) SetAppVMSize(appID string, sizeName string) (VMSize, error)

func (*Client) SetSecrets 

func (c *Client) SetSecrets(appName string, secrets map[string]string) (*Release, error)

func (*Client) StartBuild added in v0.0.111 

func (c *Client) StartBuild(input StartBuildInput) (*Build, error)

func (*Client) SuspendApp added in v0.0.135 

func (client *Client) SuspendApp(appName string) (*App, error)

SuspendApp - Send GQL mutation to suspend app

func (*Client) UnsetSecrets 

func (c *Client) UnsetSecrets(appName string, keys []string) (*Release, error)

func (*Client) UpdateAutoscaleConfig added in v0.0.98 

func (c *Client) UpdateAutoscaleConfig(input UpdateAutoscaleConfigInput) (*AutoscalingConfig, error)

type ConfigureRegionsInput added in v0.0.121 

type ConfigureRegionsInput struct {
	AppID        string   `json:"appId"`
	AllowRegions []string `json:"allowRegions"`
	DenyRegions  []string `json:"denyRegions"`
}

type CreateAppInput 

type CreateAppInput struct {
	OrganizationID string `json:"organizationId"`
	Runtime        string `json:"runtime"`
	Name           string `json:"name"`
}

type Definition 

type Definition map[string]interface{}

type DeleteCertificatePayload 

type DeleteCertificatePayload struct {
	App         App
	Certificate AppCertificate
}

type DeployImageInput 

type DeployImageInput struct {
	AppID      string      `json:"appId"`
	Image      string      `json:"image"`
	Services   *[]Service  `json:"services"`
	Definition *Definition `json:"definition"`
	Strategy   *string     `json:"strategy"`
}

type DeploymentStatus 

type DeploymentStatus struct {
	ID             string
	Status         string
	Description    string
	InProgress     bool
	Successful     bool
	CreatedAt      time.Time
	Allocations    []*AllocationStatus
	Version        int
	DesiredCount   int
	PlacedCount    int
	HealthyCount   int
	UnhealthyCount int
}

type Error added in v0.0.135 

type Error struct {
	Message    string
	Path       []string
	Extensions Extensions
}

type Errors added in v0.0.135 

type Errors []Error

type Extensions added in v0.0.135 

type Extensions struct {
	Code        string
	ServiceName string
	Query       string
	Variables   map[string]string
}

type HTTPHeader 

type HTTPHeader struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

type IPAddress 

type IPAddress struct {
	ID        string
	Address   string
	Type      string
	CreatedAt time.Time
}

type LogEntry 

type LogEntry struct {
	Timestamp string
	Message   string
	Level     string
	Instance  string
	Region    string
	Meta      struct {
		Instance string
		Region   string
	}
}

type LoggingTransport 

type LoggingTransport struct {
	// contains filtered or unexported fields
}

func (*LoggingTransport) RoundTrip 

func (t *LoggingTransport) RoundTrip(req *http.Request) (*http.Response, error)

type Organization 

type Organization struct {
	ID   string
	Name string
	Slug string
}

type PortHandler 

type PortHandler struct {
	Port     int      `json:"port"`
	Handlers []string `json:"handlers"`
}

type Query 

type Query struct {
	Errors Errors

	Apps struct {
		Nodes []App
	}
	App           App
	AppCompact    AppCompact
	AppStatus     AppStatus
	CurrentUser   User
	Organizations struct {
		Nodes []Organization
	}

	Build Build

	Platform struct {
		Regions []Region
		VMSizes []VMSize
	}

	// mutations
	CreateApp struct {
		App App
	}

	SetSecrets struct {
		Release Release
	}

	UnsetSecrets struct {
		Release Release
	}

	DeployImage struct {
		Release Release
	}

	OptimizeImage struct {
		Status string
	}

	CreateSignedUrl SignedUrls

	StartBuild struct {
		Build Build
	}

	AddCertificate struct {
		Certificate AppCertificate
	}

	DeleteCertificate DeleteCertificatePayload

	CheckCertificate struct {
		App         *App
		Certificate *AppCertificate
	}

	AllocateIPAddress struct {
		App       App
		IPAddress IPAddress
	}
	ReleaseIPAddress struct {
		App App
	}
	ScaleApp struct {
		App       App
		Placement []RegionPlacement
		Delta     []ScaleRegionChange
	}

	UpdateAutoscaleConfig struct {
		App App
	}

	SetVMSize struct {
		App    App
		VMSize *VMSize
	}

	ConfigureRegions struct {
		App     App
		Regions []Region
	}

	ResumeApp struct {
		App App
	}

	SuspendApp struct {
		App App
	}

	RestartApp struct {
		App App
	}
}

Query - Master query which encapsulates all possible returned structures

type Region added in v0.0.95 

type Region struct {
	Code      string
	Name      string
	Latitude  float32
	Longitude float32
}

type RegionPlacement added in v0.0.94 

type RegionPlacement struct {
	Region string
	Count  int
}

type Release 

type Release struct {
	ID                 string
	Version            int
	Stable             bool
	InProgress         bool
	Reason             string
	Description        string
	Status             string
	DeploymentStrategy string
	Deployment         DeploymentStatus
	User               User
	CreatedAt          time.Time
}

type ReleaseIPAddressInput 

type ReleaseIPAddressInput struct {
	IPAddressID string `json:"ipAddressId"`
}

type ScaleAppInput added in v0.0.94 

type ScaleAppInput struct {
	AppID   string             `json:"appId"`
	Regions []ScaleRegionInput `json:"regions"`
}

type ScaleRegionChange added in v0.0.94 

type ScaleRegionChange struct {
	Region    string
	FromCount int
	ToCount   int
}

type ScaleRegionInput added in v0.0.94 

type ScaleRegionInput struct {
	Region string `json:"region"`
	Count  int    `json:"count"`
}

type Secret 

type Secret struct {
	Name      string
	Digest    string
	CreatedAt time.Time
}

type Service 

type Service struct {
	Description     string        `json:"description"`
	Protocol        string        `json:"protocol,omitempty"`
	InternalPort    int           `json:"internalPort,omitempty"`
	Ports           []PortHandler `json:"ports,omitempty"`
	Checks          []Check       `json:"checks,omitempty"`
	SoftConcurrency int           `json:"softConcurrency,omitempty"`
	HardConcurrency int           `json:"hardConcurrency,omitempty"`
}

type SetSecretsInput 

type SetSecretsInput struct {
	AppID   string                  `json:"appId"`
	Secrets []SetSecretsInputSecret `json:"secrets"`
}

type SetSecretsInputSecret 

type SetSecretsInputSecret struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type SetVMSizeInput added in v0.0.98 

type SetVMSizeInput struct {
	AppID    string `json:"appId"`
	SizeName string `json:"sizeName"`
}

type SignedUrls 

type SignedUrls struct {
	GetUrl string
	PutUrl string
}

type StartBuildInput added in v0.0.111 

type StartBuildInput struct {
	AppID      string          `json:"appId"`
	SourceURL  string          `json:"sourceUrl"`
	SourceType string          `json:"sourceType"`
	BuildType  *string         `json:"buildType"`
	BuildArgs  []BuildArgInput `json:"buildArgs"`
}

type UnsetSecretsInput 

type UnsetSecretsInput struct {
	AppID string   `json:"appId"`
	Keys  []string `json:"keys"`
}

type UpdateAutoscaleConfigInput added in v0.0.98 

type UpdateAutoscaleConfigInput struct {
	AppID          string                       `json:"appId"`
	Enabled        *bool                        `json:"enabled"`
	MinCount       *int                         `json:"minCount"`
	MaxCount       *int                         `json:"maxCount"`
	BalanceRegions *bool                        `json:"balanceRegions"`
	ResetRegions   *bool                        `json:"resetRegions"`
	Regions        []AutoscaleRegionConfigInput `json:"regions"`
}

type User 

type User struct {
	ID    string
	Name  string
	Email string
}

type VMSize added in v0.0.98 

type VMSize struct {
	Name        string
	CPUCores    float32
	MemoryGB    float32
	MemoryMB    int
	PriceMonth  float32
	PriceSecond float32
}

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.