api

package

Go to main page

Versions in this module

v0

v0.21.3

Apr 12, 2024

v0.21.2

Apr 11, 2024

v0.21.1

Mar 22, 2024

v0.21.0

Mar 21, 2024

Changes in this version

type Project

+ PublicKey string

v0.20.2

Dec 6, 2023

v0.20.1

Dec 6, 2023

v0.20.0

Dec 6, 2023

v0.19.0

Sep 7, 2023

v0.18.1

Jun 27, 2023

v0.18.0

Apr 4, 2023

Changes in this version

type NotificationType

+ const WebhookNotification

v0.17.0

Feb 3, 2023

v0.16.0

Dec 7, 2022

Changes in this version

type Project

+ ProblemsUI *int

v0.15.5

Nov 25, 2022

v0.15.4

Nov 8, 2022

Changes in this version

type ProjectPatch

+ ProblemsUI *int

v0.15.3

Nov 8, 2022

Changes in this version

type ProjectPatch

+ DeploymentsDisabled *int

v0.15.2

Oct 10, 2022

v0.15.1

Oct 9, 2022

v0.15.0

Oct 7, 2022

v0.14.0

Aug 22, 2022

v0.13.0

Jul 12, 2022

v0.12.5

Jun 3, 2022

v0.12.4

Jun 2, 2022

Changes in this version

type Project

+ FactsUI *int

type ProjectPatch

+ FactsUI *int

type SSHKeyType

+ const SSHECDSA256

+ const SSHECDSA384

+ const SSHECDSA521

v0.12.3

Mar 17, 2022

Changes in this version

type Project

+ RouterPattern string

type ProjectPatch

+ RouterPattern string

v0.12.2

Mar 1, 2022

v0.12.1

Feb 9, 2022

v0.12.0

Nov 3, 2021

v0.11.6

Sep 10, 2021

v0.11.5

Sep 10, 2021

Changes in this version

+ type AddBackup struct

+ BackupID string

+ Created string

+ Environment string

+ ID int

+ Source string

+ type AddGroup struct

+ Name string

+ ParentGroup Group

+ type AddNotificationRocketChat struct

+ Channel string

+ Name string

+ Webhook string

+ type AddNotificationSlack struct

+ Channel string

+ Name string

+ Webhook string

+ type AddNotificationToProject struct

+ NotificationName string

+ NotificationType NotificationType

+ Project string

+ type AddOrUpdateEnvironmentStorage struct

+ BytesUsed int

+ Environment int

+ PersistentStorageClaim string

+ type AddRestore struct

+ BackupID string

+ Created string

+ Execute bool

+ ID int

+ RestoreLocation string

+ Status RestoreStatusType

+ type AddSSHKey struct

+ ID string

+ KeyType SSHKeyType

+ KeyValue string

+ Name string

+ User User

+ type AddUpdateEnvironment struct

+ Name string

+ Patch Environment

+ type AddUserToGroup struct

+ Group string

+ Role GroupRole

+ User User

+ type AdvancedTask struct

+ Description string

+ ID int

+ Name string

+ type Backup struct

+ BackupID string

+ Created string

+ Deleted string

+ Environment int

+ ID int

+ Restore Restore

+ Source string

+ type Client interface

+ AddBackup func(AddBackup) ([]byte, error)

+ AddDeployment func(Deployment) ([]byte, error)

+ AddGroup func(AddGroup) ([]byte, error)

+ AddGroupToProject func(ProjectToGroup) ([]byte, error)

+ AddGroupWithParent func(AddGroup) ([]byte, error)

+ AddOrUpdateEnvironment func(AddUpdateEnvironment) ([]byte, error)

+ AddProject func(ProjectPatch, string) ([]byte, error)

+ AddSSHKey func(AddSSHKey) ([]byte, error)

+ AddUser func(User) ([]byte, error)

+ AddUserToGroup func(AddUserToGroup) ([]byte, error)

+ Debug func(bool)

+ DeleteBackup func(DeleteBackup) ([]byte, error)

