api

package

Go to main page

Versions in this module

v1

v1.2.1

Jun 25, 2026

Changes in this version

type BuildsOptions

+ DeepLookup bool

v1.2.0

Jun 19, 2026

Changes in this version

+ func ValidTestStatus(s string) bool

type BuildStep

+ Disabled bool

+ type BuildStepList struct

+ Count int

+ Step []BuildStep

type Client

+ func (c *Client) DeleteBuildStep(buildTypeID, stepID string) error

+ func (c *Client) GetBuildStep(buildTypeID, stepID string) (*BuildStep, error)

+ func (c *Client) GetBuildSteps(buildTypeID string) (*BuildStepList, error)

+ func (c *Client) GetBuildTypeSetting(buildTypeID, name string) (string, error)

+ func (c *Client) GetBuildTypeSettings(buildTypeID string) (*SettingsList, error)

+ func (c *Client) ListTestOccurrences(ctx context.Context, q TestOccurrenceQuery) (*TestOccurrences, error)

+ func (c *Client) NormalizePaginationPath(href string) string

type ClientInterface

+ DeleteBuildStep func(buildTypeID, stepID string) error

+ GetBuildStep func(buildTypeID, stepID string) (*BuildStep, error)

+ GetBuildSteps func(buildTypeID string) (*BuildStepList, error)

+ GetBuildTypeSetting func(buildTypeID, name string) (string, error)

+ GetBuildTypeSettings func(buildTypeID string) (*SettingsList, error)

+ ListTestOccurrences func(ctx context.Context, q TestOccurrenceQuery) (*TestOccurrences, error)

+ NormalizePaginationPath func(href string) string

type CreateBuildTypeRequest

+ Project *ProjectRef

+ Templates *BuildTypeList

+ type Setting struct

+ Name string

+ Value string

+ type SettingsList struct

+ Count int

+ Property []Setting

+ type TestOccurrenceQuery struct

+ Build string

+ BuildType string

+ Fields []string

+ Limit int

+ Muted *bool

+ Status string

+ TestName string

type TestOccurrences

+ NextHref string

v1.1.1

May 29, 2026

v1.1.0

May 28, 2026

Changes in this version

+ func ErrorFromBody(status int, body []byte) error

type Client

+ func (c *Client) GetBuildLogStream(ctx context.Context, buildID string) (io.ReadCloser, error)

type ClientInterface

+ GetBuildLogStream func(ctx context.Context, buildID string) (io.ReadCloser, error)

v1.0.0

May 6, 2026

Changes in this version

+ const PermissionEditProject

+ type BuildTestsOptions struct

+ FailedOnly bool

+ Limit int

+ MutedOnly bool

type BuildType

+ VcsRootEntries *VcsRootEntries

type BuildTypesOptions

+ VcsRootURL string

type ProjectsOptions

+ ExcludeArchived bool

+ Permission string

type Server

+ InternalID string

type TestOccurrence

+ Muted bool

type TestOccurrences

+ Muted int

v0

v0.10.0

Apr 29, 2026

Changes in this version

+ const EnvHeaderPrefix

+ var ErrLoginGatewayDetected = errors.New("login gateway detected — VPN may be required")

+ var ErrPipelineSchemaUnsupported = errors.New("schema endpoint not available on this server")

+ var KnownPermissions = map[string]string

+ func EnvHeaders() map[string]string

+ func ErrorFromResponse(resp *http.Response) error

+ func IsSandboxBlocked(err error) bool

+ func PermissionEnum(description string) string

+ type AuthSource string

+ const AuthSourceBuild

+ const AuthSourceEnv

+ const AuthSourceGuest

+ const AuthSourceManual

+ const AuthSourcePKCE

+ const AuthSourceUnknown

+ type Category string

+ const CatAuth

+ const CatInternal

+ const CatNetwork

+ const CatNotFound

+ const CatPermission

+ const CatReadOnly

+ const CatValidation

type Client

+ AuthSource AuthSource

+ func (c *Client) CreateProjectFeature(projectID string, feat ProjectFeature) (*ProjectFeature, error)

+ func (c *Client) DeleteProjectFeature(projectID, featureID string) error

+ func (c *Client) ExchangeCodeForToken(ctx context.Context, code, verifier, redirectURI string) (*TokenResponse, error)

+ func (c *Client) GetAgentBuildTypeCompatibility(agentID int, buildTypeID string, maxScan int) (*Compatibility, error)

+ func (c *Client) GetBuildCompatibleAgents(buildID int) (*AgentList, error)

+ func (c *Client) GetBuildIncompatibleAgents(buildID int) (*AgentList, error)

+ func (c *Client) IsPkceEnabled(ctx context.Context) (bool, error)

+ func (c *Client) Probe(ctx context.Context) error

+ func (c *Client) ServerURL() string

+ func (c *Client) WithContext(ctx context.Context) *Client

type ClientInterface

+ CreateProjectFeature func(projectID string, feat ProjectFeature) (*ProjectFeature, error)

+ DeleteProjectFeature func(projectID, featureID string) error

+ GetAgentBuildTypeCompatibility func(agentID int, buildTypeID string, maxScan int) (*Compatibility, error)

+ GetBuildCompatibleAgents func(buildID int) (*AgentList, error)

+ GetBuildIncompatibleAgents func(buildID int) (*AgentList, error)

