Documentation
¶
Index ¶
- func New(v *validator.Validate, opts ...clientOption) (*client, error)
- func WithAdminEmail(email string) clientOption
- func WithTimeout(dur time.Duration) clientOption
- func WithURL(url string) clientOption
- type AWSSettings
- type App
- type AzureAccount
- type Client
- type Component
- type CreateCanaryUserRequest
- type CreateCanaryUserResponse
- type CreateIntegrationUserRequest
- type CreateIntegrationUserResponse
- type CreateSeedUserRequest
- type CreateSeedUserResponse
- type DeprovisionCanaryRequest
- type Install
- type Org
- type ProvisionCanaryRequest
- type Release
- type Runner
- type RunnerGroup
- type RunnerGroupSettings
- type RunnerServiceAccount
- type RunnerServiceAccountTokenRequest
- type RunnerServiceAccountTokenResponse
- type StartCanaryCron
- type StopCanaryCron
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WithAdminEmail ¶
func WithAdminEmail(email string) clientOption
WithAdminEmail specifies the email to use
func WithTimeout ¶
WithTimeout specifies the timeout to use
Types ¶
type AWSSettings ¶
type AWSSettings struct {
Region string `json:"region"`
}
type AzureAccount ¶
type AzureAccount struct{}
type Client ¶
type Client interface {
ListOrgs(ctx context.Context, typ string) ([]Org, error)
DeleteOrg(ctx context.Context, orgID string) error
DeprovisionOrg(ctx context.Context, orgID string) error
ReprovisionOrg(ctx context.Context, orgID string) error
RestartOrg(ctx context.Context, orgID string) error
AddSupportUsers(ctx context.Context, orgID string) error
UpdateOrgFeatures(ctx context.Context, orgID string, features map[string]bool) error
GetFeatures(ctx context.Context) ([]string, error)
ListApps(ctx context.Context) ([]App, error)
ReprovisionApp(ctx context.Context, appID string) error
RestartApp(ctx context.Context, appID string) error
UpdateAppSandbox(ctx context.Context, appID string) error
GetInstall(ctx context.Context, id string) (*Install, error)
ListInstalls(ctx context.Context, typ string) ([]Install, error)
ReprovisionInstall(ctx context.Context, installID string) error
RestartInstall(ctx context.Context, installID string) error
DeprovisionInstall(ctx context.Context, installID string) error
DeleteInstall(ctx context.Context, installID string) error
UpdateInstallSandbox(ctx context.Context, installID string) error
ListComponents(ctx context.Context) ([]Component, error)
RestartComponent(ctx context.Context, componentID string) error
ListReleases(ctx context.Context) ([]Release, error)
RestartRelease(ctx context.Context, releaseID string) error
ProvisionCanary(ctx context.Context, sandboxMode bool) error
DeprovisionCanary(ctx context.Context, canaryID string) error
StartCanaryCron(ctx context.Context) error
StopCanaryCron(ctx context.Context) error
CreateIntegrationUser(ctx context.Context) (*CreateIntegrationUserResponse, error)
CreateCanaryUser(ctx context.Context, canaryID string) (*CreateCanaryUserResponse, error)
CreateSeedUser(ctx context.Context) (*CreateSeedUserResponse, error)
ListRunners(ctx context.Context, typ string) ([]Runner, error)
GetRunner(ctx context.Context, id string) (*Runner, error)
RestartRunner(ctx context.Context, runnerID string) error
GetRunnerGroup(ctx context.Context, id string) (*RunnerGroup, error)
GetRunnerServiceAccount(ctx context.Context, runnerID string) (*RunnerServiceAccount, error)
GetRunnerServiceAccountToken(ctx context.Context, runnerID string, dur time.Duration, invalidate bool) (string, error)
}
type CreateCanaryUserRequest ¶
type CreateCanaryUserRequest struct {
CanaryID string `json:"canary_id"`
}
type CreateIntegrationUserRequest ¶
type CreateIntegrationUserRequest struct{}
type CreateSeedUserRequest ¶
type CreateSeedUserRequest struct{}
type CreateSeedUserResponse ¶
type DeprovisionCanaryRequest ¶
type DeprovisionCanaryRequest struct {
CanaryID string `json:"canary_id"`
}
type Install ¶
type Install struct {
Id string `json:"id"`
Name string `json:"name"`
SandboxStatus string `json:"sandbox_status"`
Status string `json:"status"`
AWSAccount *AWSSettings `json:"aws_account"`
AzureAccount *AzureAccount `json:"azure_account"`
}
type ProvisionCanaryRequest ¶
type ProvisionCanaryRequest struct {
SandboxMode bool `json:"sandbox_mode"`
}
type RunnerGroup ¶
type RunnerGroup struct {
Type string `json:"type"`
OwnerID string `json:"owner_id"`
Settings *RunnerGroupSettings `json:"settings"`
}
type RunnerGroupSettings ¶
type RunnerGroupSettings struct {
LocalAWSIAMRoleARN string
}
type RunnerServiceAccount ¶
type RunnerServiceAccount struct {
Email string `json:"email"`
}
type RunnerServiceAccountTokenResponse ¶
type RunnerServiceAccountTokenResponse struct {
Token string `json:"token"`
}
type StartCanaryCron ¶
type StartCanaryCron struct{}
type StopCanaryCron ¶
type StopCanaryCron struct{}
Click to show internal directories.
Click to hide internal directories.