+ DeleteEnvironment func(DeleteEnvironment) ([]byte, error)

+ DeleteGroup func(AddGroup) ([]byte, error)

+ DeleteProject func(Project) ([]byte, error)

+ DeleteSSHKey func(DeleteSSHKey) ([]byte, error)

+ DeleteUser func(User) ([]byte, error)

+ GetActiveSystemForProject func(Project, string) ([]byte, error)

+ GetAllEnvironmentBackups func() ([]byte, error)

+ GetAllProjects func(string) ([]byte, error)

+ GetDeploymentByRemoteID func(Deployment) ([]byte, error)

+ GetEnvironmentBackups func(EnvironmentBackups) ([]byte, error)

+ GetEnvironmentByName func(EnvironmentByName, string) ([]byte, error)

+ GetEnvironmentByOpenshiftProjectName func(Environment) ([]byte, error)

+ GetEnvironmentsForProject func(Project) ([]byte, error)

+ GetOpenShiftInfoForProject func(Project) ([]byte, error)

+ GetProductionEnvironmentForProject func(Project) ([]byte, error)

+ GetProjectByName func(Project, string) ([]byte, error)

+ GetProjectsByGitURL func(Project) ([]byte, error)

+ GetRocketChatInfoForProject func(Project, string) ([]byte, error)

+ GetSlackInfoForProject func(Project, string) ([]byte, error)

+ GetUserBySSHKey func(SSHKeyValue) ([]byte, error)

+ RemoveGroupFromProject func(ProjectToGroup) ([]byte, error)

+ RemoveUserFromGroup func(UserGroup) ([]byte, error)

+ Request func(CustomRequest) ([]byte, error)

+ RunQuery func(*graphql.Request, interface{}) (interface{}, error)

+ SanitizeGroupName func(string) string

+ SanitizeProjectName func(string) string

+ SetEnvironmentServices func(SetEnvironmentServices) ([]byte, error)

+ UpdateDeployment func(UpdateDeployment) ([]byte, error)

+ UpdateEnvironment func(UpdateEnvironment) ([]byte, error)

+ UpdateGroup func(UpdateGroup) ([]byte, error)

+ UpdateProject func(UpdateProject, string) ([]byte, error)

+ UpdateRestore func(UpdateRestore) ([]byte, error)

+ UpdateTask func(UpdateTask) ([]byte, error)

+ UpdateUser func(UpdateUser) ([]byte, error)

+ func New(tokenSigningKey string, jwtAudience string, graphQLEndpoint string) (Client, error)

+ func NewWithToken(tokenString string, graphQLEndpoint string) (Client, error)

+ type CustomRequest struct

+ MappedResult string

+ Query string

+ Variables map[string]interface{}

+ type Data struct

+ Data interface{}

+ Error interface{}

+ type DebugData struct

+ Query string

+ Vars []DebugVar

+ type DebugVar struct

+ Name string

+ Value interface{}

+ type DeleteBackup struct

+ BackupID string

+ type DeleteDeployment struct

+ ID int

+ type DeleteEnvVariable struct

+ ID int

+ type DeleteEnvironment struct

+ Execute bool

+ Name string

+ Project string

+ type DeleteFilesForTask struct

+ ID int

+ type DeleteGroup struct

+ Group Group

+ type DeleteNotificationRocketChat struct

+ Name string

+ type DeleteNotificationSlack struct

+ Name string

+ type DeleteOpenshift struct

+ Name string

+ type DeleteProject struct

+ Project string

+ type DeleteProjectResult struct

+ DeleteProject string

+ type DeleteSSHKey struct

+ Name string

+ type DeleteTask struct

+ ID int

+ type DeleteUser struct

+ User User

+ type DeployEnvironmentBranch struct

+ BranchName string

+ BranchRef string

+ Project Project

+ type DeployEnvironmentLatest struct

+ Environment Environment

+ type DeployEnvironmentPromote struct

+ DestinationEnvironment string

+ Project Project

+ SourceEnvironment Environment

+ type DeployEnvironmentPullrequest struct

+ BaseBranchName string

