# Functions
CheckResponse asserts that the http response status code was 2xx.
ConfigFilePath specifies the default path to a config file.
Int returns a pointer to the int value passed in.
LoadConfigByName loads configurations from yaml at the default file location.
LoadConfigFromFile on disk and return it as a Configuration item.
NewClient creates a new client based on the provided configuration payload, and optionally a custom httpClient to allow overriding of http client structures.
NewPropertiesFrame generate a new data frame for properties on a gocd job.
SetupLogging based on Environment Variables
Set Logging level with $GOCD_LOG_LEVEL Allowed Values: - DEBUG - INFO - WARNING - ERROR - FATAL - PANIC
Set Logging type with $GOCD_LOG_TYPE Allowed Values: - JSON - TEXT.
String returns a pointer to the string value passed in.
# Constants
ConfigDirectoryPath is the default location of the `.gocdconf` configuration file.
Environment variables for configuration.
Environment variables for configuration.
Environment variables for configuration.
Environment variables for configuration.
Environment variables for configuration.
JobStateTransitionPassed "Passed".
JobStateTransitionScheduled "Scheduled".
Set logging level and type constants.
Set logging level and type constants.
Set logging level and type constants.
Set logging level and type constants.
# Structs
Agent represents agent in GoCD codebeat:disable[TOO_MANY_IVARS].
AgentBulkOperationsUpdate describes the structure for a single Operation in AgentBulkUpdate the PUT payload when updating multiple agents.
AgentBulkOperationUpdate describes an action to be performed on an Environment or Resource during an agent update.
AgentBulkUpdate describes the structure for the PUT payload when updating multiple agents.
AgentsResponse describes the structure of the API response when listing collections of agent objects.
APIClientRequest helper struct to reduce amount of code.
APIRequest encapsulates the net/http.Request object, and a string representing the Body.
APIResponse encapsulates the net/http.Response object, a string representing the Body, and a gocd.Request object encapsulating the response from the API.
Approval represents a request/response object describing the approval configuration for a GoCD Job.
Artifact describes the result of a job.
Auth structure wrapping the Username and Password variables, which are used to get an Auth cookie header used for subsequent requests.
Authorization describes the access control for a "manual" approval type.
BuildCause describes the triggers which caused the build to start.
BuildDetails describes the builds being performed on this agent.
CipherText sescribes the response from the api with an encrypted value.
Client struct which acts as an interface to the GoCD Server.
ClientParameters describe how the client interacts with the GoCD Server.
ConfigApproval part of cruise-control.xml.
ConfigArtifact part of cruise-control.xml.
ConfigAuthConfig part of cruise-control.xml.
ConfigElastic part of cruise-control.xml.
ConfigElasticProfile part of cruise-control.xml.
ConfigEnvironmentVariable part of cruise-control.xml.
ConfigFilter part of cruise-control.xml.
ConfigJob part of cruise-control.xml.
ConfigMaterialRepository part of cruise-control.xml.
ConfigPackage part of cruise-control.xml.
ConfigParam part of cruise-control.xml.
ConfigPipeline part of cruise-control.xml.
ConfigPipelineGroup contains a single pipeline groups.
ConfigPluginConfiguration part of cruise-control.xml.
ConfigProperty part of cruise-control.xml.
ConfigRepo represents a config repo object in GoCD.
ConfigRepoProperty represents a configuration related to a ConfigRepo.
ConfigRepository part of cruise-control.xml.
ConfigRepositoryGit part of cruise-control.xml.
ConfigReposListResponse describes the structure of the API response when listing collections of ConfigRepo objects.
ConfigRole part of cruise-control.xml.
ConfigSCM part of cruise-control.xml.
ConfigSecurity part of cruise-control.xml.
ConfigServer part of cruise-control.xml.
ConfigStage part of cruise-control.xml.
ConfigTask part of cruise-control.xml.
ConfigTaskRunIf part of cruise-control.xml.
ConfigTasks part of cruise-control.xml.
Configuration describes a single connection to a GoCD server.
ConfigXML part of cruise-control.xml.
EmbeddedEnvironments encapsulates the environment struct.
Environment describes a group of pipelines and agents.
EnvironmentPatchRequest describes the actions to perform on an environment.
EnvironmentsResponse describes the response obejct for a plugin API call.
EnvironmentVariable describes an environment variable key/pair.
EnvironmentVariablesAction describes a collection of Environment Variables to add or remove.
ExtensionCapabilities describes the enhancements that the plugin provides.
ExtensionSettings describes the html view for the plugin and the list of properties required to be configured on a plugin.
GitRepositoryMaterial part of cruise-control.xml.
HALLink describes a HAL link.
HALLinks describes a collection of HALLinks.
Job describes a job which can be performed in GoCD codebeat:disable[TOO_MANY_IVARS].
JobProperty describes the property for a job.
JobRunHistoryResponse describes the api response from.
JobSchedule describes the event causes for a job.
JobScheduleEnvVar describes the environmnet variables for a job schedule.
JobScheduleLink describes the HAL links for a job schedule.
JobScheduleResponse contains a collection of jobs.
JobStateTransition describes a State Transition object in a GoCD api response.
MailHost part of cruise-control.xml.
Material describes an artifact dependency for a pipeline object.
MaterialAttributesDependency describes a Pipeline dependency material.
MaterialAttributesGit describes a git material codebeat:disable[TOO_MANY_IVARS].
MaterialAttributesHg describes a Mercurial material type.
MaterialAttributesP4 describes a Perforce material type codebeat:disable[TOO_MANY_IVARS].
MaterialAttributesPackage describes a package reference.
MaterialAttributesPlugin describes a plugin material.
MaterialAttributesSvn describes a material type codebeat:disable[TOO_MANY_IVARS].
MaterialAttributesTfs describes a Team Foundation Server material codebeat:disable[TOO_MANY_IVARS].
MaterialFilter describes which globs to ignore.
MaterialRevision describes the uniquely identifiable version for the material which was pulled for this build.
Modification describes the commit/revision for the material which kicked off the build.
PaginationResponse is a struct used to handle paging through resposnes.
Parameter represents a key/value.
PasswordFilePath describes the location to set of user/passwords on disk.
PatchStringAction describes a collection of resources to add or remove.
Pipeline describes a pipeline object codebeat:disable[TOO_MANY_IVARS].
PipelineConfigOrigin describes where a pipeline config is being loaded from.
PipelineConfigRequest describes a request object for creating or updating pipelines.
PipelineGroup describes a pipeline group API response.
PipelineHistory describes the history of runs for a pipeline.
PipelineInstance describes a single pipeline run codebeat:disable[TOO_MANY_IVARS].
PipelineMaterial part of cruise-control.xml.
PipelineRequest describes a pipeline request object.
PipelineStatus describes whether a pipeline can be run or scheduled.
PipelineTemplate describes a response from the API for a pipeline template object.
PipelineTemplateRequest describes a PipelineTemplate.
PipelineTemplateResponse describes an api response for a single pipeline templates.
PipelineTemplatesResponse describes an api response for multiple pipeline templates.
PluggableInstanceSettings describes plugin configuration.
Plugin describes a single plugin resource.
PluginAbout provides additional details about the plugin.
PluginConfiguration describes the configuration related to a plugin extension.
PluginConfigurationKVPair describes a key/value pair of plugin configurations.
No description provided by the author
PluginExtension describes the different extensions available for a plugin.
PluginExtensionInfo describes the extension info for the plugin API v3 only (GoCD >= 17.9.0 to < 18.3.0).
PluginIcon describes the content type of the plugin icon and the base-64 encoded byte array of the byte-sequence that composes the image.
PluginsResponse describes the response obejct for a plugin API call.
PluginStatus describes the status of a plugin.
PluginVendor describes the author of a plugin.
PluginView describes any view attached to a plugin.
Properties describes a properties resource in the GoCD API.
PropertyCreateResponse handles the parsing of the response when creating a property.
PropertyRequest describes the parameters to be submitted when calling/creating properties.
Role represents a type of agent/actor who can access resources perform operations.
RoleAttributeProperties describes properties attached to a role.
RoleAttributesGoCD are attributes describing a role, in this cae, which users are present in the role.
RoleListWrapper describes a container for the result of a role list operation.
ScheduleMaterial describes a material that must be used to trigger a new instance of the pipeline.
ScheduleRequestBody describes properties to trigger a new instance of the pipeline.
ServerVersion of the GoCD installation.
Stage represents a GoCD Stage object.
StageInstance represents the stage from the result from a pipeline run codebeat:disable[TOO_MANY_IVARS].
StringResponse handles the unmarshaling of the single string response from DELETE requests.
Tab description in a gocd job.
Task Describes a Task object in the GoCD api.
TaskAttributes describes all the properties for a Task.
TaskPluginConfiguration is for specifying options for pluggable task.
Timer describes the cron-like schedule to build a pipeline.
TrackingTool describes the type of a tracking tool and its attributes.
TrackingToolAttributes describes the attributes of a tracking tool.
Version part of cruise-control.xml.
# Interfaces
HALContainer represents objects with HAL _link and _embedded resources.
MaterialAttribute describes the behaviour of the GoCD material structures for a pipeline.
StageContainer describes structs which contain stages, eg Pipelines and PipelineTemplates.
Versioned describes resources which can get and set versions.
# Type aliases
AgentsService describes actions which can be performed on agents.
ConfigRepoService allows admin users to define and manage config repos using which pipelines defined in external repositories can be included in GoCD, thereby allowing users to have their Pipeline as code.
ConfigurationService describes the HAL _link resource for the api response object for a pipelineconfig.
EncryptionService describes the HAL _link resource for the api response object for a pipelineconfig.
EnvironmentsService exposes calls for interacting with Environment objects in the GoCD API.
JobsService describes actions which can be performed on jobs.
PipelineConfigsService describes the HAL _link resource for the api response object for a pipelineconfig.
PipelineGroups represents a collection of pipeline groups.
PipelineGroupsService describes the HAL _link resource for the api response object for a pipeline group response.
PipelinesService describes the HAL _link resource for the api response object for a pipelineconfig.
PipelineTemplatesService describes the HAL _link resource for the api response object for a pipeline configuration objects.
PluginsService exposes calls for interacting with Plugin objects in the GoCD API.
PropertiesService describes Actions which can be performed on agents.
RoleService describes Actions which can be performed on roles.
ServerVersionService exposes calls for interacting with ServerVersion objects in the GoCD API.
StagesService exposes calls for interacting with Stage objects in the GoCD API.
TimeoutField helps manage the marshalling of the timoeut field which can be both "never" and an integer.