api

Documentation

Index

• type Client
  • func New(host string, accessToken string) *Client
  • func (c *Client) BuildProject(ctx context.Context, projectID uuid.UUID, branch string, noCache bool) (*Deployment, error)
  • func (c *Client) DeployProjectBranch(ctx context.Context, projectID uuid.UUID, branch string, noCache bool) (*Deployment, error)
  • func (c *Client) GetBuildLogs(ctx context.Context, deployID uuid.UUID) (out []LogEntry, err error)
  • func (c *Client) GetCurrentUser(ctx context.Context) (*User, error)
  • func (c *Client) GetDeployment(ctx context.Context, deploymentID uuid.UUID) (*Deployment, error)
  • func (c *Client) GetDeploymentLogs(ctx context.Context, deployID uuid.UUID) (out []LogEntry, err error)
  • func (c *Client) GetProductionBranch(ctx context.Context, projectID uuid.UUID) (string, error)
  • func (c *Client) GetProjectByPath(ctx context.Context, project string) (*Project, error)
  • func (c *Client) GetProjectLogs(ctx context.Context, projectID uuid.UUID) ([]string, error)
• type Deployment
• type DeploymentStatus
• type LogEntry
• type Project
• type User

Types

type Client

type Client struct {
	GQL          graphql.Client
	Subscription *hgql.SubscriptionClient
}

func New

func New(host string, accessToken string) *Client

func (*Client) BuildProject

func (c *Client) BuildProject(ctx context.Context, projectID uuid.UUID, branch string, noCache bool) (*Deployment, error)

func (*Client) DeployProjectBranch

func (c *Client) DeployProjectBranch(ctx context.Context, projectID uuid.UUID, branch string, noCache bool) (*Deployment, error)

func (*Client) GetBuildLogs

func (c *Client) GetBuildLogs(ctx context.Context, deployID uuid.UUID) (out []LogEntry, err error)

func (*Client) GetCurrentUser

func (c *Client) GetCurrentUser(ctx context.Context) (*User, error)

func (*Client) GetDeployment

func (c *Client) GetDeployment(ctx context.Context, deploymentID uuid.UUID) (*Deployment, error)

func (*Client) GetDeploymentLogs

func (c *Client) GetDeploymentLogs(ctx context.Context, deployID uuid.UUID) (out []LogEntry, err error)

func (*Client) GetProductionBranch

func (c *Client) GetProductionBranch(ctx context.Context, projectID uuid.UUID) (string, error)

func (*Client) GetProjectByPath

func (c *Client) GetProjectByPath(ctx context.Context, project string) (*Project, error)

func (*Client) GetProjectLogs

func (c *Client) GetProjectLogs(ctx context.Context, projectID uuid.UUID) ([]string, error)

type Deployment

type Deployment struct {
	ID              uuid.UUID        `copier:"Id"`
	Status          DeploymentStatus `copier:"Status"`
	Branch          string
	Endpoints       []string
	PrivateEndpoint string
}

type DeploymentStatus

type DeploymentStatus string

const (
	DeploymentStatusBuildPending      DeploymentStatus = "BUILD_PENDING"
	DeploymentStatusBuildInProgress   DeploymentStatus = "BUILD_IN_PROGRESS"
	DeploymentStatusBuildFailed       DeploymentStatus = "BUILD_FAILED"
	DeploymentStatusBuildSucceeded    DeploymentStatus = "BUILD_SUCCEEDED"
	DeploymentStatusDeployPending     DeploymentStatus = "DEPLOY_PENDING"
	DeploymentStatusDeployInProgress  DeploymentStatus = "DEPLOY_IN_PROGRESS"
	DeploymentStatusReleaseInProgress DeploymentStatus = "RELEASE_IN_PROGRESS"
	DeploymentStatusDeployFailed      DeploymentStatus = "DEPLOY_FAILED"
	DeploymentStatusDeploySucceeded   DeploymentStatus = "DEPLOY_SUCCEEDED"
	DeploymentStatusBuildAborted      DeploymentStatus = "BUILD_ABORTED"
	DeploymentStatusDeployStopped     DeploymentStatus = "DEPLOY_STOPPED"
	DeploymentStatusDeployHealhty     DeploymentStatus = "DEPLOY_HEALHTY"
	DeploymentStatusDeployCrashing    DeploymentStatus = "DEPLOY_CRASHING"
)

type LogEntry

type LogEntry struct {
	Text      string
	Timestamp time.Time
}

type Project

type Project struct {
	ID uuid.UUID
}

type User

type User struct {
	Id    uuid.UUID
	Login string
}