+ BaseBranchRef string

+ HeadBranchName string

+ HeadBranchRef string

+ Number int

+ Project Project

+ Title string

+ type DeployType string

+ const Branch

+ const Promote

+ const PullRequest

+ type Deployment struct

+ BuildLog string

+ Completed string

+ Created string

+ Environment int

+ ID int

+ Name string

+ RemoteID string

+ Started string

+ Status DeploymentStatusType

+ type DeploymentEnv struct

+ BuildLog string

+ Completed string

+ Created string

+ Environment Environment

+ ID int

+ Name string

+ RemoteID string

+ Started string

+ Status DeploymentStatusType

+ type DeploymentStatusType string

+ const CancelledDeploy

+ const CompleteDeploy

+ const ErrorDeploy

+ const FailedDeploy

+ const NewDeploy

+ const PendingDeploy

+ const RunningDeploy

+ type EnvOrderType string

+ const NameEnvOrder

+ const UpdatedEnvOrder

+ type EnvType string

+ const DevelopmentEnv

+ const ProductionEnv

+ type EnvVariable struct

+ ID int

+ Name string

+ Scope EnvVariableScope

+ Type EnvVariableType

+ TypeID int

+ Value string

+ type EnvVariableScope string

+ const BuildVar

+ const ContainerRegistryVar

+ const GlobalVar

+ const InternalContainerRegistryVar

+ const RuntimeVar

+ type EnvVariableType string

+ const EnvironmentVar

+ const ProjectVar

+ type Environment struct

+ AdvancedTasks []AdvancedTask

+ AutoIdle *int

+ Backups []Backup

+ Created string

+ Deleted string

+ DeployBaseRef string

+ DeployHeadRef string

+ DeployTitle string

+ DeployType DeployType

+ EnvVariables []EnvironmentVariable

+ EnvironmentType EnvType

+ ID int

+ MonitoringUrls string

+ Name string

+ OpenshiftProjectName string

+ Project int

+ Route string

+ Routes string

+ Tasks []Task

+ type EnvironmentBackups struct

+ OpenshiftProjectName string

+ type EnvironmentByName struct

+ Name string

+ Project int

+ type EnvironmentVariable struct

+ ID int

+ Name string

+ Scope string

+ Value string

+ type File struct

+ Created string

+ Download string

+ Filename string

+ ID int

+ type Group struct

+ Groups []Group

+ ID string

+ Members string

+ Name string

+ type GroupMembership struct

+ Role GroupRole

+ User User

+ type GroupRole string

+ const DeveloperRole

+ const GuestRole

+ const MaintainerRole

+ const OwnerRole

+ const ReporterRole

+ type Interface struct

+ func (api *Interface) AddBackup(backup AddBackup) ([]byte, error)

+ func (api *Interface) AddDeployment(deployment Deployment) ([]byte, error)

+ func (api *Interface) AddGroup(group AddGroup) ([]byte, error)

+ func (api *Interface) AddGroupToProject(group ProjectToGroup) ([]byte, error)

+ func (api *Interface) AddGroupWithParent(group AddGroup) ([]byte, error)

+ func (api *Interface) AddOrUpdateEnvironment(environment AddUpdateEnvironment) ([]byte, error)

+ func (api *Interface) AddProject(project ProjectPatch, fragment string) ([]byte, error)

+ func (api *Interface) AddSSHKey(sshKey AddSSHKey) ([]byte, error)

+ func (api *Interface) AddUser(user User) ([]byte, error)

+ func (api *Interface) AddUserToGroup(user AddUserToGroup) ([]byte, error)

+ func (api *Interface) Debug(debug bool)

+ func (api *Interface) DeleteBackup(backup DeleteBackup) ([]byte, error)

+ func (api *Interface) DeleteEnvironment(environment DeleteEnvironment) ([]byte, error)

+ func (api *Interface) DeleteGroup(group AddGroup) ([]byte, error)

+ func (api *Interface) DeleteProject(project Project) ([]byte, error)

