Documentation
¶
Index ¶
- Constants
- func NewHTTPClient(timeout time.Duration, insecureSkipVerifyTLS bool) *http.Client
- func NewWebsocketDialer(insecureSkipVerifyTLS bool) *websocket.Dialer
- type ActionClient
- type Admin
- type ApplicationClient
- type ApplicationKeysClient
- type ApplicationVariableClient
- type AuthClient
- type CDNClient
- type Config
- type DownloadClient
- type EnvironmentClient
- type EnvironmentKeysClient
- type EnvironmentVariableClient
- type Error
- type EventsClient
- type ExportImportInterface
- type Filter
- type GRPCPluginsClient
- type GRPCPluginsV2Client
- type GroupClient
- type HTTPClient
- type HatcheryClient
- type HatcheryServiceClient
- type HookClient
- type IntegrationClient
- type Interface
- type MaintenanceClient
- type MonitoringClient
- type OrganizationClient
- type PipelineClient
- type ProjectClient
- type ProjectClientV2
- type ProjectKeysClient
- type ProjectVariablesClient
- type ProviderClient
- type ProviderConfig
- type QueueClient
- type RBACClient
- type Raw
- type RegionClient
- type RepositoriesManagerInterface
- type RequestModifier
- func ContentType(value string) RequestModifier
- func FilterByUser(username string) RequestModifier
- func FilterByWritablePermission() RequestModifier
- func Force() RequestModifier
- func Format(format string) RequestModifier
- func Full() RequestModifier
- func IgnoreMissing() RequestModifier
- func ModelType(modelType string) RequestModifier
- func Region(regions ...string) RequestModifier
- func SetHeader(key, value string) RequestModifier
- func Signer(signer string) RequestModifier
- func Status(status ...string) RequestModifier
- func WithDeepPipelines() RequestModifier
- func WithKeys() RequestModifier
- func WithLabels() RequestModifier
- func WithPermissions() RequestModifier
- func WithQueryParameter(key, value string) RequestModifier
- func WithTemplate() RequestModifier
- func WithUsage() RequestModifier
- func WithWorkflows() RequestModifier
- func Workflows(ws ...string) RequestModifier
- type ServiceClient
- type ServiceConfig
- type TemplateClient
- type TemplateV2Client
- type UserClient
- type V2QueueClient
- type V2WorkerClient
- type V2WorkerInterface
- type WebsocketClient
- type WorkerClient
- type WorkerInterface
- type WorkerModelFilter
- type WorkerModelV2Filter
- type WorkflowAsCodeInterface
- type WorkflowClient
- type WorkflowV2Client
Constants ¶
const ( // RequestedIfModifiedSinceHeader is used as HTTP header RequestedIfModifiedSinceHeader = "If-Modified-Since" // ResponseAPITimeHeader is used as HTTP header ResponseAPITimeHeader = "X-Api-Time" // ResponseAPINanosecondsTimeHeader is used as HTTP header ResponseAPINanosecondsTimeHeader = "X-Api-Nanoseconds-Time" // ResponseEtagHeader is used as HTTP header ResponseEtagHeader = "Etag" // ResponseProcessTimeHeader is used as HTTP header ResponseProcessTimeHeader = "X-Api-Process-Time" )
Variables ¶
This section is empty.
Functions ¶
func NewHTTPClient ¶
NewHTTPClient returns a new HTTP Client.
func NewWebsocketDialer ¶
Types ¶
type ActionClient ¶
type ActionClient interface {
ActionDelete(groupName, name string) error
ActionGet(groupName, name string, mods ...RequestModifier) (*sdk.Action, error)
ActionUsage(groupName, name string, mods ...RequestModifier) (*sdk.ActionUsages, error)
ActionList() ([]sdk.Action, error)
ActionImport(content io.Reader, mods ...RequestModifier) error
ActionExport(groupName, name string, mods ...RequestModifier) ([]byte, error)
ActionBuiltinList() ([]sdk.Action, error)
ActionBuiltinGet(name string, mods ...RequestModifier) (*sdk.Action, error)
}
ActionClient exposes actions related functions
type Admin ¶
type Admin interface {
AdminDatabaseMigrationList(service string) ([]sdk.DatabaseMigrationStatus, error)
AdminDatabaseMigrationDelete(service string, id string) error
AdminDatabaseMigrationUnlock(service string, id string) error
AdminDatabaseEntityList(service string) ([]sdk.DatabaseEntity, error)
AdminDatabaseEntity(service string, e string, mods ...RequestModifier) ([]string, error)
AdminDatabaseEntityInfo(service string, e string, pks []string) ([]sdk.DatabaseEntityInfo, error)
AdminDatabaseEntityRoll(service string, e string, pks []string, mods ...RequestModifier) ([]sdk.DatabaseEntityInfo, error)
AdminCDSMigrationList() ([]sdk.Migration, error)
AdminCDSMigrationCancel(id int64) error
AdminCDSMigrationReset(id int64) error
AdminWorkflowUpdateMaxRuns(projectKey string, workflowName string, maxRuns int64) error
AdminOrganizationCreate(ctx context.Context, orga sdk.Organization) error
AdminOrganizationList(ctx context.Context) ([]sdk.Organization, error)
AdminOrganizationDelete(ctx context.Context, orgaIdentifier string) error
AdminOrganizationMigrateUser(ctx context.Context, orgaIdentifier string) error
AdminUserCreate(ctx context.Context, user sdk.CreateUser) error
HasProjectRole(ctx context.Context, projectKey, sessionID string, role string) error
Features() ([]sdk.Feature, error)
FeatureCreate(f sdk.Feature) error
FeatureDelete(name sdk.FeatureName) error
FeatureGet(name sdk.FeatureName) (sdk.Feature, error)
FeatureUpdate(f sdk.Feature) error
Services() ([]sdk.Service, error)
ServicesByName(name string) (*sdk.Service, error)
ServiceDelete(name string) error
ServicesByType(stype string) ([]sdk.Service, error)
ServiceNameCallGET(name string, url string) ([]byte, error)
ServiceCallGET(stype string, url string) ([]byte, error)
ServiceCallPOST(stype string, url string, body []byte) ([]byte, error)
ServiceCallPUT(stype string, url string, body []byte) ([]byte, error)
ServiceCallDELETE(stype string, url string) error
}
Admin expose all function to CDS administration
type ApplicationClient ¶
type ApplicationClient interface {
ApplicationAttachToReposistoriesManager(projectKey, appName, reposManager, repoFullname string) error
ApplicationCreate(projectKey string, app *sdk.Application) error
ApplicationUpdate(projectKey string, appName string, app *sdk.Application) error
ApplicationDelete(projectKey string, appName string) error
ApplicationGet(projectKey string, appName string, opts ...RequestModifier) (*sdk.Application, error)
ApplicationList(projectKey string) ([]sdk.Application, error)
ApplicationVariableClient
ApplicationKeysClient
}
ApplicationClient exposes application related functions
type ApplicationKeysClient ¶
type ApplicationKeysClient interface {
ApplicationKeysList(projectKey string, appName string) ([]sdk.ApplicationKey, error)
ApplicationKeyCreate(projectKey string, appName string, keyApp *sdk.ApplicationKey) error
ApplicationKeysDelete(projectKey string, appName string, KeyAppName string) error
}
ApplicationKeysClient exposes application keys related functions
type ApplicationVariableClient ¶
type ApplicationVariableClient interface {
ApplicationVariablesList(projectKey string, appName string) ([]sdk.Variable, error)
ApplicationVariableCreate(projectKey string, appName string, variable *sdk.Variable) error
ApplicationVariableDelete(projectKey string, appName string, varName string) error
ApplicationVariableGet(projectKey string, appName string, varName string) (*sdk.Variable, error)
ApplicationVariableUpdate(projectKey string, appName string, variable *sdk.Variable) error
}
ApplicationVariableClient exposes application variables related functions
type AuthClient ¶
type AuthClient interface {
AuthDriverList() (sdk.AuthDriverResponse, error)
AuthConsumerSignin(sdk.AuthConsumerType, interface{}) (sdk.AuthConsumerSigninResponse, error)
AuthConsumerHatcherySigninV2(request interface{}) (sdk.AuthConsumerHatcherySigninResponse, error)
AuthConsumerLocalAskResetPassword(sdk.AuthConsumerSigninRequest) error
AuthConsumerLocalResetPassword(token, newPassword string) (sdk.AuthConsumerSigninResponse, error)
AuthConsumerLocalSignup(sdk.AuthConsumerSigninRequest) error
AuthConsumerLocalSignupVerify(token, initToken string) (sdk.AuthConsumerSigninResponse, error)
AuthConsumerSignout() error
AuthConsumerListByUser(username string) (sdk.AuthUserConsumers, error)
AuthConsumerDelete(username, id string) error
AuthConsumerRegen(username, id string, newDuration int64, overlapDuration string) (sdk.AuthConsumerCreateResponse, error)
AuthConsumerCreateForUser(username string, request sdk.AuthUserConsumer) (sdk.AuthConsumerCreateResponse, error)
AuthSessionListByUser(username string) (sdk.AuthSessions, error)
AuthSessionDelete(username, id string) error
AuthSessionGet(id string) (sdk.AuthCurrentConsumerResponse, error)
AuthMe() (sdk.AuthCurrentConsumerResponse, error)
}
AuthClient is the interface for authentication management.
type CDNClient ¶
type CDNClient interface {
CDNItemUpload(ctx context.Context, cdnAddr string, signature string, fs afero.Fs, path string) (time.Duration, error)
CDNItemDownload(ctx context.Context, cdnAddr string, hash string, itemType sdk.CDNItemType, md5 string, writer io.WriteSeeker) error
CDNItemStream(ctx context.Context, cdnAddr string, hash string, itemType sdk.CDNItemType) (io.Reader, error)
}
type Config ¶
type Config struct {
Host string
CDNHost string
User string
SessionToken string
BuiltinConsumerAuthenticationToken string
Verbose bool
Retry int
InsecureSkipVerifyTLS bool
Mutex *sync.Mutex
}
Config is the configuration data used by the cdsclient interface implementation
func (*Config) HasValidSessionToken ¶
type DownloadClient ¶
type DownloadClient interface {
Download() ([]sdk.DownloadableResource, error)
DownloadURLFromAPI(name, os, arch, variant string) string
}
DownloadClient exposes download related functions
type EnvironmentClient ¶
type EnvironmentClient interface {
EnvironmentCreate(projectKey string, env *sdk.Environment) error
EnvironmentDelete(projectKey string, envName string) error
EnvironmentGet(projectKey string, envName string, opts ...RequestModifier) (*sdk.Environment, error)
EnvironmentList(projectKey string) ([]sdk.Environment, error)
EnvironmentExport(projectKey, name string, mods ...RequestModifier) ([]byte, error)
EnvironmentImport(projectKey string, content io.Reader, mods ...RequestModifier) ([]string, error)
EnvironmentVariableClient
EnvironmentKeysClient
}
EnvironmentClient exposes environment related functions
type EnvironmentKeysClient ¶
type EnvironmentKeysClient interface {
EnvironmentKeysList(projectKey string, envName string) ([]sdk.EnvironmentKey, error)
EnvironmentKeyCreate(projectKey string, envName string, keyEnv *sdk.EnvironmentKey) error
EnvironmentKeysDelete(projectKey string, envName string, keyEnvName string) error
}
EnvironmentKeysClient exposes environment keys related functions
type EnvironmentVariableClient ¶
type EnvironmentVariableClient interface {
EnvironmentVariablesList(key string, envName string) ([]sdk.Variable, error)
EnvironmentVariableCreate(projectKey string, envName string, variable *sdk.Variable) error
EnvironmentVariableDelete(projectKey string, envName string, varName string) error
EnvironmentVariableGet(projectKey string, envName string, varName string) (*sdk.Variable, error)
EnvironmentVariableUpdate(projectKey string, envName string, variable *sdk.Variable) error
}
EnvironmentVariableClient exposes environment variables related functions
type Error ¶
type Error struct {
// contains filtered or unexported fields
}
func (*Error) StackTrace ¶
type EventsClient ¶
type EventsClient interface {
// Must be run in a go routine
WebsocketEventsListen(ctx context.Context, goRoutines *sdk.GoRoutines, chanMsgToSend <-chan []sdk.WebsocketFilter, chanMsgReceived chan<- sdk.WebsocketEvent, chanErrorReceived chan<- error)
}
EventsClient listen SSE Events from CDS API
type ExportImportInterface ¶
type ExportImportInterface interface {
PipelineExport(projectKey, name string, mods ...RequestModifier) ([]byte, error)
PipelineImport(projectKey string, content io.Reader, mods ...RequestModifier) ([]string, error)
ApplicationExport(projectKey, name string, mods ...RequestModifier) ([]byte, error)
ApplicationImport(projectKey string, content io.Reader, mods ...RequestModifier) ([]string, error)
WorkflowExport(projectKey, name string, mods ...RequestModifier) ([]byte, error)
WorkflowPull(projectKey, name string, mods ...RequestModifier) (*tar.Reader, error)
WorkflowImport(projectKey string, content io.Reader, mods ...RequestModifier) ([]string, error)
WorkerModelExport(groupName, name string, mods ...RequestModifier) ([]byte, error)
WorkerModelImport(content io.Reader, mods ...RequestModifier) (*sdk.Model, error)
WorkflowPush(projectKey string, tarContent io.Reader, mods ...RequestModifier) ([]string, *tar.Reader, error)
WorkflowAsCodeInterface
}
ExportImportInterface exposes pipeline and application export and import function
type GRPCPluginsClient ¶
type GRPCPluginsClient interface {
PluginsList() ([]sdk.GRPCPlugin, error)
PluginsGet(string) (*sdk.GRPCPlugin, error)
PluginAdd(*sdk.GRPCPlugin) error
PluginUpdate(*sdk.GRPCPlugin) error
PluginDelete(string) error
PluginAddBinary(*sdk.GRPCPlugin, *sdk.GRPCPluginBinary) error
PluginDeleteBinary(name, os, arch string) error
PluginGetBinary(name, os, arch string, w io.Writer) error
PluginGetBinaryInfos(name, os, arch string) (*sdk.GRPCPluginBinary, error)
}
GRPCPluginsClient exposes plugins API
type GRPCPluginsV2Client ¶ added in v0.53.0
type GRPCPluginsV2Client interface {
PluginImport(*sdk.GRPCPlugin, ...RequestModifier) error
}
type GroupClient ¶
type GroupClient interface {
GroupList() ([]sdk.Group, error)
GroupGet(name string, mods ...RequestModifier) (*sdk.Group, error)
GroupCreate(group *sdk.Group) error
GroupRename(oldName, newName string) error
GroupDelete(name string) error
GroupMemberAdd(groupName string, member *sdk.GroupMember) (sdk.Group, error)
GroupMemberEdit(groupName string, member *sdk.GroupMember) (sdk.Group, error)
GroupMemberRemove(groupName, username string) error
}
GroupClient exposes groups related functions
type HTTPClient ¶
HTTPClient is a interface for HTTPClient mock
type HatcheryClient ¶ added in v0.53.0
type HatcheryClient interface {
HatcheryAdd(ctx context.Context, h *sdk.Hatchery) (*sdk.HatcheryGetResponse, error)
HatcheryGet(ctx context.Context, hatcheryIdentifier string) (sdk.HatcheryGetResponse, error)
HatcheryList(ctx context.Context) ([]sdk.HatcheryGetResponse, error)
HatcheryDelete(ctx context.Context, hatcheryIdentifier string) error
HatcheryRegenToken(ctx context.Context, hatcheryIdentifier string) (*sdk.HatcheryGetResponse, error)
}
type HatcheryServiceClient ¶ added in v0.53.0
type HatcheryServiceClient interface {
Heartbeat(ctx context.Context, mon *sdk.MonitoringStatus) error
GetWorkerModel(ctx context.Context, projKey string, vcsIdentifier string, repoIdentifier string, workerModelName string, mods ...RequestModifier) (*sdk.V2WorkerModel, error)
V2HatcheryTakeJob(ctx context.Context, regionName string, jobRunID string) (*sdk.V2WorkflowRunJob, error)
V2HatcheryReleaseJob(ctx context.Context, regionName string, jobRunID string) error
EntityGet(ctx context.Context, projKey string, vcsIdentifier string, repoIdentifier string, entityType string, entityName string, mods ...RequestModifier) (*sdk.Entity, error)
V2QueueClient
V2WorkerList(ctx context.Context) ([]sdk.V2Worker, error)
}
func NewHatcheryServiceClient ¶ added in v0.53.0
func NewHatcheryServiceClient(ctx context.Context, clientConfig ServiceConfig, requestSign interface{}) (HatcheryServiceClient, []byte, string, error)
type HookClient ¶
type HookClient interface {
PollVCSEvents(uuid string, workflowID int64, vcsServer string, timestamp int64) (events sdk.RepositoryEvents, interval time.Duration, err error)
VCSGerritConfiguration() (map[string]sdk.VCSGerritConfiguration, error)
HookGetWorkflowHook(ctx context.Context, hookID string) (*sdk.V2WorkflowHook, error)
HookRepositoriesList(ctx context.Context, vcsServer, repoName string) ([]sdk.ProjectRepository, error)
ListWorkflowToTrigger(ctx context.Context, req sdk.HookListWorkflowRequest) ([]sdk.V2WorkflowHook, error)
RetrieveHookEventSigningKey(ctx context.Context, req sdk.HookRetrieveSignKeyRequest) (sdk.Operation, error)
RetrieveHookEventSigningKeyOperation(ctx context.Context, operationUUID string) (sdk.Operation, error)
RetrieveHookEventUser(ctx context.Context, req sdk.HookRetrieveUserRequest) (sdk.HookRetrieveUserResponse, error)
EntityGet(ctx context.Context, projKey string, vcsIdentifier string, repoIdentifier string, entityType string, entityName string, mods ...RequestModifier) (*sdk.Entity, error)
CreateInsightReport(ctx context.Context, projKey string, vcsName string, repoName string, commit string, insightKey string, insightReport sdk.VCSInsight) error
}
HookClient exposes functions used for hooks services
type IntegrationClient ¶
type IntegrationClient interface {
IntegrationModelList() ([]sdk.IntegrationModel, error)
IntegrationModelGet(name string) (sdk.IntegrationModel, error)
IntegrationModelAdd(m *sdk.IntegrationModel) error
IntegrationModelUpdate(m *sdk.IntegrationModel) error
IntegrationModelDelete(name string) error
}
IntegrationClient exposes integration functions
type Interface ¶
type Interface interface {
Raw
AuthClient
ActionClient
Admin
APIURL() string
CDNURL() (string, error)
ApplicationClient
ConfigUser() (sdk.ConfigUser, error)
ConfigCDN() (sdk.CDNConfig, error)
ConfigVCSGPGKeys() (map[string][]sdk.Key, error)
DownloadClient
EnvironmentClient
EventsClient
ExportImportInterface
FeatureEnabled(name sdk.FeatureName, params map[string]string) (sdk.FeatureEnabledResponse, error)
GroupClient
GRPCPluginsClient
GRPCPluginsV2Client
HatcheryClient
MaintenanceClient
PipelineClient
IntegrationClient
ProjectClient
ProjectClientV2
RBACClient
OrganizationClient
RegionClient
QueueClient
Requirements() ([]sdk.Requirement, error)
RepositoriesManagerInterface
ServiceClient
ServiceHeartbeat(*sdk.MonitoringStatus) error
UserClient
WorkerClient
WorkflowClient
WorkflowV2Client
MonitoringClient
HookClient
Version() (*sdk.Version, error)
TemplateClient
TemplateV2Client
WebsocketClient
V2QueueClient
EntityLint(ctx context.Context, entityType string, data interface{}) (*sdk.EntityCheckResponse, error)
VCSGPGKey(ctx context.Context, gpgKeyID string) ([]sdk.VCSUserGPGKey, error)
}
Interface is the main interface for cdsclient package
func NewServiceClient ¶
func NewServiceClient(ctx context.Context, clientConfig ServiceConfig, registerPayload interface{}) (Interface, *sdk.Service, []byte, error)
NewServiceClient returns client for a service
type MaintenanceClient ¶
MaintenanceClient manage maintenance mode on CDS
type MonitoringClient ¶
type MonitoringClient interface {
MonStatus() (*sdk.MonitoringStatus, error)
MonVersion() (*sdk.Version, error)
MonDBMigrate() ([]sdk.MonDBMigrate, error)
}
MonitoringClient exposes monitoring functions
type OrganizationClient ¶ added in v0.52.0
type OrganizationClient interface {
OrganizationAdd(ctx context.Context, organization sdk.Organization) error
OrganizationGet(ctx context.Context, organizationIdentifier string) (sdk.Organization, error)
OrganizationList(ctx context.Context) ([]sdk.Organization, error)
OrganizationDelete(ctx context.Context, organizationIdentifier string) error
}
type PipelineClient ¶
type PipelineClient interface {
PipelineGet(projectKey, name string, mods ...RequestModifier) (*sdk.Pipeline, error)
PipelineDelete(projectKey, name string) error
PipelineCreate(projectKey string, pip *sdk.Pipeline) error
PipelineList(projectKey string) ([]sdk.Pipeline, error)
}
PipelineClient exposes pipelines related functions
type ProjectClient ¶
type ProjectClient interface {
ProjectCreate(proj *sdk.Project) error
ProjectDelete(projectKey string) error
ProjectGroupAdd(projectKey, groupName string, permission int, projectOnly bool) error
ProjectGroupDelete(projectKey, groupName string) error
ProjectGet(projectKey string, opts ...RequestModifier) (*sdk.Project, error)
ProjectUpdate(key string, project *sdk.Project) error
ProjectList(withApplications, withWorkflow bool, filters ...Filter) ([]sdk.Project, error)
ProjectKeysClient
ProjectVariablesClient
ProjectIntegrationImport(projectKey string, content io.Reader, mods ...RequestModifier) (sdk.ProjectIntegration, error)
ProjectIntegrationGet(projectKey string, integrationName string, clearPassword bool) (sdk.ProjectIntegration, error)
ProjectIntegrationList(projectKey string) ([]sdk.ProjectIntegration, error)
ProjectIntegrationDelete(projectKey string, integrationName string) error
ProjectAccess(ctx context.Context, projectKey, sessionID string, itemType sdk.CDNItemType) error
ProjectIntegrationWorkerHookGet(projectKey string, integrationName string) (*sdk.WorkerHookProjectIntegrationModel, error)
ProjectIntegrationWorkerHooksImport(projectKey string, integrationName string, hook sdk.WorkerHookProjectIntegrationModel) error
ProjectVCSImport(ctx context.Context, projectKey string, vcs sdk.VCSProject, mods ...RequestModifier) (sdk.VCSProject, error)
ProjectVCSGet(ctx context.Context, projectKey string, integrationName string) (sdk.VCSProject, error)
ProjectVCSList(ctx context.Context, projectKey string) ([]sdk.VCSProject, error)
ProjectVCSDelete(ctx context.Context, projectKey string, vcsName string) error
ProjectVCSRepositoryAdd(ctx context.Context, projectKey string, vcsName string, repo sdk.ProjectRepository) error
ProjectVCSRepositoryList(ctx context.Context, projectKey string, vcsName string) ([]sdk.ProjectRepository, error)
ProjectRepositoryDelete(ctx context.Context, projectKey string, vcsName string, repositoryName string) error
ProjectRepositoryAnalysis(ctx context.Context, analysis sdk.AnalysisRequest) (sdk.AnalysisResponse, error)
ProjectRepositoryAnalysisList(ctx context.Context, projectKey string, vcsIdentifier string, repositoryIdentifier string) ([]sdk.ProjectRepositoryAnalysis, error)
ProjectRepositoryAnalysisGet(ctx context.Context, projectKey string, vcsIdentifier string, repositoryIdentifier string, analysisID string) (sdk.ProjectRepositoryAnalysis, error)
ProjectRepositoryEvents(ctx context.Context, projectKey, vcsName, repoName string) ([]sdk.HookRepositoryEvent, error)
ProjectRepositoryEvent(ctx context.Context, projectKey, vcsName, repoName, eventID string) (*sdk.HookRepositoryEvent, error)
}
ProjectClient exposes project related functions
type ProjectClientV2 ¶ added in v0.53.1
type ProjectClientV2 interface {
ProjectNotificationCreate(ctx context.Context, pKey string, notif *sdk.ProjectNotification) error
ProjectNotificationUpdate(ctx context.Context, pKey string, notif *sdk.ProjectNotification) error
ProjectNotificationDelete(ctx context.Context, pKey string, notifName string) error
ProjectNotificationGet(ctx context.Context, pKey string, notifName string) (*sdk.ProjectNotification, error)
ProjectNotificationList(ctx context.Context, pKey string) ([]sdk.ProjectNotification, error)
ProjectVariableSetCreate(ctx context.Context, pKey string, vs *sdk.ProjectVariableSet) error
ProjectVariableSetCreateFromApplication(ctx context.Context, pKey string, req sdk.CopyApplicationVariableToVariableSet) error
ProjectVariableSetCreateFromEnvironment(ctx context.Context, pKey string, req sdk.CopyEnvironmentVariableToVariableSet) error
ProjectVariableSetDelete(ctx context.Context, pKey string, vsName string, mod ...RequestModifier) error
ProjectVariableSetList(ctx context.Context, pKey string) ([]sdk.ProjectVariableSet, error)
ProjectVariableSetShow(ctx context.Context, pKey string, vsName string) (*sdk.ProjectVariableSet, error)
ProjectVariableSetItemAdd(ctx context.Context, pKey string, vsName string, item *sdk.ProjectVariableSetItem) error
ProjectVariableSetItemUpdate(ctx context.Context, pKey string, vsName string, item *sdk.ProjectVariableSetItem) error
ProjectVariableSetItemDelete(ctx context.Context, pKey string, vsName string, itemName string) error
ProjectVariableSetItemGet(ctx context.Context, pKey string, vsName string, itemName string) (*sdk.ProjectVariableSetItem, error)
ProjectVariableSetItemFromProjectVariable(ctx context.Context, pKey string, req sdk.CopyProjectVariableToVariableSet, mods ...RequestModifier) error
ProjectVariableSetItemFromAsCodeSecret(ctx context.Context, pKey string, req sdk.CopyAsCodeSecretToVariableSet, mods ...RequestModifier) error
ProjectVariableSetItemFromApplicationIntegrationVariable(ctx context.Context, pKey string, req sdk.CopyApplicationIntegrationVariableToVariableSet, mods ...RequestModifier) error
ProjectConcurrencyCreate(ctx context.Context, pKey string, c *sdk.ProjectConcurrency) error
ProjectConcurrencyGet(ctx context.Context, pKey string, name string) (*sdk.ProjectConcurrency, error)
ProjectConcurrencyList(ctx context.Context, pKey string) ([]sdk.ProjectConcurrency, error)
ProjectConcurrencyUpdate(ctx context.Context, pKey string, c *sdk.ProjectConcurrency) error
ProjectConcurrencyDelete(ctx context.Context, pKey string, name string) error
ProjectConcurrencyListRuns(ctx context.Context, pKey string, name string) ([]sdk.ProjectConcurrencyRunObject, error)
ProjectV2Access(ctx context.Context, projectKey, sessionID string, itemType sdk.CDNItemType) error
ProjectWebHookAdd(ctx context.Context, projectKey string, r sdk.PostProjectWebHook) (*sdk.HookAccessData, error)
ProjectWebHookList(ctx context.Context, projectKey string) ([]sdk.ProjectWebHook, error)
ProjectWebHookGet(ctx context.Context, projectKey string, uuid string) (*sdk.ProjectWebHook, error)
ProjectWebHookDelete(ctx context.Context, projectKey string, uuid string) error
}
ProjectClientV2 exposes project related functions
type ProjectKeysClient ¶
type ProjectKeysClient interface {
ProjectKeysList(projectKey string) ([]sdk.ProjectKey, error)
ProjectKeyCreate(projectKey string, key *sdk.ProjectKey) error
ProjectKeysDelete(projectKey string, keyProjectName string) error
ProjectKeysDisable(projectKey string, keyProjectName string) error
ProjectKeysEnable(projectKey string, keyProjectName string) error
}
ProjectKeysClient exposes project keys related functions
type ProjectVariablesClient ¶
type ProjectVariablesClient interface {
ProjectVariablesList(key string) ([]sdk.Variable, error)
ProjectVariableCreate(projectKey string, variable *sdk.Variable) error
ProjectVariableDelete(projectKey string, varName string) error
ProjectVariableGet(projectKey string, varName string) (*sdk.Variable, error)
ProjectVariableUpdate(projectKey string, variable *sdk.Variable) error
VariableEncrypt(projectKey string, varName string, content string) (*sdk.Variable, error)
VariableListEncrypt(projectKey string) ([]sdk.Secret, error)
VariableEncryptDelete(projectKey, name string) error
}
ProjectVariablesClient exposes project variables related functions
type ProviderClient ¶
type ProviderClient interface {
ApplicationsList(projectKey string, opts ...RequestModifier) ([]sdk.Application, error)
ApplicationDeploymentStrategyUpdate(projectKey, applicationName, integrationName string, config sdk.IntegrationConfig) error
ApplicationMetadataUpdate(projectKey, applicationName, key, value string) error
ProjectsList(opts ...RequestModifier) ([]sdk.Project, error)
WorkflowsList(projectKey string) ([]sdk.Workflow, error)
WorkflowLoad(projectKey, workflowName string) (*sdk.Workflow, error)
}
ProviderClient exposes allowed methods for providers
Usage:
cfg := ProviderConfig{
Host: "https://my-cds-api:8081",
Name: "my-provider-name",
Token: "my-very-long-secret-token",
}
client := NewProviderClient(cfg)
//Get the writable projects of a user
projects, err := client.ProjectsList(FilterByUser("a-username"), FilterByWritablePermission())
...
func NewProviderClient ¶
func NewProviderClient(cfg ProviderConfig) ProviderClient
NewProviderClient returns an implementation for ProviderClient interface
type ProviderConfig ¶
type ProviderConfig struct {
Host string
Token string
RequestSecondsTimeout int
InsecureSkipVerifyTLS bool
}
ProviderConfig is the configuration data used by the cdsclient ProviderClient interface implementation
type QueueClient ¶
type QueueClient interface {
QueueWorkflowNodeJobRun(mods ...RequestModifier) ([]sdk.WorkflowNodeJobRun, error)
QueueCountWorkflowNodeJobRun(since *time.Time, until *time.Time, modelType string) (sdk.WorkflowNodeJobRunCount, error)
QueuePolling(ctx context.Context, goRoutines *sdk.GoRoutines, hatcheryMetrics *sdk.HatcheryMetrics, pendingWorkerCreation *sdk.HatcheryPendingWorkerCreation, jobs chan<- sdk.WorkflowNodeJobRun, errs chan<- error, filters []sdk.WebsocketFilter, delay time.Duration, ms ...RequestModifier) error
QueueTakeJob(ctx context.Context, job sdk.WorkflowNodeJobRun) (*sdk.WorkflowNodeJobRunData, error)
QueueJobBook(ctx context.Context, id string) (sdk.WorkflowNodeJobRunBooked, error)
QueueJobRelease(ctx context.Context, id string) error
QueueJobInfo(ctx context.Context, id string) (*sdk.WorkflowNodeJobRun, error)
QueueJobSendSpawnInfo(ctx context.Context, id string, in []sdk.SpawnInfo) error
QueueSendUnitTests(ctx context.Context, id int64, report sdk.JUnitTestsSuites) error
QueueSendStepResult(ctx context.Context, id int64, res sdk.StepStatus) error
QueueSendResult(ctx context.Context, id int64, res sdk.Result) error
QueueJobTag(ctx context.Context, jobID int64, tags []sdk.WorkflowRunTag) error
QueueJobSetVersion(ctx context.Context, jobID int64, version sdk.WorkflowRunVersion) error
QueueWorkerCacheLink(ctx context.Context, jobID int64, tag string) (sdk.CDNItemLinks, error)
QueueWorkflowRunResultsAdd(ctx context.Context, jobID int64, addRequest sdk.WorkflowRunResult) error
QueueWorkflowRunResultCheck(ctx context.Context, jobID int64, runResultCheck sdk.WorkflowRunResultCheck) (int, error)
QueueWorkflowRunResultsRelease(ctx context.Context, permJobID int64, runResultIDs []string, to string) error
QueueWorkflowRunResultsPromote(ctx context.Context, permJobID int64, runResultIDs []string, to string) error
}
QueueClient exposes queue related functions
type RBACClient ¶ added in v0.52.0
type RBACClient interface {
RBACImport(ctx context.Context, rbacRule sdk.RBAC, mods ...RequestModifier) (sdk.RBAC, error)
RBACDelete(ctx context.Context, permissionIdentifier string) error
RBACGet(ctx context.Context, permissionIdentifier string) (sdk.RBAC, error)
RBACList(ctx context.Context) ([]sdk.RBAC, error)
}
type Raw ¶
type Raw interface {
PostJSON(ctx context.Context, path string, in interface{}, out interface{}, mods ...RequestModifier) (int, error)
PutJSON(ctx context.Context, path string, in interface{}, out interface{}, mods ...RequestModifier) (int, error)
GetJSON(ctx context.Context, path string, out interface{}, mods ...RequestModifier) (int, error)
DeleteJSON(ctx context.Context, path string, out interface{}, mods ...RequestModifier) (int, error)
RequestJSON(ctx context.Context, method, path string, in interface{}, out interface{}, mods ...RequestModifier) ([]byte, http.Header, int, error)
Request(ctx context.Context, method string, path string, body io.Reader, mods ...RequestModifier) ([]byte, http.Header, int, error)
Stream(ctx context.Context, httpClient HTTPClient, method string, path string, body io.Reader, mods ...RequestModifier) (io.ReadCloser, http.Header, int, error)
HTTPClient() *http.Client
HTTPNoTimeoutClient() *http.Client
HTTPWebsocketClient() *websocket.Dialer
}
Raw is a low-level interface exposing HTTP functions
type RegionClient ¶ added in v0.52.0
type RepositoriesManagerInterface ¶
type RepositoriesManagerInterface interface {
RepositoriesList(projectKey string, repoManager string, resync bool) ([]sdk.VCSRepo, error)
}
RepositoriesManagerInterface exposes all repostories manager functions
type RequestModifier ¶
RequestModifier is used to modify behavior of Request and Steam functions
func ContentType ¶
func ContentType(value string) RequestModifier
func FilterByUser ¶
func FilterByUser(username string) RequestModifier
FilterByUser allow a provider to perform a request as a user identified by its username
func FilterByWritablePermission ¶
func FilterByWritablePermission() RequestModifier
FilterByWritablePermission allow a provider to filter only writable objects
func Force ¶
func Force() RequestModifier
func Format ¶
func Format(format string) RequestModifier
func IgnoreMissing ¶ added in v0.55.2
func IgnoreMissing() RequestModifier
func ModelType ¶
func ModelType(modelType string) RequestModifier
func Region ¶
func Region(regions ...string) RequestModifier
func SetHeader ¶
func SetHeader(key, value string) RequestModifier
SetHeader modify headers of http.Request
func Signer ¶ added in v0.55.2
func Signer(signer string) RequestModifier
func Status ¶
func Status(status ...string) RequestModifier
func WithDeepPipelines ¶
func WithDeepPipelines() RequestModifier
WithDeepPipelines allows to get pipelines details on a workflow.
func WithKeys ¶
func WithKeys() RequestModifier
WithKeys allow a provider to retrieve a project with its keys.
func WithLabels ¶
func WithLabels() RequestModifier
WithLabels allow a provider to retrieve a workflow with its labels
func WithPermissions ¶
func WithPermissions() RequestModifier
WithPermissions allow a provider to retrieve a workflow with its permissions.
func WithQueryParameter ¶
func WithQueryParameter(key, value string) RequestModifier
WithQueryParameter add query parameters to your http.Request
func WithTemplate ¶
func WithTemplate() RequestModifier
WithTemplate allow a provider to retrieve a workflow with template if exists.
func WithUsage ¶
func WithUsage() RequestModifier
WithUsage allow a provider to retrieve an application with its usage
func WithWorkflows ¶
func WithWorkflows() RequestModifier
WithWorkflows allow a provider to retrieve a pipeline with its workflows usage
func Workflows ¶ added in v0.53.1
func Workflows(ws ...string) RequestModifier
type ServiceClient ¶
type ServiceClient interface {
ServiceConfigurationGet(context.Context, string) ([]sdk.ServiceConfiguration, error)
}
ServiceClient exposes functions used for services
type ServiceConfig ¶
type ServiceConfig struct {
Host string
Token string
RequestSecondsTimeout int
InsecureSkipVerifyTLS bool
Hook func(Interface) error // This hook is used by unit tests
Verbose bool
TokenV2 string
}
ServiceConfig is the configuration data used by the cdsclient interface implementation
type TemplateClient ¶
type TemplateClient interface {
TemplateGet(groupName, templateSlug string) (*sdk.WorkflowTemplate, error)
TemplateGetAll() ([]sdk.WorkflowTemplate, error)
TemplateApply(groupName, templateSlug string, req sdk.WorkflowTemplateRequest, mods ...RequestModifier) (*tar.Reader, error)
TemplateBulk(groupName, templateSlug string, req sdk.WorkflowTemplateBulk) (*sdk.WorkflowTemplateBulk, error)
TemplateGetBulk(groupName, templateSlug string, id int64) (*sdk.WorkflowTemplateBulk, error)
TemplatePull(groupName, templateSlug string) (*tar.Reader, error)
TemplatePush(tarContent io.Reader) ([]string, *tar.Reader, error)
TemplateDelete(groupName, templateSlug string) error
TemplateGetInstances(groupName, templateSlug string) ([]sdk.WorkflowTemplateInstance, error)
TemplateDeleteInstance(groupName, templateSlug string, id int64) error
}
TemplateClient exposes templates functions
type TemplateV2Client ¶ added in v0.55.0
type TemplateV2Client interface {
TemplateGenerateWorkflowFromFile(ctx context.Context, req sdk.V2WorkflowTemplateGenerateRequest) (*sdk.V2WorkflowTemplateGenerateResponse, error)
}
type UserClient ¶
type UserClient interface {
UserList(ctx context.Context) ([]sdk.AuthentifiedUser, error)
UserGet(ctx context.Context, username string) (*sdk.AuthentifiedUser, error)
UserUpdate(ctx context.Context, username string, user *sdk.AuthentifiedUser) error
UserGetMe(ctx context.Context) (*sdk.AuthentifiedUser, error)
UserContacts(ctx context.Context, username string) ([]sdk.UserContact, error)
UserGetGroups(ctx context.Context, username string) (map[string][]sdk.Group, error)
UserGetSchema(ctx context.Context) (sdk.SchemaResponse, error)
UserGetSchemaV2(ctx context.Context, entityType string) (sdk.Schema, error)
UserGpgKeyList(ctx context.Context, username string) ([]sdk.UserGPGKey, error)
UserGpgKeyGet(ctx context.Context, keyID string) (sdk.UserGPGKey, error)
UserGpgKeyDelete(ctx context.Context, username string, keyID string) error
UserGpgKeyCreate(ctx context.Context, username string, publicKey string) (sdk.UserGPGKey, error)
}
UserClient exposes users functions
type V2QueueClient ¶ added in v0.53.0
type V2QueueClient interface {
V2QueueGetJobRun(ctx context.Context, regionName string, id string) (*sdk.V2QueueJobInfo, error)
V2QueuePolling(ctx context.Context, region string, osarch []string, goRoutines *sdk.GoRoutines, hatcheryMetrics *sdk.HatcheryMetrics, pendingWorkerCreation *sdk.HatcheryPendingWorkerCreation, jobs chan<- sdk.V2QueueJobInfo, errs chan<- error, delay time.Duration, ms ...RequestModifier) error
V2QueueJobResult(ctx context.Context, region string, jobRunID string, result sdk.V2WorkflowRunJobResult) error
V2QueueJobRunResultGet(ctx context.Context, regionName string, jobRunID string, runResultID string) (*sdk.V2WorkflowRunResult, error)
V2QueueJobRunResultsGet(ctx context.Context, regionName string, jobRunID string) ([]sdk.V2WorkflowRunResult, error)
V2QueueJobRunResultsSynchronize(ctx context.Context, regionName string, jobRunID string) error
V2QueueJobRunResultCreate(ctx context.Context, regionName string, jobRunID string, result *sdk.V2WorkflowRunResult) error
V2QueueJobRunResultUpdate(ctx context.Context, regionName string, jobRunID string, result *sdk.V2WorkflowRunResult) error
V2QueuePushRunInfo(ctx context.Context, regionName string, jobRunID string, msg sdk.V2WorkflowRunInfo) error
V2QueuePushJobInfo(ctx context.Context, regionName string, jobRunID string, msg sdk.V2SendJobRunInfo) error
V2QueueWorkerTakeJob(ctx context.Context, region, runJobID string) (*sdk.V2TakeJobResponse, error)
V2QueueJobStepUpdate(ctx context.Context, regionName string, id string, stepsStatus sdk.JobStepsStatus) error
V2QueueGetCacheLinks(ctx context.Context, regionName string, id string, cacheKey string) (*sdk.CDNItemLinks, error)
}
type V2WorkerClient ¶ added in v0.53.0
type V2WorkerClient interface {
V2WorkerRegister(ctx context.Context, authToken string, form sdk.WorkerRegistrationForm, region, runJobID string) (*sdk.V2Worker, error)
V2WorkerUnregister(ctx context.Context, region, runJobID string) error
V2WorkerRefresh(ctx context.Context, region, runJobID string) error
V2WorkerProjectGetKey(ctx context.Context, region, runJobID, keyName string, clear bool) (*sdk.ProjectKey, error)
}
type V2WorkerInterface ¶ added in v0.53.0
type V2WorkerInterface interface {
V2WorkerClient
V2QueueClient
GRPCPluginsClient
ProjectIntegrationGet(projectKey string, integrationName string, clearPassword bool) (sdk.ProjectIntegration, error)
ProjectIntegrationWorkerHookGet(projectKey string, integrationName string) (*sdk.WorkerHookProjectIntegrationModel, error)
}
func NewWorkerV2 ¶ added in v0.53.0
func NewWorkerV2(endpoint string, name string, c *http.Client) V2WorkerInterface
type WebsocketClient ¶
type WebsocketClient interface {
RequestWebsocket(ctx context.Context, goRoutines *sdk.GoRoutines, path string, msgToSend <-chan json.RawMessage, msgReceived chan<- json.RawMessage, errorReceived chan<- error) error
}
type WorkerClient ¶
type WorkerClient interface {
WorkerGet(ctx context.Context, name string, mods ...RequestModifier) (*sdk.Worker, error)
WorkerModelBook(groupName, name string) error
WorkerList(ctx context.Context) ([]sdk.Worker, error)
WorkerRefresh(ctx context.Context) error
WorkerUnregister(ctx context.Context) error
WorkerDisable(ctx context.Context, id string) error
WorkerModelAdd(name, modelType, patternName string, dockerModel *sdk.ModelDocker, vmModel *sdk.ModelVirtualMachine, groupID int64) (sdk.Model, error)
WorkerModelGet(groupName, name string) (sdk.Model, error)
WorkerModelDelete(groupName, name string) error
WorkerModelSpawnError(groupName, name string, info sdk.SpawnErrorForm) error
WorkerModelList(*WorkerModelFilter) ([]sdk.Model, error)
WorkerModelEnabledList() ([]sdk.Model, error)
WorkerModelSecretList(groupName, name string) (sdk.WorkerModelSecrets, error)
WorkerRegister(ctx context.Context, authToken string, form sdk.WorkerRegistrationForm) (*sdk.Worker, bool, error)
WorkerSetStatus(ctx context.Context, status string) error
WorkerModelv2List(ctx context.Context, projKey string, vcsIdentifier string, repoIdentifier string, filter *WorkerModelV2Filter) ([]sdk.V2WorkerModel, error)
V2WorkerGet(ctx context.Context, name string, mods ...RequestModifier) (*sdk.V2Worker, error)
V2WorkerList(ctx context.Context) ([]sdk.V2Worker, error)
CDNClient
}
WorkerClient exposes workers functions
type WorkerInterface ¶
type WorkerInterface interface {
GRPCPluginsClient
ProjectIntegrationGet(projectKey string, integrationName string, clearPassword bool) (sdk.ProjectIntegration, error)
ProjectIntegrationWorkerHookGet(projectKey string, integrationName string) (*sdk.WorkerHookProjectIntegrationModel, error)
QueueClient
Requirements() ([]sdk.Requirement, error)
ServiceClient
WorkerClient
WorkflowRunGet(projectKey string, workflowName string, number int64) (*sdk.WorkflowRun, error)
WorkflowRunList(projectKey string, workflowName string, offset, limit int64) ([]sdk.WorkflowRun, error)
WorkflowNodeRunRelease(projectKey string, workflowName string, runNumber int64, nodeRunID int64, release sdk.WorkflowNodeRunRelease) error
WorkflowRunArtifactsLinks(projectKey string, name string, number int64) (sdk.CDNItemLinks, error)
WorkflowRunResultsList(ctx context.Context, projectKey string, name string, number int64) ([]sdk.WorkflowRunResult, error)
}
type WorkerModelFilter ¶
WorkerModelFilter for model's calls.
type WorkerModelV2Filter ¶ added in v0.52.0
type WorkerModelV2Filter struct {
Branch string
}
type WorkflowAsCodeInterface ¶
type WorkflowAsCodeInterface interface {
WorkflowAsCodeStart(projectKey string, repoURL string, repoStrategy sdk.RepositoryStrategy) (*sdk.Operation, error)
WorkflowAsCodeInfo(projectKey string, operationID string) (*sdk.Operation, error)
WorkflowAsCodePerform(projectKey string, operationID string) ([]string, error)
}
WorkflowAsCodeInterface exposes all workflow as code functions
type WorkflowClient ¶
type WorkflowClient interface {
WorkflowSearch(opts ...RequestModifier) ([]sdk.Workflow, error)
WorkflowList(projectKey string, opts ...RequestModifier) ([]sdk.Workflow, error)
WorkflowGet(projectKey, name string, opts ...RequestModifier) (*sdk.Workflow, error)
WorkflowUpdate(projectKey, name string, wf *sdk.Workflow) error
WorkflowDelete(projectKey string, workflowName string, opts ...RequestModifier) error
WorkflowLabelAdd(projectKey, name, labelName string) error
WorkflowLabelDelete(projectKey, name string, labelID int64) error
WorkflowGroupAdd(projectKey, name, groupName string, permission int) error
WorkflowGroupDelete(projectKey, name, groupName string) error
WorkflowRunGet(projectKey string, workflowName string, number int64) (*sdk.WorkflowRun, error)
WorkflowRunsDeleteByBranch(projectKey string, workflowName string, branch string) error
WorkflowRunSearch(projectKey string, offset, limit int64, filter ...Filter) ([]sdk.WorkflowRun, error)
WorkflowRunList(projectKey string, workflowName string, offset, limit int64) ([]sdk.WorkflowRun, error)
WorkflowRunDelete(projectKey string, workflowName string, runNumber int64) error
WorkflowRunArtifactsLinks(projectKey string, name string, number int64) (sdk.CDNItemLinks, error)
WorkflowRunResultsList(ctx context.Context, projectKey string, name string, number int64) ([]sdk.WorkflowRunResult, error)
WorkflowRunFromHook(projectKey string, workflowName string, hook sdk.WorkflowNodeRunHookEvent) (*sdk.WorkflowRun, error)
WorkflowRunFromManual(projectKey string, workflowName string, manual sdk.WorkflowNodeRunManual, number, fromNodeID int64) (*sdk.WorkflowRun, error)
WorkflowRunNumberGet(projectKey string, workflowName string) (*sdk.WorkflowRunNumber, error)
WorkflowRunNumberSet(projectKey string, workflowName string, number int64) error
WorkflowStop(projectKey string, workflowName string, number int64) (*sdk.WorkflowRun, error)
WorkflowNodeStop(projectKey string, workflowName string, number, fromNodeID int64) (*sdk.WorkflowNodeRun, error)
WorkflowNodeRun(projectKey string, name string, number int64, nodeRunID int64) (*sdk.WorkflowNodeRun, error)
WorkflowNodeRunJobStepLinks(ctx context.Context, projectKey string, workflowName string, nodeRunID, job int64) (*sdk.CDNLogLinks, error)
WorkflowNodeRunJobStepLink(ctx context.Context, projectKey string, workflowName string, nodeRunID, job int64, step int64) (*sdk.CDNLogLink, error)
WorkflowNodeRunJobServiceLink(ctx context.Context, projectKey string, workflowName string, nodeRunID, job int64, serviceName string) (*sdk.CDNLogLink, error)
WorkflowAccess(ctx context.Context, projectKey string, workflowID int64, sessionID string, itemType sdk.CDNItemType) error
WorkflowLogDownload(ctx context.Context, link sdk.CDNLogLink) ([]byte, error)
WorkflowNodeRunRelease(projectKey string, workflowName string, runNumber int64, nodeRunID int64, release sdk.WorkflowNodeRunRelease) error
WorkflowAllHooksList() ([]sdk.NodeHook, error)
WorkflowAllHooksExecutions() ([]string, error)
WorkflowTransformAsCode(projectKey, workflowName, branch, message string) (*sdk.Operation, error)
}
WorkflowClient exposes workflows functions
type WorkflowV2Client ¶ added in v0.53.0
type WorkflowV2Client interface {
WorkflowV2RunFromHook(ctx context.Context, projectKey, vcsIdentifier, repoIdentifier, wkfName string, runRequest sdk.V2WorkflowRunHookRequest, mods ...RequestModifier) (*sdk.V2WorkflowRun, error)
WorkflowV2Run(ctx context.Context, projectKey, vcsIdentifier, repoIdentifier, wkfName string, payload sdk.V2WorkflowRunManualRequest, mods ...RequestModifier) (*sdk.V2WorkflowRunManualResponse, error)
WorkflowV2Restart(ctx context.Context, projectKey, workflowRunID string, mods ...RequestModifier) (*sdk.V2WorkflowRun, error)
WorkflowV2JobStart(ctx context.Context, projectKey, workflowRunID, jobIdentifier string, payload map[string]interface{}, mods ...RequestModifier) (*sdk.V2WorkflowRun, error)
WorkflowV2RunSearchAllProjects(ctx context.Context, offset, limit int64, mods ...RequestModifier) ([]sdk.V2WorkflowRun, error)
WorkflowV2RunSearch(ctx context.Context, projectKey string, mods ...RequestModifier) ([]sdk.V2WorkflowRun, error)
WorkflowV2RunInfoList(ctx context.Context, projectKey, workflowRunID string, mods ...RequestModifier) ([]sdk.V2WorkflowRunInfo, error)
WorkflowV2RunStatus(ctx context.Context, projectKey, workflowRunID string) (*sdk.V2WorkflowRun, error)
WorkflowV2RunJobs(ctx context.Context, projKey, workflowRunID string) ([]sdk.V2WorkflowRunJob, error)
WorkflowV2RunJob(ctx context.Context, projKey, workflowRunID, jobRunID string) (*sdk.V2WorkflowRunJob, error)
WorkflowV2RunJobInfoList(ctx context.Context, projKey, workflowRunID, jobRunID string) ([]sdk.V2WorkflowRunJobInfo, error)
WorkflowV2RunJobLogLinks(ctx context.Context, projKey, workflowRunID, jobRunID string) (sdk.CDNLogLinks, error)
WorkflowV2Stop(ctx context.Context, projKey, workflowRunID string) error
WorkflowV2StopJob(ctx context.Context, projKey, workflowRunID, jobIdentifier string) error
WorkflowV2RunResultList(ctx context.Context, projKey, runIdentifier string) ([]sdk.V2WorkflowRunResult, error)
WorkflowV2VersionList(ctx context.Context, projKey, vcsIdentifier, repoIdentifier, wkfName string) ([]sdk.V2WorkflowVersion, error)
WorkflowV2VersionGet(ctx context.Context, projKey, vcsIdentifier, repoIdentifier, wkfName, version string) (*sdk.V2WorkflowVersion, error)
WorkflowV2VersionDelete(ctx context.Context, projKey, vcsIdentifier, repoIdentifier, wkfName, version string) error
}
Source Files
¶
- client.go
- client_action.go
- client_admin.go
- client_admin_database.go
- client_application.go
- client_application_key.go
- client_application_variable.go
- client_auth.go
- client_cdn.go
- client_config.go
- client_download.go
- client_entity.go
- client_environment.go
- client_environment_key.go
- client_environment_variable.go
- client_events.go
- client_export.go
- client_feature.go
- client_featureflipping.go
- client_group.go
- client_group_user.go
- client_hatchery.go
- client_hatchery_service.go
- client_hook.go
- client_import.go
- client_integration.go
- client_maintenance.go
- client_mon.go
- client_organization.go
- client_pipeline.go
- client_plugins.go
- client_plugins_v2.go
- client_project.go
- client_project_concurrency.go
- client_project_integration.go
- client_project_key.go
- client_project_notification.go
- client_project_repository.go
- client_project_variable.go
- client_project_variable_set.go
- client_project_vcs.go
- client_project_webhook.go
- client_queue.go
- client_queue_V2.go
- client_rbac.go
- client_rbac_check.go
- client_region.go
- client_repositories_manager.go
- client_services.go
- client_template.go
- client_template_v2.go
- client_user.go
- client_vcs.go
- client_version.go
- client_worker.go
- client_worker_model.go
- client_worker_v2.go
- client_workflow.go
- client_workflow_as_code.go
- client_workflow_hooks.go
- client_workflowv2.go
- config.go
- http.go
- http_websocket.go
- interface.go
Directories
¶
| Path | Synopsis |
|---|---|
|
Package mock_cdsclient is a generated GoMock package.
|
Package mock_cdsclient is a generated GoMock package. |