+ ServerURL func() string

type ClientOption

+ func WithAuthSource(src AuthSource) ClientOption

+ func WithExtraHeaders(h map[string]string) ClientOption

type Compatibility

+ UnmetRequirements *UnmetRequirements

+ func (c *Compatibility) ReasonsList() []string

type CreateProjectRequest

+ ParentProject *ProjectRef

+ type HTTPError struct

+ Status int

+ Wire Wire

+ func (e *HTTPError) Category() Category

+ func (e *HTTPError) Error() string

type NetworkError

+ func (*NetworkError) Category() Category

type PermissionError

+ AuthSource AuthSource

+ Permission string

+ Project string

+ type UnmetRequirements struct

+ Description string

+ type UserError interface

+ Category func() Category

+ type ValidationError struct

+ Msg string

+ Tip string

+ func MutuallyExclusive(arg, flag string) *ValidationError

+ func RequiredFlag(flag string) *ValidationError

+ func Validation(msg, tip string) *ValidationError

+ func (*ValidationError) Category() Category

+ func (e *ValidationError) Error() string

+ func (e *ValidationError) Suggestion() string

type VcsRoot

+ ConnectionID string

+ type Wire struct

+ Additional string

+ Message string

+ StatusText string

v0.9.1

Apr 20, 2026

Changes in this version

type BuildQueue

+ NextHref string

type BuildTypeList

+ NextHref string

type CloudImageList

+ NextHref string

type CloudInstanceList

+ NextHref string

type CloudProfileList

+ NextHref string

type PipelineList

+ NextHref string

type PoolList

+ NextHref string

type ProjectList

+ NextHref string

type VcsRootList

+ NextHref string

v0.9.0

Apr 14, 2026

Changes in this version

+ var CloudImageFields = FieldSpec

+ var CloudInstanceFields = FieldSpec

+ var CloudProfileFields = FieldSpec

+ var ConnectionFields = FieldSpec

+ var PipelineFields = FieldSpec

+ var SSHKeyFields = FieldSpec

+ var VcsRootFields = FieldSpec

type Build

+ UsedByOtherBuilds bool

+ WaitReason string

+ type BuildMessage struct

+ BlockType string

+ ContainsMessages bool

+ FlowID int

+ ID int

+ Level int

+ ParentID int

+ ServerTimestamp string

+ Status int

+ Text string

+ Timestamp string

+ Verbose bool

+ type BuildMessagesOptions struct

+ Count int

+ ExpandAll bool

+ SinceID int

+ Tail bool

+ type BuildMessagesResponse struct

+ FocusIndex int

+ LastMessageIncluded bool

+ LastMessageIndex int

+ Messages []BuildMessage

+ type BuildRef struct

+ ID int

type BuildsOptions

+ Revision string

type Client

+ func (c *Client) CreatePipeline(parentProjectID, name, yaml, vcsRootID string) (*Pipeline, error)

+ func (c *Client) CreateVcsRoot(root VcsRoot) (*VcsRoot, error)

+ func (c *Client) DeletePipeline(id string) error

+ func (c *Client) DeleteSSHKey(projectID, name string) error

+ func (c *Client) DeleteVcsRoot(id string) error

+ func (c *Client) GenerateSSHKey(projectID, name, keyType string) (*SSHKey, error)

+ func (c *Client) GetBuildMessages(buildID string, opts BuildMessagesOptions) (*BuildMessagesResponse, error)

+ func (c *Client) GetBuildPipelineRun(buildID string) (*PipelineRun, error)

+ func (c *Client) GetBuildResultingProperties(buildID string) (*ParameterList, error)

+ func (c *Client) GetBuildSnapshotDependencies(buildID string) (*BuildList, error)

+ func (c *Client) GetBuildTestSummary(buildID string) (*TestOccurrences, error)

+ func (c *Client) GetBuildUsedByOtherBuilds(id string) (bool, error)

+ func (c *Client) GetCloudImage(locator string) (*CloudImage, error)

+ func (c *Client) GetCloudImages(opts CloudImagesOptions) (*CloudImageList, error)

+ func (c *Client) GetCloudInstance(locator string) (*CloudInstance, error)

+ func (c *Client) GetCloudInstances(opts CloudInstancesOptions) (*CloudInstanceList, error)

+ func (c *Client) GetCloudProfile(locator string) (*CloudProfile, error)

+ func (c *Client) GetCloudProfiles(opts CloudProfilesOptions) (*CloudProfileList, error)

+ func (c *Client) GetPipeline(id string) (*Pipeline, error)

+ func (c *Client) GetPipelineSchema() ([]byte, error)

+ func (c *Client) GetPipelineYAML(id string) (string, error)

+ func (c *Client) GetPipelines(opts PipelinesOptions) (*PipelineList, error)

+ func (c *Client) GetProjectConnections(projectID string) (*ProjectFeatureList, error)

+ func (c *Client) GetSSHKeys(projectID string) (*SSHKeyList, error)

+ func (c *Client) GetVcsRoot(id string) (*VcsRoot, error)

+ func (c *Client) GetVcsRoots(opts VcsRootsOptions) (*VcsRootList, error)

+ func (c *Client) StartCloudInstance(imageID string) (*CloudInstance, error)

+ func (c *Client) StopCloudInstance(locator string, force bool) error