+ func (api *Interface) DeleteSSHKey(sshKey DeleteSSHKey) ([]byte, error)

+ func (api *Interface) DeleteUser(user User) ([]byte, error)

+ func (api *Interface) GetActiveSystemForProject(project Project, task string) ([]byte, error)

+ func (api *Interface) GetAllEnvironmentBackups() ([]byte, error)

+ func (api *Interface) GetAllProjects(fragment string) ([]byte, error)

+ func (api *Interface) GetDeploymentByRemoteID(deployment Deployment) ([]byte, error)

+ func (api *Interface) GetEnvironmentBackups(backups EnvironmentBackups) ([]byte, error)

+ func (api *Interface) GetEnvironmentByName(environment EnvironmentByName, fragment string) ([]byte, error)

+ func (api *Interface) GetEnvironmentByOpenshiftProjectName(environment Environment) ([]byte, error)

+ func (api *Interface) GetEnvironmentsForProject(project Project) ([]byte, error)

+ func (api *Interface) GetOpenShiftInfoForProject(project Project) ([]byte, error)

+ func (api *Interface) GetProductionEnvironmentForProject(project Project) ([]byte, error)

+ func (api *Interface) GetProjectByName(project Project, fragment string) ([]byte, error)

+ func (api *Interface) GetProjectsByGitURL(project Project) ([]byte, error)

+ func (api *Interface) GetRocketChatInfoForProject(project Project, fragment string) ([]byte, error)

+ func (api *Interface) GetSlackInfoForProject(project Project, fragment string) ([]byte, error)

+ func (api *Interface) GetUserBySSHKey(sshKey SSHKeyValue) ([]byte, error)

+ func (api *Interface) RemoveGroupFromProject(group ProjectToGroup) ([]byte, error)

+ func (api *Interface) RemoveUserFromGroup(user UserGroup) ([]byte, error)

+ func (api *Interface) Request(request CustomRequest) ([]byte, error)

+ func (api *Interface) RunQuery(graphQLQuery *graphql.Request, returnType interface{}) (interface{}, error)

+ func (api *Interface) SanitizeGroupName(name string) string

+ func (api *Interface) SanitizeProjectName(name string) string

+ func (api *Interface) SetEnvironmentServices(environment SetEnvironmentServices) ([]byte, error)

+ func (api *Interface) UpdateDeployment(deployment UpdateDeployment) ([]byte, error)

+ func (api *Interface) UpdateEnvironment(environment UpdateEnvironment) ([]byte, error)

+ func (api *Interface) UpdateGroup(group UpdateGroup) ([]byte, error)

+ func (api *Interface) UpdateProject(project UpdateProject, fragment string) ([]byte, error)

+ func (api *Interface) UpdateRestore(update UpdateRestore) ([]byte, error)

+ func (api *Interface) UpdateTask(task UpdateTask) ([]byte, error)

+ func (api *Interface) UpdateUser(user UpdateUser) ([]byte, error)

+ type NotificationRocketChat struct

+ Channel string

+ ID int

+ Name string

+ Webhook string

+ type NotificationSlack struct

+ Channel string

+ ID int

+ Name string

+ Webhook string

+ type NotificationType string

+ const EmailNotification

+ const MicrosoftTeamsNotification

+ const RocketChatNotification

+ const SlackNotification

+ type Openshift struct

+ ConsoleURL string

+ Created string

+ ID int

+ Name string

+ ProjectUser string

+ RouterPattern string

+ SSHHost string

+ SSHPort string

+ Token string

+ type Project struct

+ ActiveSystemsDeploy string

+ ActiveSystemsMisc string

+ ActiveSystemsPromote string

+ ActiveSystemsRemove string

+ ActiveSystemsTask string

+ AutoIdle *int

+ Branches string

+ Created string

+ Deployments []Deployment

+ DevelopmentEnvironmentsLimit int

+ EnvVariables []EnvironmentVariable

+ Environments []Environment

+ GitURL string

+ ID int

+ Name string

+ Notifications []interface{}

+ Openshift Openshift

+ OpenshiftProjectPattern string

