Documentation ¶
Index ¶
- Variables
- func BoolPointer(val bool) *bool
- func GetAccessToken(email, password, otp string) (string, error)
- func IntPointer(val int) *int
- func IsClientError(err error) bool
- func IsNotAuthenticatedError(err error) bool
- func IsNotFoundError(err error) bool
- func IsServerError(err error) bool
- func SetBaseURL(url string)
- func SetErrorLog(log bool)
- func StringPointer(val string) *string
- type AllocateIPAddressInput
- type AllocationEvent
- type AllocationStatus
- type ApiError
- type App
- type AppCertificate
- type AppCertificateCompact
- type AppCertsCompact
- type AppChange
- type AppCompact
- type AppConfig
- type AppStatus
- type AutoscaleRegionConfigInput
- type AutoscalingConfig
- type AutoscalingRegionConfig
- type Billable
- type Build
- type BuildArgInput
- type CLISessionAuth
- type Check
- type CheckDomainResult
- type CheckState
- type Client
- func (c *Client) AddCertificate(appName, hostname string) (*AppCertificate, *HostnameCheck, error)
- func (c *Client) AllocateIPAddress(appName string, addrType string) (*IPAddress, error)
- func (c *Client) AppAutoscalingConfig(appName string) (*AutoscalingConfig, error)
- func (c *Client) AppVMSize(appName string) (VMSize, error)
- func (c *Client) CheckAppCertificate(appName, hostname string) (*AppCertificate, *HostnameCheck, error)
- func (c *Client) CheckDomain(name string) (*CheckDomainResult, error)
- func (c *Client) ConfigureRegions(input ConfigureRegionsInput) ([]Region, []Region, error)
- func (c *Client) CreateAndRegisterDomain(organizationID string, name string) (*Domain, error)
- func (client *Client) CreateApp(name string, orgId string) (*App, error)
- func (c *Client) CreateDomain(organizationID string, name string) (*Domain, error)
- func (c *Client) CreateOrganization(organizationname string) (*Organization, error)
- func (c *Client) CreateSignedUrls(appId string, filename string) (getUrl string, putUrl string, err error)
- func (c *Client) CreateVolume(appName string, volname string, region string, sizeGb int) (*Volume, error)
- func (client *Client) DeleteApp(appName string) error
- func (c *Client) DeleteCertificate(appName, hostname string) (*DeleteCertificatePayload, error)
- func (c *Client) DeleteOrganization(id string) (deletedid string, err error)
- func (c *Client) DeleteVolume(volID string) (App *App, err error)
- func (client *Client) DeployImage(input DeployImageInput) (*Release, error)
- func (c *Client) ExportDNSRecords(domainId string) (string, error)
- func (c *Client) FindIPAddress(appName string, address string) (*IPAddress, error)
- func (client *Client) FindOrganizationBySlug(slug string) (*Organization, error)
- func (c *Client) GetAllocationStatus(appName string, allocID string, logLimit int) (*AllocationStatus, error)
- func (client *Client) GetApp(appName string) (*App, error)
- func (c *Client) GetAppCertificates(appName string) ([]AppCertificateCompact, error)
- func (c *Client) GetAppChanges(appName string) ([]AppChange, error)
- func (client *Client) GetAppCompact(appName string) (*AppCompact, error)
- func (client *Client) GetAppID(appName string) (string, error)
- func (c *Client) GetAppLogs(appName string, nextToken string, region string, instanceId string) ([]LogEntry, string, error)
- func (c *Client) GetAppReleases(appName string, limit int) ([]Release, error)
- func (c *Client) GetAppSecrets(appName string) ([]Secret, error)
- func (c *Client) GetAppServices(appName string) ([]Service, error)
- func (c *Client) GetAppStatus(appName string, showCompleted bool) (*AppStatus, error)
- func (client *Client) GetApps() ([]App, error)
- func (c *Client) GetBuild(buildId string) (*Build, error)
- func (client *Client) GetConfig(appName string) (*AppConfig, error)
- func (client *Client) GetCurrentOrganizations() (Organization, []Organization, error)
- func (c *Client) GetCurrentUser() (*User, error)
- func (c *Client) GetDNSRecords(domainName string) ([]*DNSRecord, error)
- func (c *Client) GetDeploymentStatus(appName string, deploymentID string) (*DeploymentStatus, error)
- func (c *Client) GetDomain(name string) (*Domain, error)
- func (c *Client) GetDomains(organizationSlug string) ([]*Domain, error)
- func (c *Client) GetIPAddresses(appName string) ([]IPAddress, error)
- func (client *Client) GetOrganizationBySlug(slug string) (*OrganizationDetails, error)
- func (client *Client) GetOrganizations() ([]Organization, error)
- func (c *Client) GetVolume(volID string) (Volume *Volume, err error)
- func (c *Client) GetVolumes(appName string) ([]Volume, error)
- func (c *Client) ImportDNSRecords(domainId string, zonefile string) ([]ImportDnsWarning, []ImportDnsChange, error)
- func (c *Client) ListAppRegions(appName string) ([]Region, []Region, error)
- func (c *Client) ListBuilds(appName string) ([]Build, error)
- func (client *Client) MoveApp(appName string, orgID string) (*App, error)
- func (c *Client) NewRequest(q string) *graphql.Request
- func (client *Client) OptimizeImage(appId string, image string) (string, error)
- func (client *Client) ParseConfig(appName string, definition Definition) (*AppConfig, error)
- func (c *Client) PlatformRegions() ([]Region, error)
- func (c *Client) PlatformRegionsAll() ([]Region, error)
- func (c *Client) PlatformVMSizes() ([]VMSize, error)
- func (c *Client) ReleaseIPAddress(id string) error
- func (client *Client) RestartApp(appName string) (*App, error)
- func (client *Client) ResumeApp(appName string) (*App, error)
- func (c *Client) Run(req *graphql.Request) (Query, error)
- func (c *Client) RunWithContext(ctx context.Context, req *graphql.Request) (Query, error)
- func (c *Client) ScaleApp(appID string, regions []ScaleRegionInput) ([]ScaleRegionChange, error)
- func (c *Client) SetAppVMSize(appID string, sizeName string) (VMSize, error)
- func (c *Client) SetSecrets(appName string, secrets map[string]string) (*Release, error)
- func (c *Client) StartBuild(input StartBuildInput) (*Build, error)
- func (client *Client) SuspendApp(appName string) (*App, error)
- func (c *Client) UnsetSecrets(appName string, keys []string) (*Release, error)
- func (c *Client) UpdateAutoscaleConfig(input UpdateAutoscaleConfigInput) (*AutoscalingConfig, error)
- type ConfigureRegionsInput
- type CreateAppInput
- type CreateOrganizationPayload
- type CreateVolumeInput
- type CreateVolumePayload
- type DNSRecord
- type DNSRecords
- type Definition
- type DeleteCertificatePayload
- type DeleteOrganizationPayload
- type DeleteVolumeInput
- type DeleteVolumePayload
- type DeployImageInput
- type DeploymentStatus
- type Domain
- type Error
- type Errors
- type Extensions
- type HTTPHeader
- type HostnameCheck
- type IPAddress
- type ImportDnsChange
- type ImportDnsWarning
- type LogEntry
- type LoggingTransport
- type Organization
- type OrganizationDetails
- type OrganizationMembershipEdge
- type PortHandler
- type Query
- type Region
- type RegionPlacement
- type Release
- type ReleaseIPAddressInput
- type ScaleAppInput
- type ScaleRegionChange
- type ScaleRegionInput
- type Secret
- type Service
- type SetSecretsInput
- type SetSecretsInputSecret
- type SetVMSizeInput
- type SignedUrls
- type StartBuildInput
- type UnsetSecretsInput
- type UpdateAutoscaleConfigInput
- type User
- type UserOrganizations
- type VMSize
- type Volume
Constants ¶
This section is empty.
Variables ¶
var ErrNotFound = errors.New("Not Found")
ErrNotFound - Error to return when something is not found
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
BoolPointer - Returns a pointer to a bool
func GetAccessToken ¶
GetAccessToken - uses email, password and possible otp to get token
func IntPointer ¶ added in v0.0.98
IntPointer - Returns a pointer to an int
func IsClientError ¶
func IsNotAuthenticatedError ¶
func IsNotFoundError ¶
func IsServerError ¶
func SetErrorLog ¶ added in v0.0.135
func SetErrorLog(log bool)
SetErrorLog - Sets whether errors should be loddes
func StringPointer ¶ added in v0.0.110
StringPointer - Returns a pointer to a string
Types ¶
type AllocateIPAddressInput ¶
type AllocationEvent ¶
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 ¶
func ErrorFromResp ¶
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 BackupRegions *[]Region Volumes struct { Nodes []Volume } }
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 IsApex bool IsWildcard bool Issued struct { Nodes []struct { ExpiresAt time.Time Type string } } }
type AppCertificateCompact ¶ added in v0.0.138
type AppCertsCompact ¶ added in v0.0.138
type AppCertsCompact struct { Certificates struct { Nodes []AppCertificateCompact } }
type AppCompact ¶ added in v0.0.135
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 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 BuildArgInput ¶ added in v0.0.111
type CLISessionAuth ¶
type CLISessionAuth struct { ID string `json:"id"` AuthURL string `json:"auth_url"` AccessToken string `json:"access_token"` }
CLISessionAuth holds access information
func GetAccessTokenForCLISession ¶
func GetAccessTokenForCLISession(id string) (CLISessionAuth, error)
GetAccessTokenForCLISession Obtains the access token for the session
func StartCLISessionWebAuth ¶
func StartCLISessionWebAuth(machineName string, signup bool) (CLISessionAuth, error)
StartCLISessionWebAuth starts a session with the platform via web auth
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 CheckDomainResult ¶ added in v0.0.144
type CheckState ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client - API client encapsulating the http and GraphQL clients
func (*Client) AddCertificate ¶
func (c *Client) AddCertificate(appName, hostname string) (*AppCertificate, *HostnameCheck, error)
func (*Client) AllocateIPAddress ¶
func (*Client) AppAutoscalingConfig ¶ added in v0.0.98
func (c *Client) AppAutoscalingConfig(appName string) (*AutoscalingConfig, error)
func (*Client) CheckAppCertificate ¶
func (c *Client) CheckAppCertificate(appName, hostname string) (*AppCertificate, *HostnameCheck, error)
func (*Client) CheckDomain ¶ added in v0.0.144
func (c *Client) CheckDomain(name string) (*CheckDomainResult, error)
func (*Client) ConfigureRegions ¶ added in v0.0.121
func (c *Client) ConfigureRegions(input ConfigureRegionsInput) ([]Region, []Region, error)
func (*Client) CreateAndRegisterDomain ¶ added in v0.0.144
func (*Client) CreateDomain ¶ added in v0.0.144
func (*Client) CreateOrganization ¶ added in v0.0.138
func (c *Client) CreateOrganization(organizationname string) (*Organization, error)
func (*Client) CreateSignedUrls ¶
func (*Client) CreateVolume ¶ added in v0.0.145
func (*Client) DeleteCertificate ¶
func (c *Client) DeleteCertificate(appName, hostname string) (*DeleteCertificatePayload, error)
func (*Client) DeleteOrganization ¶ added in v0.0.138
func (*Client) DeleteVolume ¶ added in v0.0.145
func (*Client) DeployImage ¶
func (client *Client) DeployImage(input DeployImageInput) (*Release, error)
func (*Client) ExportDNSRecords ¶ added in v0.0.138
func (*Client) FindIPAddress ¶
func (*Client) FindOrganizationBySlug ¶ added in v0.0.138
func (client *Client) FindOrganizationBySlug(slug string) (*Organization, error)
func (*Client) GetAllocationStatus ¶ added in v0.0.109
func (*Client) GetAppCertificates ¶
func (c *Client) GetAppCertificates(appName string) ([]AppCertificateCompact, error)
func (*Client) GetAppCompact ¶ added in v0.0.135
func (client *Client) GetAppCompact(appName string) (*AppCompact, error)
func (*Client) GetAppLogs ¶
func (*Client) GetAppReleases ¶
func (*Client) GetAppStatus ¶
func (*Client) GetCurrentOrganizations ¶ added in v0.0.138
func (client *Client) GetCurrentOrganizations() (Organization, []Organization, error)
func (*Client) GetCurrentUser ¶
func (*Client) GetDNSRecords ¶ added in v0.0.138
func (*Client) GetDeploymentStatus ¶
func (c *Client) GetDeploymentStatus(appName string, deploymentID string) (*DeploymentStatus, error)
func (*Client) GetDomains ¶ added in v0.0.144
func (*Client) GetIPAddresses ¶
func (*Client) GetOrganizationBySlug ¶ added in v0.0.138
func (client *Client) GetOrganizationBySlug(slug string) (*OrganizationDetails, error)
func (*Client) GetOrganizations ¶
func (client *Client) GetOrganizations() ([]Organization, error)
func (*Client) GetVolumes ¶ added in v0.0.145
func (*Client) ImportDNSRecords ¶ added in v0.0.138
func (c *Client) ImportDNSRecords(domainId string, zonefile string) ([]ImportDnsWarning, []ImportDnsChange, error)
func (*Client) ListAppRegions ¶ added in v0.0.121
func (*Client) NewRequest ¶
NewRequest - creates a new GraphQL request
func (*Client) OptimizeImage ¶
func (*Client) ParseConfig ¶
func (client *Client) ParseConfig(appName string, definition Definition) (*AppConfig, error)
func (*Client) PlatformRegions ¶ added in v0.0.95
func (*Client) PlatformRegionsAll ¶ added in v0.0.133
func (*Client) PlatformVMSizes ¶ added in v0.0.98
func (*Client) ReleaseIPAddress ¶
func (*Client) RestartApp ¶ added in v0.0.128
RestartApp - Send GQL mutation to restart app
func (*Client) RunWithContext ¶
RunWithContext - Runs a GraphQL request within a Go context
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 (*Client) SetSecrets ¶
func (*Client) StartBuild ¶ added in v0.0.111
func (c *Client) StartBuild(input StartBuildInput) (*Build, error)
func (*Client) SuspendApp ¶ added in v0.0.135
SuspendApp - Send GQL mutation to suspend app
func (*Client) UnsetSecrets ¶
func (*Client) UpdateAutoscaleConfig ¶ added in v0.0.98
func (c *Client) UpdateAutoscaleConfig(input UpdateAutoscaleConfigInput) (*AutoscalingConfig, error)
type ConfigureRegionsInput ¶ added in v0.0.121
type CreateAppInput ¶
type CreateOrganizationPayload ¶ added in v0.0.138
type CreateOrganizationPayload struct {
Organization Organization
}
type CreateVolumeInput ¶ added in v0.0.145
type CreateVolumePayload ¶ added in v0.0.145
type DNSRecords ¶ added in v0.0.138
type Definition ¶
type Definition map[string]interface{}
type DeleteCertificatePayload ¶
type DeleteCertificatePayload struct { App App Certificate AppCertificate }
type DeleteOrganizationPayload ¶ added in v0.0.138
type DeleteOrganizationPayload struct {
DeletedOrganizationId string
}
type DeleteVolumeInput ¶ added in v0.0.145
type DeleteVolumeInput struct {
VolumeID string `json:"volumeId"`
}
type DeleteVolumePayload ¶ added in v0.0.145
type DeleteVolumePayload struct {
App App
}
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 Error ¶ added in v0.0.135
type Error struct { Message string Path []string Extensions Extensions }
type Extensions ¶ added in v0.0.135
type HTTPHeader ¶
type HostnameCheck ¶ added in v0.0.138
type HostnameCheck struct { ARecords []string `json:"aRecords"` AAAARecords []string `json:"aaaaRecords"` CNAMERecords []string `json:"cnameRecords"` SOA string `json:"soa"` DNSProvider string `json:"dnsProvider"` DNSVerificationRecord string `json:"dnsVerificationRecord"` ResolvedAddresses []string `json:"resolvedAddresses"` }
type ImportDnsChange ¶ added in v0.0.144
type ImportDnsWarning ¶ added in v0.0.144
type LoggingTransport ¶
type LoggingTransport struct {
// contains filtered or unexported fields
}
type Organization ¶
type OrganizationDetails ¶ added in v0.0.138
type OrganizationMembershipEdge ¶ added in v0.0.138
type PortHandler ¶
type Query ¶
type Query struct { Errors Errors Apps struct { Nodes []App } App App AppCompact AppCompact AppStatus AppStatus AppCertsCompact AppCertsCompact CurrentUser User Organizations struct { Nodes []Organization } Organization *Organization UserOrganizations UserOrganizations OrganizationDetails OrganizationDetails Build Build Volume Volume Domain *Domain Node interface{} Nodes []interface{} 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 Check *HostnameCheck } DeleteCertificate DeleteCertificatePayload CheckCertificate struct { App *App Certificate *AppCertificate Check *HostnameCheck } 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 BackupRegions []Region } ResumeApp struct { App App } SuspendApp struct { App App } RestartApp struct { App App } CreateDomain struct { Domain *Domain } CreateAndRegisterDomain struct { Domain *Domain } CheckDomain *CheckDomainResult ExportDnsZone struct { Contents string } ImportDnsZone struct { Warnings []ImportDnsWarning Changes []ImportDnsChange } CreateOrganization CreateOrganizationPayload DeleteOrganization DeleteOrganizationPayload CreateVolume CreateVolumePayload DeleteVolume DeleteVolumePayload }
Query - Master query which encapsulates all possible returned structures
type RegionPlacement ¶ added in v0.0.94
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 ScaleRegionInput ¶ added in v0.0.94
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 SetVMSizeInput ¶ added in v0.0.98
type SignedUrls ¶
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 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 UserOrganizations ¶ added in v0.0.138
type UserOrganizations struct { PersonalOrganization Organization Organizations struct { Nodes []Organization } }
Source Files ¶
- api.go
- auth.go
- casting.go
- client.go
- error.go
- http.go
- resource_activity.go
- resource_apps.go
- resource_builds.go
- resource_certificates.go
- resource_config.go
- resource_deploy.go
- resource_dns.go
- resource_domains.go
- resource_ip_addresses.go
- resource_logs.go
- resource_monitoring.go
- resource_organizations.go
- resource_platform.go
- resource_regions.go
- resource_releases.go
- resource_scale.go
- resource_secrets.go
- resource_services.go
- resource_user.go
- resource_volumes.go
- types.go