+ func (c *Client) TestVcsConnection(req TestConnectionRequest, projectID string) (*TestConnectionResult, error)

+ func (c *Client) UpdatePipelineYAML(id string, yamlContent string) error

+ func (c *Client) UploadSSHKey(projectID, name string, privateKey []byte) error

type ClientInterface

+ CreatePipeline func(parentProjectID, name, yaml, vcsRootID string) (*Pipeline, error)

+ CreateVcsRoot func(root VcsRoot) (*VcsRoot, error)

+ DeletePipeline func(id string) error

+ DeleteSSHKey func(projectID, name string) error

+ DeleteVcsRoot func(id string) error

+ GenerateSSHKey func(projectID, name, keyType string) (*SSHKey, error)

+ GetBuildMessages func(buildID string, opts BuildMessagesOptions) (*BuildMessagesResponse, error)

+ GetBuildPipelineRun func(buildID string) (*PipelineRun, error)

+ GetBuildResultingProperties func(buildID string) (*ParameterList, error)

+ GetBuildSnapshotDependencies func(buildID string) (*BuildList, error)

+ GetBuildTestSummary func(buildID string) (*TestOccurrences, error)

+ GetBuildUsedByOtherBuilds func(id string) (bool, error)

+ GetCloudImage func(locator string) (*CloudImage, error)

+ GetCloudImages func(opts CloudImagesOptions) (*CloudImageList, error)

+ GetCloudInstance func(locator string) (*CloudInstance, error)

+ GetCloudInstances func(opts CloudInstancesOptions) (*CloudInstanceList, error)

+ GetCloudProfile func(locator string) (*CloudProfile, error)

+ GetCloudProfiles func(opts CloudProfilesOptions) (*CloudProfileList, error)

+ GetPipeline func(id string) (*Pipeline, error)

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

+ GetPipelineYAML func(id string) (string, error)

+ GetPipelines func(opts PipelinesOptions) (*PipelineList, error)

+ GetProjectConnections func(projectID string) (*ProjectFeatureList, error)

+ GetSSHKeys func(projectID string) (*SSHKeyList, error)

+ GetVcsRoot func(id string) (*VcsRoot, error)

+ GetVcsRoots func(opts VcsRootsOptions) (*VcsRootList, error)

+ StartCloudInstance func(imageID string) (*CloudInstance, error)

+ StopCloudInstance func(locator string, force bool) error

+ TestVcsConnection func(req TestConnectionRequest, projectID string) (*TestConnectionResult, error)

+ UpdatePipelineYAML func(id string, yaml string) error

+ UploadSSHKey func(projectID, name string, privateKey []byte) error

+ type CloudImage struct

+ Href string

+ ID string

+ Name string

+ Profile *CloudProfile

+ Project *Project

+ type CloudImageList struct

+ Count int

+ Images []CloudImage

+ type CloudImageRef struct

+ ID string

+ type CloudImagesOptions struct

+ Fields []string

+ Limit int

+ Profile string

+ ProjectID string

+ type CloudInstance struct

+ Agent *Agent

+ Href string

+ ID string

+ Image *CloudImage

+ Name string

+ StartDate string

+ State string

+ type CloudInstanceList struct

+ Count int

+ Instances []CloudInstance

+ type CloudInstancesOptions struct

+ Fields []string

+ Image string

+ Limit int

+ ProjectID string

+ type CloudProfile struct

+ CloudProviderID string

+ Href string

+ ID string

+ Name string

+ Project *Project

+ type CloudProfileList struct

+ Count int

+ Profiles []CloudProfile

+ type CloudProfilesOptions struct

+ Fields []string

+ Limit int

+ ProjectID string

+ type CreatePipelineRequest struct

+ Name string

+ VcsRoot *PipelineVcsRootRef

+ YAML string

+ type Pipeline struct

+ HeadBuildType *BuildTypeRef

+ ID string

+ Jobs *PipelineJobs

+ Name string

+ ParentProject *ProjectRef

+ WebURL string

+ YAML string

+ type PipelineJob struct

+ ID string

+ Name string

+ type PipelineJobs struct

+ Count int

+ Job []PipelineJob

+ type PipelineList struct

+ Count int

+ Pipelines []Pipeline

+ type PipelineRef struct

+ ID string

+ Name string

+ type PipelineRun struct

+ Jobs *PipelineRunJobs

+ Number string

+ Pipeline *PipelineRef

+ type PipelineRunJob struct

+ Build *BuildRef

+ ID string

+ Name string

+ type PipelineRunJobs struct

+ Count int

+ Job []PipelineRunJob

+ type PipelineVcsRootRef struct

+ ExternalVcsRootID string

+ type PipelinesOptions struct

+ Fields []string

+ Limit int

+ Project string

+ type ProjectFeature struct

+ ID string

+ Properties *PropertyList

+ Type string

+ type ProjectFeatureList struct

+ Count int

+ ProjectFeature []ProjectFeature

+ type ProjectRef struct

+ ID string

+ Name string

type QueuedBuild

+ WaitReason string

type RunBuildOptions

+ SnapshotDependencies []int

+ type SSHKey struct

+ Encrypted bool

+ Name string

+ Project *Project

+ PublicKey string

+ type SSHKeyList struct

+ SSHKey []SSHKey

+ type SSHKeyRef struct

+ Name string

+ type SnapshotDepBuilds struct

+ Build []BuildRef

+ type StartCloudInstanceRequest struct

+ Image CloudImageRef

+ type TestConnectionError struct

+ AdditionalMessage string

+ Message string

+ StackTrace string

+ type TestConnectionRequest struct

+ ConnectionID string

+ IsPrivate bool

+ Password string

+ SSHKey *SSHKeyRef

+ URL string

+ Username string

+ VcsName string

+ type TestConnectionResult struct

+ Errors []TestConnectionError

+ Status string

type TriggerBuildRequest

+ SnapshotDependencies *SnapshotDepBuilds

+ type VcsRoot struct

+ Href string

+ ID string

+ Name string

+ Project *Project

+ Properties *PropertyList

+ VcsName string

+ type VcsRootList struct

+ Count int

+ VcsRoot []VcsRoot

+ type VcsRootsOptions struct

+ Fields []string

+ Limit int

+ Project string

v0.8.3

Apr 1, 2026

Changes in this version

type BuildsOptions

+ Favorites bool

+ func (opts BuildsOptions) Locator() *Locator

type Client

+ func (c *Client) SetCommandName(name string)

type ClientInterface

+ SetCommandName func(name string)

type ClientOption

+ func WithCommandName(name string) ClientOption

+ func WithVersion(v string) ClientOption

type Locator

+ func (l *Locator) AddLocator(key string, child *Locator) *Locator

v0.8.2

Mar 27, 2026

Changes in this version

+ func IsSandboxBlockedError(err error) bool

v0.8.1

Mar 27, 2026

Changes in this version

+ func ExtractErrorMessage(body []byte) string

+ func TLSConfigWithCert(cert tls.Certificate, caFile string) (*tls.Config, error)

type Client

+ func (c *Client) WaitForBuild(ctx context.Context, buildID string, opts WaitForBuildOptions) (*Build, error)

type ClientInterface

+ WaitForBuild func(ctx context.Context, buildID string, opts WaitForBuildOptions) (*Build, error)

+ type WaitForBuildOptions struct

+ Interval time.Duration

+ OnProgress func(state, status string, percent int) error

+ type XMLAPIError struct

+ AdditionalMessage string

+ Message string

+ StatusText string

+ type XMLAPIErrorResponse struct

+ Errors []XMLAPIError

+ XMLName xml.Name

+ func ParseXMLErrors(body []byte) *XMLAPIErrorResponse

v0.8.0

Mar 26, 2026

Changes in this version

+ const CodeChallengeMethod

+ const DefaultCallbackPath

+ const PkceAuthorizePath

+ const PkceClientID

+ const PkceIsEnabledPath

+ const PkceTokenPath

+ func BuildAuthorizeURL(serverURL, redirectURI, challenge, state string, scopes []string) string

+ func DefaultScopes() []string

+ func FindAvailableListener() (net.Listener, error)

+ func GenerateCodeChallenge(verifier string) string

+ func GenerateCodeVerifier() (string, error)

+ func GenerateState() (string, error)

+ func IsPkceEnabled(ctx context.Context, serverURL string) (bool, error)

+ func TLSConfig(certFile, keyFile, caFile string) (*tls.Config, error)

+ type CallbackResult struct

+ Code string

+ Error string

+ State string

+ type CallbackServer struct

+ Port int

+ ResultChan chan CallbackResult

+ func NewCallbackServer(listener net.Listener) *CallbackServer

+ func (cs *CallbackServer) Shutdown()

+ func (cs *CallbackServer) Start()

type ClientOption

+ func WithTransport(transport *http.Transport) ClientOption

+ type TokenResponse struct

+ AccessToken string

+ TokenType string

+ ValidUntil string

+ func ExchangeCodeForToken(ctx context.Context, serverURL, code, verifier, redirectURI string) (*TokenResponse, error)

v0.7.2

Feb 26, 2026

v0.7.0

Feb 24, 2026

Changes in this version

+ var ErrReadOnly = errors.New("read-only mode: write operations are not allowed")

type Client

+ ReadOnly bool

+ func NewGuestClient(baseURL string, opts ...ClientOption) *Client

+ func (c *Client) GetDependentBuildTypes(buildTypeID string) (*BuildTypeList, error)

+ func (c *Client) GetSnapshotDependencies(buildTypeID string) (*SnapshotDependencyList, error)

type ClientInterface

+ GetDependentBuildTypes func(buildTypeID string) (*BuildTypeList, error)

+ GetSnapshotDependencies func(buildTypeID string) (*SnapshotDependencyList, error)

type ClientOption

+ func WithReadOnly(readOnly bool) ClientOption

+ type SnapshotDependency struct

+ ID string

+ SourceBuildType *BuildType

+ type SnapshotDependencyList struct

+ Count int

+ SnapshotDependency []SnapshotDependency

type TestOccurrence

+ Build *Build

+ FirstFailed *TestOccurrence

+ NewFailure bool

v0.6.0

Feb 20, 2026

Changes in this version

+ const MinMajorVersion

+ const MinMinorVersion

+ var AgentFields = FieldSpec

+ var BuildFields = FieldSpec

+ var BuildTypeFields = FieldSpec

+ var ErrAuthentication = errors.New("authentication failed: invalid or expired credentials")

+ var LongRetry = RetryConfig