+ PrivateKey string

+ ProductionEnvironment string

+ Pullrequests string

+ StandbyProductionEnvironment string

+ StorageCalc *int

+ Subfolder string

+ type ProjectGroups struct

+ Groups []Group

+ Project Project

+ type ProjectOrderType string

+ const CreatedProjectOrder

+ const NameProjectOrder

+ type ProjectPatch struct

+ ActiveSystemsDeploy string

+ ActiveSystemsMisc string

+ ActiveSystemsPromote string

+ ActiveSystemsRemove string

+ ActiveSystemsTask string

+ AutoIdle *int

+ Branches string

+ DevelopmentEnvironmentsLimit *int

+ GitURL string

+ ID int

+ Name string

+ Openshift *int

+ OpenshiftProjectPattern string

+ PrivateKey string

+ ProductionEnvironment string

+ Pullrequests string

+ StandbyProductionEnvironment string

+ StorageCalc *int

+ Subfolder string

+ type ProjectToGroup struct

+ Group string

+ Project string

+ type Projects struct

+ Projects []Project

+ type RemoveNotificationFromProject struct

+ NotificationName string

+ NotificationType NotificationType

+ Project string

+ type Restore struct

+ BackupID string

+ Created string

+ ID int

+ RestoreLocation string

+ Status string

+ type RestoreStatusType string

+ const FailedRestore

+ const PendingRestore

+ const SuccessfulRestore

+ type RocketChats struct

+ RocketChats []NotificationRocketChat

+ type SSHKey struct

+ ID int

+ KeyFingerprint string

+ KeyType SSHKeyType

+ KeyValue string

+ Name string

+ type SSHKeyType string

+ const SSHEd25519

+ const SSHRsa

+ type SSHKeyValue string

+ type SetEnvironmentServices struct

+ Environment int

+ Services []string

+ type Slacks struct

+ Slacks []NotificationSlack

+ type Task struct

+ Command string

+ Completed string

+ Created string

+ Environment int

+ Execute bool

+ ID int

+ Name string

+ RemoteID string

+ Service string

+ Started string

+ Status TaskStatusType

+ type TaskStatusType string

+ const ActiveTask

+ const FailedTask

+ const SucceededTask

+ type UnassignedNotification struct

+ ID string

+ Name string

+ Type string

+ type UpdateDeployment struct

+ ID int

+ Patch Deployment

+ type UpdateEnvironment struct

+ ID int

+ Patch Environment

+ type UpdateGroup struct

+ Group Group

+ Patch Group

+ type UpdateNotificationRocketChatInput struct

+ ID int

+ Patch UpdateNotificationRocketChatPatch

+ type UpdateNotificationRocketChatPatch struct

+ Channel string

+ Name string

+ Webhook string

+ type UpdateNotificationSlack struct

+ ID int

+ Patch UpdateNotificationSlackPatch

+ type UpdateNotificationSlackPatch struct

+ Channel string

+ Name string

+ Webhook string

+ type UpdateOpenshift struct

+ ID int

+ Patch Openshift

+ type UpdateProject struct

+ ID int

+ Patch ProjectPatch

+ type UpdateRestore struct

+ BackupID string

+ Patch UpdateRestorePatch

+ type UpdateRestorePatch struct

+ Created string

+ RestoreLocation string

+ Status string

+ type UpdateSSHKey struct

+ ID int

+ Patch UpdateSSHKeyPatch

+ type UpdateSSHKeyPatch struct

+ KeyType SSHKeyType

+ KeyValue string

+ Name string

+ type UpdateTask struct

+ ID int

+ Patch Task

+ type UpdateUser struct

+ Patch User

+ User User

+ type UploadFilesForTask struct

+ Task int

+ type User struct

+ Comment string

+ Email string

+ FirstName string

+ GitlabID int

+ Groups []Group

+ ID string

+ LastName string

+ SSHKeys []SSHKey

+ type UserGroup struct

+ Group Group

+ User User

+ type UserGroupRole struct

+ Group Group

+ Role GroupRole

+ User User

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL