Documentation
¶
Index ¶
- Variables
- type BuildCardinalFlags
- type ChangeUserRoleInOrganizationFlags
- type CommandState
- type CreateOrganizationFlags
- type CreateProjectFlags
- type Credential
- type DeploymentHealthCheckResult
- type DeploymentPreview
- type DevCardinalFlags
- type InviteUserToOrganizationFlags
- type LoginRequirement
- type LoginToken
- type MembersListFlags
- type Organization
- type OrganizationMember
- type Project
- type ProjectConfig
- type ProjectConfigDiscord
- type ProjectConfigSlack
- type PurgeCardinalFlags
- type RestartCardinalFlags
- type Role
- type SetupRequest
- type SetupRequirement
- type StartCardinalFlags
- type StartEVMFlags
- type StopCardinalFlags
- type StopEVMFlags
- type SwitchOrganizationFlags
- type SwitchProjectFlags
- type TemporaryCredential
- type UpdateProjectFlags
- type UpdateUserFlags
- type User
Constants ¶
This section is empty.
Variables ¶
View Source
var RolesMap = map[Role]struct{}{ RoleOwner: {}, RoleAdmin: {}, RoleMember: {}, RoleNone: {}, }
RolesMap is used for checking if a role is valid.
Functions ¶
This section is empty.
Types ¶
type BuildCardinalFlags ¶
type CommandState ¶
type CommandState struct {
LoggedIn bool
CurrRepoKnown bool
User *User
Organization *Organization
Project *Project
}
type CreateOrganizationFlags ¶
type CreateProjectFlags ¶
type Credential ¶
type DeploymentHealthCheckResult ¶
Parse the response into a map of environment names to their status.
type DeploymentPreview ¶
type DeploymentPreview struct {
OrgName string `json:"org_name"`
OrgSlug string `json:"org_slug"`
ProjectName string `json:"project_name"`
ProjectSlug string `json:"project_slug"`
ExecutorName string `json:"executor_name"`
DeploymentType string `json:"deployment_type"`
TickRate int `json:"tick_rate"`
Regions []string `json:"regions"`
}
type DevCardinalFlags ¶
type LoginRequirement ¶
type LoginRequirement int
LoginRequirement defines what level of login is needed.
const ( IgnoreLogin LoginRequirement = iota // don't care if we are logged in or not NeedLogin )
type LoginToken ¶
LoginToken struct for argusID.
type MembersListFlags ¶
type MembersListFlags struct {
IncludeRemoved bool
}
type Organization ¶
type Organization struct {
ID string `json:"id"`
Name string `json:"name"`
Slug string `json:"slug"`
CreatedTime string `json:"created_time"`
UpdatedTime string `json:"updated_time"`
OwnerID string `json:"owner_id"`
Deleted bool `json:"deleted"`
DeletedTime string `json:"deleted_time"`
BaseShardAddress string `json:"base_shard_address"`
}
type OrganizationMember ¶
type Project ¶
type Project struct {
ID string `json:"id"`
OrgID string `json:"org_id"`
OwnerID string `json:"owner_id"`
Name string `json:"name"`
Slug string `json:"slug"`
CreatedTime string `json:"created_time"`
UpdatedTime string `json:"updated_time"`
Deleted bool `json:"deleted"`
DeletedTime string `json:"deleted_time"`
RepoURL string `json:"repo_url"`
RepoToken string `json:"repo_token"`
RepoPath string `json:"repo_path"`
DeploySecret string `json:"deploy_secret,omitempty"`
Config ProjectConfig `json:"config"`
Update bool `json:"-"`
}
type ProjectConfig ¶
type ProjectConfig struct {
Region []string `json:"region"`
Discord ProjectConfigDiscord `json:"discord"`
Slack ProjectConfigSlack `json:"slack"`
}
type ProjectConfigDiscord ¶
type ProjectConfigSlack ¶
type PurgeCardinalFlags ¶
type PurgeCardinalFlags struct {
Config string
}
type RestartCardinalFlags ¶
type SetupRequest ¶
type SetupRequest struct {
LoginRequired LoginRequirement
OrganizationRequired SetupRequirement
ProjectRequired SetupRequirement
}
SetupRequest defines what a command needs to be properly initialized.
type SetupRequirement ¶
type SetupRequirement int
SetupRequirement defines what level of setup is needed for each component.
const ( Ignore SetupRequirement = iota NeedRepoLookup // we need to lookup the project from the git repo NeedIDOnly // we only need the id NeedExistingIDOnly // need id but can't create new one NeedData // we need all the data, can create new one NeedExistingData // we must have all the data but we can't create a new one MustNotExist // we must not have this )
type StartCardinalFlags ¶
type StartEVMFlags ¶
type StopCardinalFlags ¶
type StopCardinalFlags struct {
Config string
}
type StopEVMFlags ¶
type StopEVMFlags struct {
Config string
}
type SwitchOrganizationFlags ¶
type SwitchOrganizationFlags struct {
Slug string
}
type SwitchProjectFlags ¶
type SwitchProjectFlags struct {
Slug string
}
type TemporaryCredential ¶
type UpdateProjectFlags ¶
type UpdateUserFlags ¶
type UpdateUserFlags struct {
Name string
}
Click to show internal directories.
Click to hide internal directories.