+ var NoRetry = RetryConfig

+ var PoolFields = FieldSpec

+ var ProjectFields = FieldSpec

+ var QueuedBuildFields = FieldSpec

+ var ReadRetry = RetryConfig

+ func FormatTeamCityTime(t time.Time) string

+ func ParseTeamCityTime(s string) (time.Time, error)

+ func ParseUserDate(input string) (string, error)

+ func ToAPIFields(fields []string) string

+ func ToAPIFieldsEncoded(fields []string) string

+ type APIError struct

+ Message string

+ type APIErrorResponse struct

+ Errors []APIError

+ type Agent struct

+ Authorized bool

+ Build *Build

+ Connected bool

+ Enabled bool

+ Href string

+ ID int

+ Name string

+ Pool *Pool

+ TypeID int

+ WebURL string

+ type AgentList struct

+ Agents []Agent

+ Count int

+ Href string

+ NextHref string

+ type AgentRef struct

+ ID int

+ Name string

+ type AgentsOptions struct

+ Authorized bool

+ Connected bool

+ Enabled bool

+ Fields []string

+ Limit int

+ Pool string

+ type ApprovalInfo struct

+ CanBeApprovedByCurrentUser bool

+ ConfigurationValid bool

+ Status string

+ type Artifact struct

+ Children *Artifacts

+ Content *Content

+ Href string

+ ModTime string

+ Name string

+ Size int64

+ type Artifacts struct

+ Count int

+ File []Artifact

+ type Build struct

+ Agent *Agent

+ BranchName string

+ BuildType *BuildType

+ BuildTypeID string

+ DefaultBranch bool

+ FinishDate string

+ Href string

+ ID int

+ LastChanges *ChangeList

+ Number string

+ PercentageComplete int

+ Personal bool

+ Pinned bool

+ QueuedDate string

+ StartDate string

+ State string

+ Status string

+ StatusText string

+ Tags *TagList

+ Triggered *Triggered

+ WebURL string

+ type BuildComment struct

+ Text string

+ type BuildList struct

+ Builds []Build

+ Count int

+ Href string

+ NextHref string

+ type BuildQueue struct

+ Builds []QueuedBuild

+ Count int

+ Href string

+ type BuildStep struct

+ ID string

+ Name string

+ Properties PropertyList

+ Type string

+ type BuildType struct

+ Href string

+ ID string

+ Name string

+ Paused bool

+ Project *Project

+ ProjectID string

+ ProjectName string

+ WebURL string

+ type BuildTypeList struct

+ BuildTypes []BuildType

+ Count int

+ type BuildTypeRef struct

+ ID string

+ type BuildTypesOptions struct

+ Fields []string

+ Limit int

+ Project string

+ type BuildsOptions struct

+ Branch string

+ BuildTypeID string

+ Fields []string

+ Limit int

+ Number string

+ Project string

+ SinceDate string

+ State string

+ Status string

+ UntilDate string

+ User string

+ type Change struct

+ Comment string

+ Date string

+ Files *Files

+ ID int

+ Username string

+ Version string

+ WebURL string

+ type ChangeList struct

+ Change []Change

+ Count int

+ type Client struct

+ APIVersion string

+ BaseURL string

+ DebugFunc func(format string, args ...any)

+ HTTPClient *http.Client

+ Token string

+ func NewClient(baseURL, token string, opts ...ClientOption) *Client

+ func NewClientWithBasicAuth(baseURL, username, password string, opts ...ClientOption) *Client

+ func (c *Client) AddBuildTags(buildID string, tags []string) error

+ func (c *Client) AddProjectToPool(poolID int, projectID string) error

+ func (c *Client) ApproveQueuedBuild(buildID string) error

+ func (c *Client) AuthorizeAgent(id int, authorized bool) error

+ func (c *Client) BuildTypeExists(id string) bool

+ func (c *Client) CancelBuild(buildID string, comment string) error

+ func (c *Client) CheckVersion() error

+ func (c *Client) CreateAPIToken(name string) (*Token, error)

+ func (c *Client) CreateBuildStep(buildTypeID string, step BuildStep) error

+ func (c *Client) CreateBuildType(projectID string, req CreateBuildTypeRequest) (*BuildType, error)

+ func (c *Client) CreateProject(req CreateProjectRequest) (*Project, error)

+ func (c *Client) CreateSecureToken(projectID, value string) (string, error)

+ func (c *Client) CreateUser(req CreateUserRequest) (*User, error)

+ func (c *Client) DeleteAPIToken(name string) error

+ func (c *Client) DeleteBuildComment(buildID string) error

+ func (c *Client) DeleteBuildTypeParameter(buildTypeID, name string) error

+ func (c *Client) DeleteProjectParameter(projectID, name string) error

+ func (c *Client) DownloadArtifact(buildID, artifactPath string) ([]byte, error)

+ func (c *Client) DownloadArtifactTo(ctx context.Context, buildID, artifactPath string, w io.Writer) (int64, error)

+ func (c *Client) EnableAgent(id int, enabled bool) error

+ func (c *Client) ExportProjectSettings(projectID, format string, useRelativeIds bool) ([]byte, error)

+ func (c *Client) GetAgent(id int) (*Agent, error)

+ func (c *Client) GetAgentByName(name string) (*Agent, error)

+ func (c *Client) GetAgentCompatibleBuildTypes(id int) (*BuildTypeList, error)

+ func (c *Client) GetAgentIncompatibleBuildTypes(id int) (*CompatibilityList, error)

+ func (c *Client) GetAgentPool(id int) (*Pool, error)

+ func (c *Client) GetAgentPools(requestedFields []string) (*PoolList, error)

+ func (c *Client) GetAgents(opts AgentsOptions) (*AgentList, error)

+ func (c *Client) GetArtifacts(buildID string, subpath string) (*Artifacts, error)

+ func (c *Client) GetBuild(ref string) (*Build, error)

+ func (c *Client) GetBuildChanges(buildID string) (*ChangeList, error)

+ func (c *Client) GetBuildComment(buildID string) (string, error)

+ func (c *Client) GetBuildLog(buildID string) (string, error)

+ func (c *Client) GetBuildProblems(buildID string) (*ProblemOccurrences, error)

+ func (c *Client) GetBuildQueue(opts QueueOptions) (*BuildQueue, error)

+ func (c *Client) GetBuildTags(buildID string) (*TagList, error)

+ func (c *Client) GetBuildTests(buildID string, failedOnly bool, limit int) (*TestOccurrences, error)

+ func (c *Client) GetBuildType(id string) (*BuildType, error)

+ func (c *Client) GetBuildTypeParameter(buildTypeID, name string) (*Parameter, error)

+ func (c *Client) GetBuildTypeParameters(buildTypeID string) (*ParameterList, error)

+ func (c *Client) GetBuildTypes(opts BuildTypesOptions) (*BuildTypeList, error)

+ func (c *Client) GetBuilds(opts BuildsOptions) (*BuildList, error)

+ func (c *Client) GetCurrentUser() (*User, error)

+ func (c *Client) GetParameterValue(path string) (string, error)

+ func (c *Client) GetProject(id string) (*Project, error)

+ func (c *Client) GetProjectParameter(projectID, name string) (*Parameter, error)

+ func (c *Client) GetProjectParameters(projectID string) (*ParameterList, error)

+ func (c *Client) GetProjects(opts ProjectsOptions) (*ProjectList, error)

+ func (c *Client) GetQueuedBuildApprovalInfo(buildID string) (*ApprovalInfo, error)

+ func (c *Client) GetSecureValue(projectID, token string) (string, error)

+ func (c *Client) GetServer() (*Server, error)

+ func (c *Client) GetUser(username string) (*User, error)

+ func (c *Client) GetVcsRootEntries(buildTypeID string) (*VcsRootEntries, error)

+ func (c *Client) GetVersionedSettingsConfig(projectID string) (*VersionedSettingsConfig, error)

+ func (c *Client) GetVersionedSettingsStatus(projectID string) (*VersionedSettingsStatus, error)

+ func (c *Client) MoveQueuedBuildToTop(buildID string) error

+ func (c *Client) PinBuild(buildID string, comment string) error

+ func (c *Client) ProjectExists(id string) bool

+ func (c *Client) RawRequest(method, path string, body io.Reader, headers map[string]string) (*RawResponse, error)

+ func (c *Client) RebootAgent(ctx context.Context, id int, afterBuild bool) error

+ func (c *Client) RemoveBuildTag(buildID string, tag string) error

+ func (c *Client) RemoveFromQueue(id string) error

+ func (c *Client) RemoveProjectFromPool(poolID int, projectID string) error

+ func (c *Client) ResolveBuildID(ref string) (string, error)

+ func (c *Client) RunBuild(buildTypeID string, opts RunBuildOptions) (*Build, error)

+ func (c *Client) ServerVersion() (*Server, error)

+ func (c *Client) SetAgentPool(agentID int, poolID int) error

+ func (c *Client) SetBuildComment(buildID string, comment string) error

+ func (c *Client) SetBuildTypeParameter(buildTypeID, name, value string, secure bool) error

+ func (c *Client) SetBuildTypePaused(id string, paused bool) error

+ func (c *Client) SetBuildTypeSetting(buildTypeID, setting, value string) error

+ func (c *Client) SetProjectParameter(projectID, name, value string, secure bool) error

+ func (c *Client) SetQueuedBuildPosition(buildID string, position int) error

+ func (c *Client) SupportsFeature(feature string) bool

+ func (c *Client) UnpinBuild(buildID string) error

+ func (c *Client) UploadDiffChanges(patch []byte, description string) (string, error)

+ func (c *Client) UserExists(username string) bool

+ type ClientInterface interface

+ AddBuildTags func(buildID string, tags []string) error

+ AddProjectToPool func(poolID int, projectID string) error

+ ApproveQueuedBuild func(buildID string) error

+ AuthorizeAgent func(id int, authorized bool) error

+ BuildTypeExists func(id string) bool

+ CancelBuild func(buildID string, comment string) error

+ CheckVersion func() error

+ CreateAPIToken func(name string) (*Token, error)

+ CreateBuildStep func(buildTypeID string, step BuildStep) error

+ CreateBuildType func(projectID string, req CreateBuildTypeRequest) (*BuildType, error)

+ CreateProject func(req CreateProjectRequest) (*Project, error)

+ CreateSecureToken func(projectID, value string) (string, error)

+ CreateUser func(req CreateUserRequest) (*User, error)

+ DeleteAPIToken func(name string) error

+ DeleteBuildComment func(buildID string) error

+ DeleteBuildTypeParameter func(buildTypeID, name string) error

+ DeleteProjectParameter func(projectID, name string) error

+ DownloadArtifact func(buildID, artifactPath string) ([]byte, error)

+ DownloadArtifactTo func(ctx context.Context, buildID, artifactPath string, w io.Writer) (int64, error)

+ EnableAgent func(id int, enabled bool) error

+ ExportProjectSettings func(projectID, format string, useRelativeIds bool) ([]byte, error)

+ GetAgent func(id int) (*Agent, error)

+ GetAgentByName func(name string) (*Agent, error)

+ GetAgentCompatibleBuildTypes func(id int) (*BuildTypeList, error)

+ GetAgentIncompatibleBuildTypes func(id int) (*CompatibilityList, error)

+ GetAgentPool func(id int) (*Pool, error)

+ GetAgentPools func(fields []string) (*PoolList, error)

+ GetAgents func(opts AgentsOptions) (*AgentList, error)

+ GetArtifacts func(buildID string, path string) (*Artifacts, error)

+ GetBuild func(ref string) (*Build, error)

+ GetBuildChanges func(buildID string) (*ChangeList, error)

+ GetBuildComment func(buildID string) (string, error)

+ GetBuildLog func(buildID string) (string, error)

+ GetBuildProblems func(buildID string) (*ProblemOccurrences, error)

+ GetBuildQueue func(opts QueueOptions) (*BuildQueue, error)

+ GetBuildTags func(buildID string) (*TagList, error)

+ GetBuildTests func(buildID string, failedOnly bool, limit int) (*TestOccurrences, error)

+ GetBuildType func(id string) (*BuildType, error)

+ GetBuildTypeParameter func(buildTypeID, name string) (*Parameter, error)

+ GetBuildTypeParameters func(buildTypeID string) (*ParameterList, error)

+ GetBuildTypes func(opts BuildTypesOptions) (*BuildTypeList, error)

+ GetBuilds func(opts BuildsOptions) (*BuildList, error)

+ GetCurrentUser func() (*User, error)

+ GetParameterValue func(path string) (string, error)

+ GetProject func(id string) (*Project, error)

+ GetProjectParameter func(projectID, name string) (*Parameter, error)

+ GetProjectParameters func(projectID string) (*ParameterList, error)

+ GetProjects func(opts ProjectsOptions) (*ProjectList, error)

+ GetQueuedBuildApprovalInfo func(buildID string) (*ApprovalInfo, error)

+ GetSecureValue func(projectID, token string) (string, error)

+ GetServer func() (*Server, error)

+ GetUser func(username string) (*User, error)

+ GetVcsRootEntries func(buildTypeID string) (*VcsRootEntries, error)

+ GetVersionedSettingsConfig func(projectID string) (*VersionedSettingsConfig, error)

+ GetVersionedSettingsStatus func(projectID string) (*VersionedSettingsStatus, error)

+ MoveQueuedBuildToTop func(buildID string) error

+ PinBuild func(buildID string, comment string) error

+ ProjectExists func(id string) bool

+ RawRequest func(method, path string, body io.Reader, headers map[string]string) (*RawResponse, error)

+ RebootAgent func(ctx context.Context, id int, afterBuild bool) error

+ RemoveBuildTag func(buildID string, tag string) error

+ RemoveFromQueue func(id string) error

+ RemoveProjectFromPool func(poolID int, projectID string) error

+ ResolveBuildID func(ref string) (string, error)

+ RunBuild func(buildTypeID string, opts RunBuildOptions) (*Build, error)

+ ServerVersion func() (*Server, error)

+ SetAgentPool func(agentID int, poolID int) error

+ SetBuildComment func(buildID string, comment string) error

+ SetBuildTypeParameter func(buildTypeID, name, value string, secure bool) error

+ SetBuildTypePaused func(id string, paused bool) error

+ SetBuildTypeSetting func(buildTypeID, setting, value string) error

+ SetProjectParameter func(projectID, name, value string, secure bool) error

+ SetQueuedBuildPosition func(buildID string, position int) error

+ SupportsFeature func(feature string) bool

+ UnpinBuild func(buildID string) error

+ UploadDiffChanges func(patch []byte, description string) (string, error)

+ UserExists func(username string) bool

+ type ClientOption func(*Client)

+ func WithAPIVersion(version string) ClientOption

+ func WithDebugFunc(f func(format string, args ...any)) ClientOption

+ func WithTimeout(timeout time.Duration) ClientOption

+ type Compatibility struct

+ Agent *Agent

+ BuildType *BuildType

+ Compatible bool

+ Reasons *IncompatibleReasons

+ type CompatibilityList struct

+ Compatibility []Compatibility

+ Count int

+ type Content struct

+ Href string

+ type CreateBuildTypeRequest struct

+ ID string

+ Name string

+ type CreateProjectRequest struct

+ ID string

+ Name string

+ ParentProjectID string

+ type CreateUserRequest struct

+ Email string

+ Name string

+ Password string

+ Roles RoleList

+ Username string

+ type FieldSpec struct

+ Available []string

+ Default []string

+ func (fs *FieldSpec) Help() string

+ func (fs *FieldSpec) ParseFields(input string) ([]string, error)

