Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

setCIBuildDetail

Back to index

Summary

This command is a wrapper for the create/modifyCIBuildDetail API. It abstracts the logic for whether the build data needs to be created or, if it already exists, updated.
projectName
Stringrequired
The name for the project that must be unique among all projects.
ciBuildDetailName
Stringrequired
The name of the CI build detail.
buildData
Stringoptional
The build data from a CI system in JSON format.
buildTriggerSource
Stringoptional
The source of the build trigger.
Possible values: "CD", "CI", "Flow"
ciBuildAssociationType
Stringoptional
Represents how a CI build is associated with flow.
Possible values: "attached", "triggeredByCD", "triggeredByCI", "triggeredByFlow"
clearFlowRuntimes
Booleanoptional
True to clear references to all pipeline runs.
clearReleases
Booleanoptional
True to clear references to all releases.
flowRuntimeId
UUIDoptional
The ID of the flow runtime the CI build should be associated with.
flowRuntimeStateId
UUIDoptional
The ID of the flow runtime state that triggered the CI build.
releaseName
Stringoptional
The name of the release that the CI build should be associated with.
releaseProjectName
Stringoptional
The name of the project that contains the release the CI build should be associated with.
stageName
Stringoptional
The name of the stage that contains the task which triggered the CI build.
waitingForInput
Booleanoptional
True if the CI build is waiting for user input.

Usage

Perl

$cmdr->setCIBuildDetail(
  "test-projectName", # projectName
  "test-ciBuildDetailName" # ciBuildDetailName
  # optionals
);
▼

ectool

ectool setCIBuildDetail \
  "test-projectName" `# projectName` \
  "test-ciBuildDetailName" `# ciBuildDetailName` \
  # optionals
▼

Examples

Perl

$cmdr->setCIBuildDetail
  (
    projectName => "Test",
    ciBuildDetailName => "test_ci_build",
    flowRuntimeId => "e9bebbe3-c087-11e9-8bf5-001c42c3ce23",
    buildData => "<json-formatted CI build data>",
    buildTriggerSource => "CI",
    ciBuildAssociationType => `triggeredByCI`
  );
▼

ectool

ectool setCIBuildDetail 'Test' 'test_ci_build'
  --buildTriggerSource 'CI'
  --flowRuntimeId 'e9bebbe3-c087-11e9-8bf5-001c42c3ce23'
  --buildData '{<json-formatted CI build data>}'
  --buildTriggerSource 'CI'
  --ciBuildAssociationType 'triggeredByCI'
▼