+ type FileChange struct

+ ChangeType string

+ File string

+ type Files struct

+ File []FileChange

+ type IncompatibleReasons struct

+ Reasons []string

+ type LastChanges struct

+ Change []PersonalChange

+ type Locator struct

+ func NewLocator() *Locator

+ func (l *Locator) Add(key, value string) *Locator

+ func (l *Locator) AddInt(key string, value int) *Locator

+ func (l *Locator) AddIntDefault(key string, value, defaultVal int) *Locator

+ func (l *Locator) AddRaw(key, value string) *Locator

+ func (l *Locator) AddUpper(key, value string) *Locator

+ func (l *Locator) Encode() string

+ func (l *Locator) IsEmpty() bool

+ func (l *Locator) String() string

+ type NetworkError struct

+ Cause error

+ URL string

+ func (e *NetworkError) Error() string

+ func (e *NetworkError) Unwrap() error

+ type NotFoundError struct

+ ID string

+ Message string

+ Resource string

+ func (e *NotFoundError) Error() string

+ type Parameter struct

+ Name string

+ Type *ParameterType

+ Value string

+ type ParameterList struct

+ Count int

+ Property []Parameter

+ type ParameterType struct

+ RawValue string

+ type PermissionError struct

+ Action string

+ func (e *PermissionError) Error() string

+ type PersonalChange struct

+ ID string

+ Personal bool

+ type Pool struct

+ Agents *AgentList

+ Href string

+ ID int

+ MaxAgents int

+ Name string

+ Projects *ProjectList

+ type PoolList struct

+ Count int

+ Pools []Pool

+ type ProblemOccurrence struct

+ Details string

+ ID string

+ Identity string

+ Type string

+ type ProblemOccurrences struct

+ Count int

+ ProblemOccurrence []ProblemOccurrence

+ type Project struct

+ Description string

+ Href string

+ ID string

+ Name string

+ ParentProjectID string

+ WebURL string

+ type ProjectList struct

+ Count int

+ Projects []Project

+ type ProjectsOptions struct

+ Fields []string

+ Limit int

+ Parent string

+ type Property struct

+ Name string

+ Value string

+ type PropertyList struct

+ Property []Property

+ type QueueOptions struct

+ BuildTypeID string

+ Fields []string

+ Limit int

+ type QueuedBuild struct

+ BranchName string

+ BuildType *BuildType

+ BuildTypeID string

+ Href string

+ ID int

+ QueuedDate string

+ State string

+ Triggered *Triggered

+ WebURL string

+ type RawResponse struct

+ Body []byte

+ Headers http.Header

+ StatusCode int

+ type RetryConfig struct

+ Interval time.Duration

+ MaxRetries uint64

+ type Revision struct

+ VcsBranchName string

+ VcsRootInstance *VcsRootInstanceRef

+ Version string

+ type Revisions struct

+ Revision []Revision

+ type Role struct

+ RoleID string

+ Scope string

+ type RoleList struct

+ Role []Role

+ type RunBuildOptions struct

+ AgentID int

+ Branch string

+ CleanSources bool

+ Comment string

+ EnvVars map[string]string

+ Params map[string]string

+ Personal bool

+ PersonalChangeID string

+ QueueAtTop bool

+ RebuildDependencies bool

+ RebuildFailedDependencies bool

+ Revision string

+ SystemProps map[string]string

+ Tags []string

+ type Server struct

+ BuildNumber string

+ Version string

+ VersionMajor int

+ VersionMinor int

+ WebURL string

+ type Tag struct

+ Name string

+ type TagList struct

+ Tag []Tag

+ type TestOccurrence struct

+ Details string

+ Duration int

+ Href string

+ ID string

+ Ignored bool

+ Name string

+ Status string

+ type TestOccurrences struct

+ Count int

+ Failed int

+ Ignored int

+ Passed int

+ TestOccurrence []TestOccurrence

+ type Token struct

+ Name string

+ Value string

+ type TriggerBuildRequest struct

+ Agent *AgentRef

+ BranchName string

+ BuildType BuildTypeRef

+ Comment *BuildComment

+ LastChanges *LastChanges

+ Personal bool

+ Properties *PropertyList

+ Revisions *Revisions

+ Tags *TagList

+ TriggeringOptions *TriggeringOptions

+ type Triggered struct

+ Date string

+ Type string

+ User *User

+ type TriggeringOptions struct

+ CleanSources bool

+ QueueAtTop bool

+ RebuildAllDependencies bool

+ RebuildFailedOrIncomplete bool

+ type User struct

+ Email string

+ Href string

+ ID int

+ Name string

+ Username string

+ type VcsRootEntries struct

+ Count int

+ VcsRootEntry []VcsRootEntry

+ type VcsRootEntry struct

+ ID string

+ VcsRoot *VcsRootRef

+ type VcsRootInstanceRef struct

+ VcsRootID string

+ type VcsRootRef struct

+ ID string

+ Name string

+ type VersionedSettingsConfig struct

+ AllowUIEditing bool

+ BuildSettingsMode string

+ Format string

+ SettingsPath string

+ ShowSettingsChanges bool

+ SynchronizationMode string

+ VcsRootID string

+ type VersionedSettingsStatus struct

+ DslOutdated bool

+ Message string

+ Timestamp string

+ Type string

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