/**
* (C) Copyright IBM Corp. 2026.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { IncomingHttpHeaders, OutgoingHttpHeaders } from 'http';
import { AbortSignal, BaseService, UserOptions } from 'ibm-cloud-sdk-core';
/**
* Continuous Delivery Tekton pipeline API definition
Maximum request payload size is 512 KB
All calls
* require an Authorization HTTP header.
The following header is the accepted authentication
* mechanism and required credentials for each - Bearer: an IBM Cloud IAM token (authorized for all
* endpoints)
*
* API Version: 2.0.0
*/
declare class CdTektonPipelineV2 extends BaseService {
static DEFAULT_SERVICE_URL: string;
static DEFAULT_SERVICE_NAME: string;
private static _regionalEndpoints;
/**
* Returns the service URL associated with the specified region.
* @param region a string representing the region
* @returns the service URL associated with the specified region or undefined
* if no mapping for the region exists
*/
static getServiceUrlForRegion(region: string): string;
/*************************
* Factory method
************************/
/**
* Constructs an instance of CdTektonPipelineV2 with passed in options and external configuration.
*
* @param {UserOptions} [options] - The parameters to send to the service.
* @param {string} [options.serviceName] - The name of the service to configure
* @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate requests to the service
* @param {string} [options.serviceUrl] - The base URL for the service
* @returns {CdTektonPipelineV2}
*/
static newInstance(options: UserOptions): CdTektonPipelineV2;
/**
* Construct a CdTektonPipelineV2 object.
*
* @param {Object} options - Options for the service.
* @param {string} [options.serviceUrl] - The base URL for the service
* @param {OutgoingHttpHeaders} [options.headers] - Default headers that shall be included with every request to the service.
* @param {Authenticator} options.authenticator - The Authenticator object used to authenticate requests to the service
* @constructor
* @returns {CdTektonPipelineV2}
*/
constructor(options: UserOptions);
/*************************
* pipeline
************************/
/**
* Create Tekton pipeline.
*
* This request creates a Tekton pipeline. Requires a pipeline tool already created in the toolchain using the
* toolchain API https://cloud.ibm.com/apidocs/toolchain#create-tool, and use the tool ID to create the Tekton
* pipeline.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - The ID for the associated pipeline tool, which was already created in the target
* toolchain. To get the pipeline ID call the toolchain API https://cloud.ibm.com/apidocs/toolchain#list-tools and
* find the pipeline tool.
* @param {number} [params.nextBuildNumber] - Specify the build number that will be used for the next pipeline run.
* Build numbers can be any positive whole number between 0 and 100000000000000.
* @param {boolean} [params.enableNotifications] - Flag to enable notifications for this pipeline. If enabled, the
* Tekton pipeline run events will be published to all the destinations specified by the Slack and Event Notifications
* integrations in the parent toolchain.
* @param {boolean} [params.enablePartialCloning] - Flag to enable partial cloning for this pipeline. When partial
* clone is enabled, only the files contained within the paths specified in definition repositories are read and
* cloned, this means that symbolic links might not work.
* @param {WorkerIdentity} [params.worker] - Specify the worker that is to be used to run the trigger, indicated by a
* worker object with only the worker ID. If not specified or set as `worker: { id: 'public' }`, the IBM Managed
* shared workers are used.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createTektonPipeline(params: CdTektonPipelineV2.CreateTektonPipelineParams): Promise>;
/**
* Get Tekton pipeline data.
*
* This request retrieves the Tekton pipeline data for the pipeline identified by `{id}`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - ID of current instance.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getTektonPipeline(params: CdTektonPipelineV2.GetTektonPipelineParams): Promise>;
/**
* Update Tekton pipeline data.
*
* This request updates Tekton pipeline data, such as the worker ID or build number, for example. Use other endpoints
* such as /definitions, /triggers, and /properties for other configuration updates.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - ID of current instance.
* @param {number} [params.nextBuildNumber] - Specify the build number that will be used for the next pipeline run.
* Build numbers can be any positive whole number between 0 and 100000000000000.
* @param {boolean} [params.enableNotifications] - Flag to enable notifications for this pipeline. If enabled, the
* Tekton pipeline run events will be published to all the destinations specified by the Slack and Event Notifications
* integrations in the parent toolchain.
* @param {boolean} [params.enablePartialCloning] - Flag to enable partial cloning for this pipeline. When partial
* clone is enabled, only the files contained within the paths specified in definition repositories are read and
* cloned, this means that symbolic links might not work.
* @param {WorkerIdentity} [params.worker] - Specify the worker that is to be used to run the trigger, indicated by a
* worker object with only the worker ID. If not specified or set as `worker: { id: 'public' }`, the IBM Managed
* shared workers are used.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateTektonPipeline(params: CdTektonPipelineV2.UpdateTektonPipelineParams): Promise>;
/**
* Delete a Tekton pipeline instance.
*
* This request deletes the Tekton pipeline instance that is associated with the pipeline toolchain integration.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.id - ID of current instance.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteTektonPipeline(params: CdTektonPipelineV2.DeleteTektonPipelineParams): Promise>;
/*************************
* pipelineRuns
************************/
/**
* List pipeline run records.
*
* This request lists pipeline run records, which have data about the runs, such as status, user_info, trigger and
* other information. Default limit is 50.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} [params.start] - A page token that identifies the start point of the list of pipeline runs. This
* value is included in the response body of each request to fetch pipeline runs.
* @param {number} [params.limit] - The number of pipeline runs to return, sorted by creation time, most recent first.
* @param {string} [params.status] - Filters the collection to resources with the specified status.
* @param {string} [params.triggerName] - Filters the collection to resources with the specified trigger name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listTektonPipelineRuns(params: CdTektonPipelineV2.ListTektonPipelineRunsParams): Promise>;
/**
* Trigger a pipeline run.
*
* Trigger a new pipeline run using either the manual or the timed trigger, specifying the additional properties or
* overriding existing ones as needed.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} [params.description] - Optional description for the created PipelineRun.
* @param {string} [params.triggerName] - Trigger name.
* @param {JsonObject} [params.triggerProperties] - An object containing string values only. It provides additional
* 'text' properties or overrides existing pipeline/trigger properties that can be used in the created run.
* @param {JsonObject} [params.secureTriggerProperties] - An object containing string values only. It provides
* additional `secure` properties or overrides existing `secure` pipeline/trigger properties that can be used in the
* created run.
* @param {JsonObject} [params.triggerHeaders] - An object containing string values only that provides the request
* headers. Use `$(header.header_key_name)` to access it in a TriggerBinding. Most commonly used as part of a Generic
* Webhook to provide a verification token or signature in the request headers.
* @param {JsonObject} [params.triggerBody] - An object that provides the request body. Use `$(body.body_key_name)` to
* access it in a TriggerBinding. Most commonly used to pass in additional properties or override properties for the
* pipeline run that is created.
* @param {PipelineRunTrigger} [params.trigger] - Trigger details passed when triggering a Tekton pipeline run.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createTektonPipelineRun(params: CdTektonPipelineV2.CreateTektonPipelineRunParams): Promise>;
/**
* Get a pipeline run record.
*
* This request retrieves details of the pipeline run identified by `{id}`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.id - ID of current instance.
* @param {string} [params.includes] - Defines if response includes definition metadata.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getTektonPipelineRun(params: CdTektonPipelineV2.GetTektonPipelineRunParams): Promise>;
/**
* Delete a pipeline run record.
*
* This request deletes the pipeline run record identified by `{id}`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.id - ID of current instance.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteTektonPipelineRun(params: CdTektonPipelineV2.DeleteTektonPipelineRunParams): Promise>;
/**
* Cancel a pipeline run.
*
* This request cancels a running pipeline run identified by `{id}`. Use `force: true` in the body if the pipeline run
* can't be cancelled normally.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.id - ID of current instance.
* @param {boolean} [params.force] - Flag indicating whether the pipeline cancellation action is forced or not.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
cancelTektonPipelineRun(params: CdTektonPipelineV2.CancelTektonPipelineRunParams): Promise>;
/**
* Rerun a pipeline run.
*
* This request reruns a past pipeline run, which is identified by `{id}`, with the same data. Request body isn't
* allowed.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.id - ID of current instance.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
rerunTektonPipelineRun(params: CdTektonPipelineV2.RerunTektonPipelineRunParams): Promise>;
/**
* Get a list of pipeline run log objects.
*
* This request fetches a list of log data for a pipeline run identified by `{id}`. The `href` in each log entry can
* be used to fetch that individual log.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.id - ID of current instance.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getTektonPipelineRunLogs(params: CdTektonPipelineV2.GetTektonPipelineRunLogsParams): Promise>;
/**
* Get the log content of a pipeline run step.
*
* This request retrieves the log content of a pipeline run step, where the step is identified by `{id}`. To get the
* log ID use the endpoint `/tekton_pipelines/{pipeline_id}/pipeline_runs/{id}/logs`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.pipelineRunId - The Tekton pipeline run ID.
* @param {string} params.id - ID of current instance.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getTektonPipelineRunLogContent(params: CdTektonPipelineV2.GetTektonPipelineRunLogContentParams): Promise>;
/*************************
* definitions
************************/
/**
* List pipeline definitions.
*
* This request fetches pipeline definitions, which is a collection of individual definition entries. Each entry
* consists of a repository url, a repository path and a branch or tag. The referenced repository URL must match the
* URL of a repository tool integration in the parent toolchain. Obtain the list of integrations from the toolchain
* API https://cloud.ibm.com/apidocs/toolchain#list-tools. The branch or tag of the definition must match against a
* corresponding branch or tag in the chosen repository, and the path must match a subfolder in the repository.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listTektonPipelineDefinitions(params: CdTektonPipelineV2.ListTektonPipelineDefinitionsParams): Promise>;
/**
* Create a single definition.
*
* This request adds a single definition. The source properties should consist of a repository url, a repository path
* and a branch or tag. The referenced repository URL must match the URL of a repository tool integration in the
* parent toolchain. Obtain the list of integrations from the toolchain API
* https://cloud.ibm.com/apidocs/toolchain#list-tools. The branch or tag of the definition must match against a
* corresponding branch or tag in the chosen repository, and the path must match a subfolder in the repository.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {DefinitionSource} params.source - Source repository containing the Tekton pipeline definition.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createTektonPipelineDefinition(params: CdTektonPipelineV2.CreateTektonPipelineDefinitionParams): Promise>;
/**
* Retrieve a single definition entry.
*
* This request fetches a single definition entry, which consists of the definition repository URL, a repository path,
* and a branch or tag.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.definitionId - The definition ID.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getTektonPipelineDefinition(params: CdTektonPipelineV2.GetTektonPipelineDefinitionParams): Promise>;
/**
* Edit a single definition entry.
*
* This request updates a definition entry identified by `{definition_id}`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.definitionId - The definition ID.
* @param {DefinitionSource} params.source - Source repository containing the Tekton pipeline definition.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
replaceTektonPipelineDefinition(params: CdTektonPipelineV2.ReplaceTektonPipelineDefinitionParams): Promise>;
/**
* Delete a single definition entry.
*
* This request deletes a single definition from the definition list.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.definitionId - The definition ID.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteTektonPipelineDefinition(params: CdTektonPipelineV2.DeleteTektonPipelineDefinitionParams): Promise>;
/*************************
* environmentProperties
************************/
/**
* List the pipeline's environment properties.
*
* This request lists the environment properties of the pipeline identified by `{pipeline_id}`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} [params.name] - Filters the collection to resources with the specified property name.
* @param {string[]} [params.type] - Filters the collection to resources with the specified property type.
* @param {string} [params.sort] - Sorts the returned properties by name, in ascending order using `name` or in
* descending order using `-name`.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listTektonPipelineProperties(params: CdTektonPipelineV2.ListTektonPipelinePropertiesParams): Promise>;
/**
* Create a pipeline environment property.
*
* This request creates an environment property.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.name - Property name.
* @param {string} params.type - Property type.
* @param {string} [params.value] - Property value. Any string value is valid.
* @param {string[]} [params._enum] - Options for `single_select` property type. Only needed when using
* `single_select` property type.
* @param {boolean} [params.locked] - When true, this property cannot be overridden by a trigger property or at
* runtime. Attempting to override it will result in run requests being rejected. The default is false.
* @param {string} [params.path] - A dot notation path for `integration` type properties only, to select a value from
* the tool integration. If left blank the full tool integration data will be used.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createTektonPipelineProperties(params: CdTektonPipelineV2.CreateTektonPipelinePropertiesParams): Promise>;
/**
* Get a pipeline environment property.
*
* This request gets the data of an environment property identified by `{property_name}`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.propertyName - The property name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getTektonPipelineProperty(params: CdTektonPipelineV2.GetTektonPipelinePropertyParams): Promise>;
/**
* Replace the value of an environment property.
*
* This request updates the value of an environment property identified by `{property_name}`, its type and name are
* immutable.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.propertyName - The property name.
* @param {string} params.name - Property name.
* @param {string} params.type - Property type.
* @param {string} [params.value] - Property value. Any string value is valid.
* @param {string[]} [params._enum] - Options for `single_select` property type. Only needed when using
* `single_select` property type.
* @param {boolean} [params.locked] - When true, this property cannot be overridden by a trigger property or at
* runtime. Attempting to override it will result in run requests being rejected. The default is false.
* @param {string} [params.path] - A dot notation path for `integration` type properties only, to select a value from
* the tool integration. If left blank the full tool integration data will be used.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
replaceTektonPipelineProperty(params: CdTektonPipelineV2.ReplaceTektonPipelinePropertyParams): Promise>;
/**
* Delete a single pipeline environment property.
*
* This request deletes a single pipeline environment property.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.propertyName - The property name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteTektonPipelineProperty(params: CdTektonPipelineV2.DeleteTektonPipelinePropertyParams): Promise>;
/*************************
* triggers
************************/
/**
* List pipeline triggers.
*
* This request lists pipeline triggers for the pipeline identified by `{pipeline_id}`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} [params.type] - Optional filter by "type", accepts a comma separated list of types. Valid types are
* "manual", "scm", "generic", and "timer".
* @param {string} [params.name] - Optional filter by "name", accepts a single string value.
* @param {string} [params.eventListener] - Optional filter by "event_listener", accepts a single string value.
* @param {string} [params.workerId] - Optional filter by "worker.id", accepts a single string value.
* @param {string} [params.workerName] - Optional filter by "worker.name", accepts a single string value.
* @param {string} [params.disabled] - Optional filter by "disabled" state, possible values are "true" or "false".
* @param {string} [params.tags] - Optional filter by "tags", accepts a comma separated list of tags. The response
* lists triggers having at least one matching tag.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listTektonPipelineTriggers(params: CdTektonPipelineV2.ListTektonPipelineTriggersParams): Promise>;
/**
* Create a trigger.
*
* This request creates a trigger.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.type - Trigger type.
* @param {string} params.name - Trigger name.
* @param {string} params.eventListener - Event listener name. The name of the event listener to which the trigger is
* associated. The event listeners are defined in the definition repositories of the Tekton pipeline.
* @param {string[]} [params.tags] - Trigger tags array.
* @param {WorkerIdentity} [params.worker] - Specify the worker used to run the trigger. Use `worker: { id: 'public'
* }` to use the IBM Managed workers. The default is to inherit the worker set in the pipeline settings, which can
* also be explicitly set using `worker: { id: 'inherit' }`.
* @param {number} [params.maxConcurrentRuns] - Defines the maximum number of concurrent runs for this trigger. If
* omitted then the concurrency limit is disabled for this trigger.
* @param {boolean} [params.limitWaitingRuns] - Flag that will limit the trigger to a maximum of one waiting run. A
* newly triggered run will cause any other waiting run(s) to be automatically cancelled.
* @param {boolean} [params.enabled] - Flag to check if the trigger is enabled. If omitted the trigger is enabled by
* default.
* @param {GenericSecret} [params.secret] - Only needed for Generic Webhook trigger type. The secret is used to start
* the Generic Webhook trigger.
* @param {string} [params.cron] - Only needed for timer triggers. CRON expression that indicates when this trigger
* will activate. Maximum frequency is every 5 minutes. The string is based on UNIX crontab syntax: minute, hour, day
* of month, month, day of week. Example: The CRON expression 0 *_/2 * * * - translates to - every 2 hours.
* @param {string} [params.timezone] - Only used for timer triggers. Specify the timezone used for this timer trigger,
* which will ensure the CRON activates this trigger relative to the specified timezone. If no timezone is specified,
* the default timezone used is UTC. Valid timezones are those listed in the IANA timezone database,
* https://www.iana.org/time-zones.
* @param {TriggerSourcePrototype} [params.source] - Source repository for a Git trigger. Only required for Git
* triggers. The referenced repository URL must match the URL of a repository tool integration in the parent
* toolchain. Obtain the list of integrations from the toolchain API
* https://cloud.ibm.com/apidocs/toolchain#list-tools.
* @param {string[]} [params.events] - Either 'events' or 'filter' is required specifically for Git triggers. Stores a
* list of events that a Git trigger listens to. Choose one or more from 'push', 'pull_request', and
* 'pull_request_closed'. If SCM repositories use the 'merge request' term, they correspond to the generic term i.e.
* 'pull request'.
* @param {string} [params.filter] - Either 'events' or 'filter' can be used. Stores the CEL (Common Expression
* Language) expression value which is used for event filtering against the Git webhook payloads.
* @param {boolean} [params.favorite] - Mark the trigger as a favorite.
* @param {boolean} [params.enableEventsFromForks] - Only used for SCM triggers. When enabled, pull request events
* from forks of the selected repository will trigger a pipeline run.
* @param {boolean} [params.disableDraftEvents] - Prevent new pipeline runs from being triggered by events from draft
* pull requests.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createTektonPipelineTrigger(params: CdTektonPipelineV2.CreateTektonPipelineTriggerParams): Promise>;
/**
* Get a single trigger.
*
* This request retrieves a single trigger identified by `{trigger_id}`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.triggerId - The trigger ID.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getTektonPipelineTrigger(params: CdTektonPipelineV2.GetTektonPipelineTriggerParams): Promise>;
/**
* Edit a trigger.
*
* This request changes a single field or many fields of the trigger identified by `{trigger_id}`. Note that some
* fields are immutable, and use `/properties` endpoint to update trigger properties.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.triggerId - The trigger ID.
* @param {string} [params.type] - Trigger type.
* @param {string} [params.name] - Trigger name.
* @param {string} [params.eventListener] - Event listener name. The name of the event listener to which the trigger
* is associated. The event listeners are defined in the definition repositories of the Tekton pipeline.
* @param {string[]} [params.tags] - Trigger tags array. Optional tags for the trigger.
* @param {WorkerIdentity} [params.worker] - Specify the worker used to run the trigger. Use `worker: { id: 'public'
* }` to use the IBM Managed workers. Use `worker: { id: 'inherit' }` to inherit the worker used by the pipeline.
* @param {number} [params.maxConcurrentRuns] - Defines the maximum number of concurrent runs for this trigger. If set
* to 0 then the custom concurrency limit is disabled for this trigger.
* @param {boolean} [params.limitWaitingRuns] - Flag that will limit the trigger to a maximum of one waiting run. A
* newly triggered run will cause any other waiting run(s) to be automatically cancelled.
* @param {boolean} [params.enabled] - Defines if this trigger is enabled.
* @param {GenericSecret} [params.secret] - Only needed for Generic Webhook trigger type. The secret is used to start
* the Generic Webhook trigger.
* @param {string} [params.cron] - Only needed for timer triggers. CRON expression that indicates when this trigger
* will activate. Maximum frequency is every 5 minutes. The string is based on UNIX crontab syntax: minute, hour, day
* of month, month, day of week. Example: The CRON expression 0 *_/2 * * * - translates to - every 2 hours.
* @param {string} [params.timezone] - Only used for timer triggers. Specify the timezone used for this timer trigger,
* which will ensure the CRON activates this trigger relative to the specified timezone. If no timezone is specified,
* the default timezone used is UTC. Valid timezones are those listed in the IANA timezone database,
* https://www.iana.org/time-zones.
* @param {TriggerSourcePrototype} [params.source] - Source repository for a Git trigger. Only required for Git
* triggers. The referenced repository URL must match the URL of a repository tool integration in the parent
* toolchain. Obtain the list of integrations from the toolchain API
* https://cloud.ibm.com/apidocs/toolchain#list-tools.
* @param {string[]} [params.events] - Either 'events' or 'filter' is required specifically for Git triggers. Stores a
* list of events that a Git trigger listens to. Choose one or more from 'push', 'pull_request', and
* 'pull_request_closed'. If SCM repositories use the 'merge request' term, they correspond to the generic term i.e.
* 'pull request'.
* @param {string} [params.filter] - Either 'events' or 'filter' can be used. Stores the CEL (Common Expression
* Language) expression value which is used for event filtering against the Git webhook payloads.
* @param {boolean} [params.favorite] - Mark the trigger as a favorite.
* @param {boolean} [params.enableEventsFromForks] - Only used for SCM triggers. When enabled, pull request events
* from forks of the selected repository will trigger a pipeline run.
* @param {boolean} [params.disableDraftEvents] - Prevent new pipeline runs from being triggered by events from draft
* pull requests.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
updateTektonPipelineTrigger(params: CdTektonPipelineV2.UpdateTektonPipelineTriggerParams): Promise>;
/**
* Delete a single trigger.
*
* This request deletes the trigger identified by `{trigger_id}`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.triggerId - The trigger ID.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteTektonPipelineTrigger(params: CdTektonPipelineV2.DeleteTektonPipelineTriggerParams): Promise>;
/**
* Duplicate a trigger.
*
* This request duplicates a trigger from an existing trigger identified by `{source_trigger_id}`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.sourceTriggerId - The ID of the trigger to duplicate.
* @param {string} params.name - Trigger name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
duplicateTektonPipelineTrigger(params: CdTektonPipelineV2.DuplicateTektonPipelineTriggerParams): Promise>;
/*************************
* triggerProperties
************************/
/**
* List trigger properties.
*
* This request lists trigger properties for the trigger identified by `{trigger_id}`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.triggerId - The trigger ID.
* @param {string} [params.name] - Filter properties by `name`.
* @param {string} [params.type] - Filter properties by `type`. Valid types are `secure`, `text`, `integration`,
* `single_select`, `appconfig`.
* @param {string} [params.sort] - Sort properties by name. They can be sorted in ascending order using `name` or in
* descending order using `-name`.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
listTektonPipelineTriggerProperties(params: CdTektonPipelineV2.ListTektonPipelineTriggerPropertiesParams): Promise>;
/**
* Create a trigger property.
*
* This request creates a property in the trigger identified by `{trigger_id}`.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.triggerId - The trigger ID.
* @param {string} params.name - Property name.
* @param {string} params.type - Property type.
* @param {string} [params.value] - Property value. Any string value is valid.
* @param {string[]} [params._enum] - Options for `single_select` property type. Only needed for `single_select`
* property type.
* @param {string} [params.path] - A dot notation path for `integration` type properties only, to select a value from
* the tool integration. If left blank the full tool integration data will be used.
* @param {boolean} [params.locked] - When true, this property cannot be overridden at runtime. Attempting to override
* it will result in run requests being rejected. The default is false.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
createTektonPipelineTriggerProperties(params: CdTektonPipelineV2.CreateTektonPipelineTriggerPropertiesParams): Promise>;
/**
* Get a trigger property.
*
* This request retrieves a trigger property.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.triggerId - The trigger ID.
* @param {string} params.propertyName - The property name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
getTektonPipelineTriggerProperty(params: CdTektonPipelineV2.GetTektonPipelineTriggerPropertyParams): Promise>;
/**
* Replace a trigger property value.
*
* This request updates a trigger property value, type and name are immutable.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.triggerId - The trigger ID.
* @param {string} params.propertyName - The property name.
* @param {string} params.name - Property name.
* @param {string} params.type - Property type.
* @param {string} [params.value] - Property value. Any string value is valid.
* @param {string[]} [params._enum] - Options for `single_select` property type. Only needed for `single_select`
* property type.
* @param {string} [params.path] - A dot notation path for `integration` type properties only, to select a value from
* the tool integration. If left blank the full tool integration data will be used.
* @param {boolean} [params.locked] - When true, this property cannot be overridden at runtime. Attempting to override
* it will result in run requests being rejected. The default is false.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
replaceTektonPipelineTriggerProperty(params: CdTektonPipelineV2.ReplaceTektonPipelineTriggerPropertyParams): Promise>;
/**
* Delete a trigger property.
*
* This request deletes a trigger property.
*
* @param {Object} params - The parameters to send to the service.
* @param {string} params.pipelineId - The Tekton pipeline ID.
* @param {string} params.triggerId - The trigger ID.
* @param {string} params.propertyName - The property name.
* @param {OutgoingHttpHeaders} [params.headers] - Custom request headers
* @returns {Promise>}
*/
deleteTektonPipelineTriggerProperty(params: CdTektonPipelineV2.DeleteTektonPipelineTriggerPropertyParams): Promise>;
}
/*************************
* interfaces
************************/
declare namespace CdTektonPipelineV2 {
/** An operation response. */
export interface Response {
result: T;
status: number;
statusText: string;
headers: IncomingHttpHeaders;
}
/** The callback for a service request. */
export type Callback = (error: any, response?: Response) => void;
/** The body of a service request that returns no response data. */
export interface EmptyObject {
}
/** A standard JS object, defined to avoid the limitations of `Object` and `object` */
export interface JsonObject {
[key: string]: any;
}
/*************************
* request interfaces
************************/
interface DefaultParams {
headers?: OutgoingHttpHeaders;
signal?: AbortSignal;
}
/** Parameters for the `createTektonPipeline` operation. */
export interface CreateTektonPipelineParams extends DefaultParams {
/** The ID for the associated pipeline tool, which was already created in the target toolchain. To get the
* pipeline ID call the toolchain API https://cloud.ibm.com/apidocs/toolchain#list-tools and find the pipeline
* tool.
*/
id: string;
/** Specify the build number that will be used for the next pipeline run. Build numbers can be any positive
* whole number between 0 and 100000000000000.
*/
nextBuildNumber?: number;
/** Flag to enable notifications for this pipeline. If enabled, the Tekton pipeline run events will be published
* to all the destinations specified by the Slack and Event Notifications integrations in the parent toolchain.
*/
enableNotifications?: boolean;
/** Flag to enable partial cloning for this pipeline. When partial clone is enabled, only the files contained
* within the paths specified in definition repositories are read and cloned, this means that symbolic links might
* not work.
*/
enablePartialCloning?: boolean;
/** Specify the worker that is to be used to run the trigger, indicated by a worker object with only the worker
* ID. If not specified or set as `worker: { id: 'public' }`, the IBM Managed shared workers are used.
*/
worker?: WorkerIdentity;
}
/** Parameters for the `getTektonPipeline` operation. */
export interface GetTektonPipelineParams extends DefaultParams {
/** ID of current instance. */
id: string;
}
/** Parameters for the `updateTektonPipeline` operation. */
export interface UpdateTektonPipelineParams extends DefaultParams {
/** ID of current instance. */
id: string;
/** Specify the build number that will be used for the next pipeline run. Build numbers can be any positive
* whole number between 0 and 100000000000000.
*/
nextBuildNumber?: number;
/** Flag to enable notifications for this pipeline. If enabled, the Tekton pipeline run events will be published
* to all the destinations specified by the Slack and Event Notifications integrations in the parent toolchain.
*/
enableNotifications?: boolean;
/** Flag to enable partial cloning for this pipeline. When partial clone is enabled, only the files contained
* within the paths specified in definition repositories are read and cloned, this means that symbolic links might
* not work.
*/
enablePartialCloning?: boolean;
/** Specify the worker that is to be used to run the trigger, indicated by a worker object with only the worker
* ID. If not specified or set as `worker: { id: 'public' }`, the IBM Managed shared workers are used.
*/
worker?: WorkerIdentity;
}
/** Parameters for the `deleteTektonPipeline` operation. */
export interface DeleteTektonPipelineParams extends DefaultParams {
/** ID of current instance. */
id: string;
}
/** Parameters for the `listTektonPipelineRuns` operation. */
export interface ListTektonPipelineRunsParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** A page token that identifies the start point of the list of pipeline runs. This value is included in the
* response body of each request to fetch pipeline runs.
*/
start?: string;
/** The number of pipeline runs to return, sorted by creation time, most recent first. */
limit?: number;
/** Filters the collection to resources with the specified status. */
status?: ListTektonPipelineRunsConstants.Status | string;
/** Filters the collection to resources with the specified trigger name. */
triggerName?: string;
}
/** Constants for the `listTektonPipelineRuns` operation. */
export namespace ListTektonPipelineRunsConstants {
/** Filters the collection to resources with the specified status. */
enum Status {
PENDING = "pending",
WAITING = "waiting",
QUEUED = "queued",
RUNNING = "running",
CANCELLED = "cancelled",
FAILED = "failed",
ERROR = "error",
SUCCEEDED = "succeeded"
}
}
/** Parameters for the `createTektonPipelineRun` operation. */
export interface CreateTektonPipelineRunParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** Optional description for the created PipelineRun. */
description?: string;
/** Trigger name. */
triggerName?: string;
/** An object containing string values only. It provides additional 'text' properties or overrides existing
* pipeline/trigger properties that can be used in the created run.
*/
triggerProperties?: JsonObject;
/** An object containing string values only. It provides additional `secure` properties or overrides existing
* `secure` pipeline/trigger properties that can be used in the created run.
*/
secureTriggerProperties?: JsonObject;
/** An object containing string values only that provides the request headers. Use `$(header.header_key_name)`
* to access it in a TriggerBinding. Most commonly used as part of a Generic Webhook to provide a verification
* token or signature in the request headers.
*/
triggerHeaders?: JsonObject;
/** An object that provides the request body. Use `$(body.body_key_name)` to access it in a TriggerBinding. Most
* commonly used to pass in additional properties or override properties for the pipeline run that is created.
*/
triggerBody?: JsonObject;
/** Trigger details passed when triggering a Tekton pipeline run. */
trigger?: PipelineRunTrigger;
}
/** Parameters for the `getTektonPipelineRun` operation. */
export interface GetTektonPipelineRunParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** ID of current instance. */
id: string;
/** Defines if response includes definition metadata. */
includes?: GetTektonPipelineRunConstants.Includes | string;
}
/** Constants for the `getTektonPipelineRun` operation. */
export namespace GetTektonPipelineRunConstants {
/** Defines if response includes definition metadata. */
enum Includes {
DEFINITIONS = "definitions"
}
}
/** Parameters for the `deleteTektonPipelineRun` operation. */
export interface DeleteTektonPipelineRunParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** ID of current instance. */
id: string;
}
/** Parameters for the `cancelTektonPipelineRun` operation. */
export interface CancelTektonPipelineRunParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** ID of current instance. */
id: string;
/** Flag indicating whether the pipeline cancellation action is forced or not. */
force?: boolean;
}
/** Parameters for the `rerunTektonPipelineRun` operation. */
export interface RerunTektonPipelineRunParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** ID of current instance. */
id: string;
}
/** Parameters for the `getTektonPipelineRunLogs` operation. */
export interface GetTektonPipelineRunLogsParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** ID of current instance. */
id: string;
}
/** Parameters for the `getTektonPipelineRunLogContent` operation. */
export interface GetTektonPipelineRunLogContentParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The Tekton pipeline run ID. */
pipelineRunId: string;
/** ID of current instance. */
id: string;
}
/** Parameters for the `listTektonPipelineDefinitions` operation. */
export interface ListTektonPipelineDefinitionsParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
}
/** Parameters for the `createTektonPipelineDefinition` operation. */
export interface CreateTektonPipelineDefinitionParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** Source repository containing the Tekton pipeline definition. */
source: DefinitionSource;
}
/** Parameters for the `getTektonPipelineDefinition` operation. */
export interface GetTektonPipelineDefinitionParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The definition ID. */
definitionId: string;
}
/** Parameters for the `replaceTektonPipelineDefinition` operation. */
export interface ReplaceTektonPipelineDefinitionParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The definition ID. */
definitionId: string;
/** Source repository containing the Tekton pipeline definition. */
source: DefinitionSource;
}
/** Parameters for the `deleteTektonPipelineDefinition` operation. */
export interface DeleteTektonPipelineDefinitionParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The definition ID. */
definitionId: string;
}
/** Parameters for the `listTektonPipelineProperties` operation. */
export interface ListTektonPipelinePropertiesParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** Filters the collection to resources with the specified property name. */
name?: string;
/** Filters the collection to resources with the specified property type. */
type?: ListTektonPipelinePropertiesConstants.Type[] | string[];
/** Sorts the returned properties by name, in ascending order using `name` or in descending order using `-name`. */
sort?: string;
}
/** Constants for the `listTektonPipelineProperties` operation. */
export namespace ListTektonPipelinePropertiesConstants {
/** Filters the collection to resources with the specified property type. */
enum Type {
SECURE = "secure",
TEXT = "text",
INTEGRATION = "integration",
SINGLE_SELECT = "single_select",
APPCONFIG = "appconfig"
}
}
/** Parameters for the `createTektonPipelineProperties` operation. */
export interface CreateTektonPipelinePropertiesParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** Property name. */
name: string;
/** Property type. */
type: CreateTektonPipelinePropertiesConstants.Type | string;
/** Property value. Any string value is valid. */
value?: string;
/** Options for `single_select` property type. Only needed when using `single_select` property type. */
_enum?: string[];
/** When true, this property cannot be overridden by a trigger property or at runtime. Attempting to override it
* will result in run requests being rejected. The default is false.
*/
locked?: boolean;
/** A dot notation path for `integration` type properties only, to select a value from the tool integration. If
* left blank the full tool integration data will be used.
*/
path?: string;
}
/** Constants for the `createTektonPipelineProperties` operation. */
export namespace CreateTektonPipelinePropertiesConstants {
/** Property type. */
enum Type {
SECURE = "secure",
TEXT = "text",
INTEGRATION = "integration",
SINGLE_SELECT = "single_select",
APPCONFIG = "appconfig"
}
}
/** Parameters for the `getTektonPipelineProperty` operation. */
export interface GetTektonPipelinePropertyParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The property name. */
propertyName: string;
}
/** Parameters for the `replaceTektonPipelineProperty` operation. */
export interface ReplaceTektonPipelinePropertyParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The property name. */
propertyName: string;
/** Property name. */
name: string;
/** Property type. */
type: ReplaceTektonPipelinePropertyConstants.Type | string;
/** Property value. Any string value is valid. */
value?: string;
/** Options for `single_select` property type. Only needed when using `single_select` property type. */
_enum?: string[];
/** When true, this property cannot be overridden by a trigger property or at runtime. Attempting to override it
* will result in run requests being rejected. The default is false.
*/
locked?: boolean;
/** A dot notation path for `integration` type properties only, to select a value from the tool integration. If
* left blank the full tool integration data will be used.
*/
path?: string;
}
/** Constants for the `replaceTektonPipelineProperty` operation. */
export namespace ReplaceTektonPipelinePropertyConstants {
/** Property type. */
enum Type {
SECURE = "secure",
TEXT = "text",
INTEGRATION = "integration",
SINGLE_SELECT = "single_select",
APPCONFIG = "appconfig"
}
}
/** Parameters for the `deleteTektonPipelineProperty` operation. */
export interface DeleteTektonPipelinePropertyParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The property name. */
propertyName: string;
}
/** Parameters for the `listTektonPipelineTriggers` operation. */
export interface ListTektonPipelineTriggersParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** Optional filter by "type", accepts a comma separated list of types. Valid types are "manual", "scm",
* "generic", and "timer".
*/
type?: string;
/** Optional filter by "name", accepts a single string value. */
name?: string;
/** Optional filter by "event_listener", accepts a single string value. */
eventListener?: string;
/** Optional filter by "worker.id", accepts a single string value. */
workerId?: string;
/** Optional filter by "worker.name", accepts a single string value. */
workerName?: string;
/** Optional filter by "disabled" state, possible values are "true" or "false". */
disabled?: string;
/** Optional filter by "tags", accepts a comma separated list of tags. The response lists triggers having at
* least one matching tag.
*/
tags?: string;
}
/** Parameters for the `createTektonPipelineTrigger` operation. */
export interface CreateTektonPipelineTriggerParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** Trigger type. */
type: CreateTektonPipelineTriggerConstants.Type | string;
/** Trigger name. */
name: string;
/** Event listener name. The name of the event listener to which the trigger is associated. The event listeners
* are defined in the definition repositories of the Tekton pipeline.
*/
eventListener: string;
/** Trigger tags array. */
tags?: string[];
/** Specify the worker used to run the trigger. Use `worker: { id: 'public' }` to use the IBM Managed workers.
* The default is to inherit the worker set in the pipeline settings, which can also be explicitly set using
* `worker: { id: 'inherit' }`.
*/
worker?: WorkerIdentity;
/** Defines the maximum number of concurrent runs for this trigger. If omitted then the concurrency limit is
* disabled for this trigger.
*/
maxConcurrentRuns?: number;
/** Flag that will limit the trigger to a maximum of one waiting run. A newly triggered run will cause any other
* waiting run(s) to be automatically cancelled.
*/
limitWaitingRuns?: boolean;
/** Flag to check if the trigger is enabled. If omitted the trigger is enabled by default. */
enabled?: boolean;
/** Only needed for Generic Webhook trigger type. The secret is used to start the Generic Webhook trigger. */
secret?: GenericSecret;
/** Only needed for timer triggers. CRON expression that indicates when this trigger will activate. Maximum
* frequency is every 5 minutes. The string is based on UNIX crontab syntax: minute, hour, day of month, month, day
* of week. Example: The CRON expression 0 *_/2 * * * - translates to - every 2 hours.
*/
cron?: string;
/** Only used for timer triggers. Specify the timezone used for this timer trigger, which will ensure the CRON
* activates this trigger relative to the specified timezone. If no timezone is specified, the default timezone
* used is UTC. Valid timezones are those listed in the IANA timezone database, https://www.iana.org/time-zones.
*/
timezone?: string;
/** Source repository for a Git trigger. Only required for Git triggers. The referenced repository URL must
* match the URL of a repository tool integration in the parent toolchain. Obtain the list of integrations from the
* toolchain API https://cloud.ibm.com/apidocs/toolchain#list-tools.
*/
source?: TriggerSourcePrototype;
/** Either 'events' or 'filter' is required specifically for Git triggers. Stores a list of events that a Git
* trigger listens to. Choose one or more from 'push', 'pull_request', and 'pull_request_closed'. If SCM
* repositories use the 'merge request' term, they correspond to the generic term i.e. 'pull request'.
*/
events?: CreateTektonPipelineTriggerConstants.Events[] | string[];
/** Either 'events' or 'filter' can be used. Stores the CEL (Common Expression Language) expression value which
* is used for event filtering against the Git webhook payloads.
*/
filter?: string;
/** Mark the trigger as a favorite. */
favorite?: boolean;
/** Only used for SCM triggers. When enabled, pull request events from forks of the selected repository will
* trigger a pipeline run.
*/
enableEventsFromForks?: boolean;
/** Prevent new pipeline runs from being triggered by events from draft pull requests. */
disableDraftEvents?: boolean;
}
/** Constants for the `createTektonPipelineTrigger` operation. */
export namespace CreateTektonPipelineTriggerConstants {
/** Trigger type. */
enum Type {
MANUAL = "manual",
SCM = "scm",
TIMER = "timer",
GENERIC = "generic"
}
/** List of events. Supported options are 'push' Git webhook events, 'pull_request_closed' Git webhook events and 'pull_request' for 'open pull request' or 'update pull request' Git webhook events. */
enum Events {
PUSH = "push",
PULL_REQUEST = "pull_request",
PULL_REQUEST_CLOSED = "pull_request_closed"
}
}
/** Parameters for the `getTektonPipelineTrigger` operation. */
export interface GetTektonPipelineTriggerParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The trigger ID. */
triggerId: string;
}
/** Parameters for the `updateTektonPipelineTrigger` operation. */
export interface UpdateTektonPipelineTriggerParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The trigger ID. */
triggerId: string;
/** Trigger type. */
type?: UpdateTektonPipelineTriggerConstants.Type | string;
/** Trigger name. */
name?: string;
/** Event listener name. The name of the event listener to which the trigger is associated. The event listeners
* are defined in the definition repositories of the Tekton pipeline.
*/
eventListener?: string;
/** Trigger tags array. Optional tags for the trigger. */
tags?: string[];
/** Specify the worker used to run the trigger. Use `worker: { id: 'public' }` to use the IBM Managed workers.
* Use `worker: { id: 'inherit' }` to inherit the worker used by the pipeline.
*/
worker?: WorkerIdentity;
/** Defines the maximum number of concurrent runs for this trigger. If set to 0 then the custom concurrency
* limit is disabled for this trigger.
*/
maxConcurrentRuns?: number;
/** Flag that will limit the trigger to a maximum of one waiting run. A newly triggered run will cause any other
* waiting run(s) to be automatically cancelled.
*/
limitWaitingRuns?: boolean;
/** Defines if this trigger is enabled. */
enabled?: boolean;
/** Only needed for Generic Webhook trigger type. The secret is used to start the Generic Webhook trigger. */
secret?: GenericSecret;
/** Only needed for timer triggers. CRON expression that indicates when this trigger will activate. Maximum
* frequency is every 5 minutes. The string is based on UNIX crontab syntax: minute, hour, day of month, month, day
* of week. Example: The CRON expression 0 *_/2 * * * - translates to - every 2 hours.
*/
cron?: string;
/** Only used for timer triggers. Specify the timezone used for this timer trigger, which will ensure the CRON
* activates this trigger relative to the specified timezone. If no timezone is specified, the default timezone
* used is UTC. Valid timezones are those listed in the IANA timezone database, https://www.iana.org/time-zones.
*/
timezone?: string;
/** Source repository for a Git trigger. Only required for Git triggers. The referenced repository URL must
* match the URL of a repository tool integration in the parent toolchain. Obtain the list of integrations from the
* toolchain API https://cloud.ibm.com/apidocs/toolchain#list-tools.
*/
source?: TriggerSourcePrototype;
/** Either 'events' or 'filter' is required specifically for Git triggers. Stores a list of events that a Git
* trigger listens to. Choose one or more from 'push', 'pull_request', and 'pull_request_closed'. If SCM
* repositories use the 'merge request' term, they correspond to the generic term i.e. 'pull request'.
*/
events?: UpdateTektonPipelineTriggerConstants.Events[] | string[];
/** Either 'events' or 'filter' can be used. Stores the CEL (Common Expression Language) expression value which
* is used for event filtering against the Git webhook payloads.
*/
filter?: string;
/** Mark the trigger as a favorite. */
favorite?: boolean;
/** Only used for SCM triggers. When enabled, pull request events from forks of the selected repository will
* trigger a pipeline run.
*/
enableEventsFromForks?: boolean;
/** Prevent new pipeline runs from being triggered by events from draft pull requests. */
disableDraftEvents?: boolean;
}
/** Constants for the `updateTektonPipelineTrigger` operation. */
export namespace UpdateTektonPipelineTriggerConstants {
/** Trigger type. */
enum Type {
MANUAL = "manual",
SCM = "scm",
TIMER = "timer",
GENERIC = "generic"
}
/** List of events. Supported options are 'push' Git webhook events, 'pull_request_closed' Git webhook events and 'pull_request' for 'open pull request' or 'update pull request' Git webhook events. */
enum Events {
PUSH = "push",
PULL_REQUEST = "pull_request",
PULL_REQUEST_CLOSED = "pull_request_closed"
}
}
/** Parameters for the `deleteTektonPipelineTrigger` operation. */
export interface DeleteTektonPipelineTriggerParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The trigger ID. */
triggerId: string;
}
/** Parameters for the `duplicateTektonPipelineTrigger` operation. */
export interface DuplicateTektonPipelineTriggerParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The ID of the trigger to duplicate. */
sourceTriggerId: string;
/** Trigger name. */
name: string;
}
/** Parameters for the `listTektonPipelineTriggerProperties` operation. */
export interface ListTektonPipelineTriggerPropertiesParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The trigger ID. */
triggerId: string;
/** Filter properties by `name`. */
name?: string;
/** Filter properties by `type`. Valid types are `secure`, `text`, `integration`, `single_select`, `appconfig`. */
type?: string;
/** Sort properties by name. They can be sorted in ascending order using `name` or in descending order using
* `-name`.
*/
sort?: string;
}
/** Parameters for the `createTektonPipelineTriggerProperties` operation. */
export interface CreateTektonPipelineTriggerPropertiesParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The trigger ID. */
triggerId: string;
/** Property name. */
name: string;
/** Property type. */
type: CreateTektonPipelineTriggerPropertiesConstants.Type | string;
/** Property value. Any string value is valid. */
value?: string;
/** Options for `single_select` property type. Only needed for `single_select` property type. */
_enum?: string[];
/** A dot notation path for `integration` type properties only, to select a value from the tool integration. If
* left blank the full tool integration data will be used.
*/
path?: string;
/** When true, this property cannot be overridden at runtime. Attempting to override it will result in run
* requests being rejected. The default is false.
*/
locked?: boolean;
}
/** Constants for the `createTektonPipelineTriggerProperties` operation. */
export namespace CreateTektonPipelineTriggerPropertiesConstants {
/** Property type. */
enum Type {
SECURE = "secure",
TEXT = "text",
INTEGRATION = "integration",
SINGLE_SELECT = "single_select",
APPCONFIG = "appconfig"
}
}
/** Parameters for the `getTektonPipelineTriggerProperty` operation. */
export interface GetTektonPipelineTriggerPropertyParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The trigger ID. */
triggerId: string;
/** The property name. */
propertyName: string;
}
/** Parameters for the `replaceTektonPipelineTriggerProperty` operation. */
export interface ReplaceTektonPipelineTriggerPropertyParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The trigger ID. */
triggerId: string;
/** The property name. */
propertyName: string;
/** Property name. */
name: string;
/** Property type. */
type: ReplaceTektonPipelineTriggerPropertyConstants.Type | string;
/** Property value. Any string value is valid. */
value?: string;
/** Options for `single_select` property type. Only needed for `single_select` property type. */
_enum?: string[];
/** A dot notation path for `integration` type properties only, to select a value from the tool integration. If
* left blank the full tool integration data will be used.
*/
path?: string;
/** When true, this property cannot be overridden at runtime. Attempting to override it will result in run
* requests being rejected. The default is false.
*/
locked?: boolean;
}
/** Constants for the `replaceTektonPipelineTriggerProperty` operation. */
export namespace ReplaceTektonPipelineTriggerPropertyConstants {
/** Property type. */
enum Type {
SECURE = "secure",
TEXT = "text",
INTEGRATION = "integration",
SINGLE_SELECT = "single_select",
APPCONFIG = "appconfig"
}
}
/** Parameters for the `deleteTektonPipelineTriggerProperty` operation. */
export interface DeleteTektonPipelineTriggerPropertyParams extends DefaultParams {
/** The Tekton pipeline ID. */
pipelineId: string;
/** The trigger ID. */
triggerId: string;
/** The property name. */
propertyName: string;
}
/*************************
* model interfaces
************************/
/**
* Tekton pipeline definition entry object, consisting of a repository url, a repository path and a branch or tag. The
* referenced repository URL must match the URL of a repository tool integration in the parent toolchain. Obtain the
* list of integrations from the toolchain API https://cloud.ibm.com/apidocs/toolchain#list-tools. The branch or tag
* of the definition must match against a corresponding branch or tag in the chosen repository, and the path must
* match a subfolder in the repository.
*/
export interface Definition {
/** Source repository containing the Tekton pipeline definition. */
source: DefinitionSource;
/** API URL for interacting with the definition. */
href?: string;
/** The aggregated definition ID. */
id: string;
}
/**
* Source repository containing the Tekton pipeline definition.
*/
export interface DefinitionSource {
/** The only supported source type is "git", indicating that the source is a git repository. */
type: string;
/** Properties of the source, which define the URL of the repository and a branch or tag. */
properties: DefinitionSourceProperties;
}
/**
* Properties of the source, which define the URL of the repository and a branch or tag.
*/
export interface DefinitionSourceProperties {
/** URL of the definition repository. */
url: string;
/** A branch from the repo, specify one of branch or tag only. */
branch?: string;
/** A tag from the repo, specify one of branch or tag only. */
tag?: string;
/** The path to the definition's YAML files. */
path: string;
/** Reference to the repository tool in the parent toolchain. */
tool?: Tool;
}
/**
* Pipeline definitions is a collection of individual definition entries, each entry consists of a repository URL, a
* repository path, and a branch or tag.
*/
export interface DefinitionsCollection {
/** The list of all definitions in the pipeline. */
definitions: Definition[];
}
/**
* Only needed for Generic Webhook trigger type. The secret is used to start the Generic Webhook trigger.
*/
export interface GenericSecret {
/** Secret type. */
type?: GenericSecret.Constants.Type | string;
/** Secret value, not needed if secret type is `internal_validation`. */
value?: string;
/** Secret location, not needed if secret type is `internal_validation`. */
source?: GenericSecret.Constants.Source | string;
/** Secret name, not needed if type is `internal_validation`. */
key_name?: string;
/** Algorithm used for `digest_matches` secret type. Only needed for `digest_matches` secret type. */
algorithm?: GenericSecret.Constants.Algorithm | string;
}
export namespace GenericSecret {
namespace Constants {
/** Secret type. */
enum Type {
TOKEN_MATCHES = "token_matches",
DIGEST_MATCHES = "digest_matches",
INTERNAL_VALIDATION = "internal_validation"
}
/** Secret location, not needed if secret type is `internal_validation`. */
enum Source {
HEADER = "header",
PAYLOAD = "payload",
QUERY = "query"
}
/** Algorithm used for `digest_matches` secret type. Only needed for `digest_matches` secret type. */
enum Algorithm {
MD4 = "md4",
MD5 = "md5",
SHA1 = "sha1",
SHA256 = "sha256",
SHA384 = "sha384",
SHA512 = "sha512",
SHA512_224 = "sha512_224",
SHA512_256 = "sha512_256",
RIPEMD160 = "ripemd160"
}
}
}
/**
* Log data for Tekton pipeline run steps.
*/
export interface Log {
/** API for getting log content. */
href?: string;
/** Step log ID. */
id: string;
/** / of this log. */
name: string;
}
/**
* List of pipeline run log objects.
*/
export interface LogsCollection {
/** The list of pipeline run log objects. */
logs: Log[];
}
/**
* Single Tekton pipeline run object.
*/
export interface PipelineRun {
/** Universally Unique Identifier. */
id: string;
/** General href URL. */
href?: string;
/** Information about the user that triggered a pipeline run. Only included for pipeline runs that were manually
* triggered.
*/
user_info?: UserInfo;
/** Status of the pipeline run. */
status: PipelineRun.Constants.Status | string;
/** The aggregated definition ID. */
definition_id: string;
/** Reference to the pipeline definition of a pipeline run. */
definition?: RunDefinition;
/** Optional description for the created PipelineRun. */
description?: string;
/** Worker details used in this pipeline run. */
worker: PipelineRunWorker;
/** The ID of the pipeline to which this pipeline run belongs. */
pipeline_id: string;
/** Reference to the pipeline to which a pipeline run belongs. */
pipeline?: RunPipeline;
/** Listener name used to start the run. */
listener_name: string;
/** Tekton pipeline trigger. */
trigger: Trigger;
/** Event parameters object in String format that was passed in upon creation of this pipeline run, the contents
* depends on the type of trigger. For example, the Git event payload is included for Git triggers, or in the case
* of a manual trigger the override and added properties are included.
*/
event_params_blob: string;
/** Trigger headers object in String format that was passed in upon creation of this pipeline run. Omitted if no
* trigger_headers object was provided when creating the pipeline run.
*/
trigger_headers?: string;
/** Properties used in this Tekton pipeline run. Not included when fetching the list of pipeline runs. */
properties?: Property[];
/** Standard RFC 3339 Date Time String. */
created_at: string;
/** Standard RFC 3339 Date Time String. Only included if the run has been updated since it was created. */
updated_at?: string;
/** URL for the details page of this pipeline run. */
run_url: string;
/** Error message that provides details when a pipeline run encounters an error. */
error_message?: string;
}
export namespace PipelineRun {
namespace Constants {
/** Status of the pipeline run. */
enum Status {
PENDING = "pending",
WAITING = "waiting",
QUEUED = "queued",
RUNNING = "running",
CANCELLED = "cancelled",
FAILED = "failed",
ERROR = "error",
SUCCEEDED = "succeeded"
}
}
}
/**
* Trigger details passed when triggering a Tekton pipeline run.
*/
export interface PipelineRunTrigger {
/** Trigger name. */
name: string;
/** An object containing string values only. It provides additional 'text' properties or overrides existing
* pipeline/trigger properties that can be used in the created run.
*/
properties?: JsonObject;
/** An object containing string values only. It provides additional `secure` properties or overrides existing
* `secure` pipeline/trigger properties that can be used in the created run.
*/
secure_properties?: JsonObject;
/** An object containing string values only that provides the request headers. Use `$(header.header_key_name)`
* to access it in a TriggerBinding. Most commonly used as part of a Generic Webhook to provide a verification
* token or signature in the request headers.
*/
headers?: JsonObject;
/** An object that provides the request body. Use `$(body.body_key_name)` to access it in a TriggerBinding. Most
* commonly used to pass in additional properties or override properties for the pipeline run that is created.
*/
body?: JsonObject;
}
/**
* Worker details used in this pipeline run.
*/
export interface PipelineRunWorker {
/** Name of the worker. Computed based on the worker ID. */
name?: string;
/** The agent ID of the corresponding private worker integration used for this pipeline run. */
agent_id?: string;
/** The Service ID of the corresponding private worker integration used for this pipeline run. */
service_id?: string;
/** Universally Unique Identifier. */
id: string;
}
/**
* Tekton pipeline runs object.
*/
export interface PipelineRunsCollection {
/** Tekton pipeline runs list. */
pipeline_runs: PipelineRun[];
/** The number of pipeline runs to return, sorted by creation time, most recent first. */
limit: number;
/** First page of pipeline runs. */
first: RunsFirstPage;
/** Next page of pipeline runs relative to the `start` and `limit` params. Only included when there are more
* pages available.
*/
next?: RunsNextPage;
/** Last page of pipeline runs relative to the `start` and `limit` params. Only included when the last page has
* been reached.
*/
last?: RunsLastPage;
}
/**
* Pipeline properties object.
*/
export interface PropertiesCollection {
/** Pipeline properties list. */
properties: Property[];
}
/**
* Property object.
*/
export interface Property {
/** Property name. */
name: string;
/** Property value. Any string value is valid. */
value?: string;
/** API URL for interacting with the property. */
href?: string;
/** Options for `single_select` property type. Only needed when using `single_select` property type. */
enum?: string[];
/** Property type. */
type: Property.Constants.Type | string;
/** When true, this property cannot be overridden by a trigger property or at runtime. Attempting to override it
* will result in run requests being rejected. The default is false.
*/
locked?: boolean;
/** A dot notation path for `integration` type properties only, that selects a value from the tool integration.
* If left blank the full tool integration data will be used.
*/
path?: string;
}
export namespace Property {
namespace Constants {
/** Property type. */
enum Type {
SECURE = "secure",
TEXT = "text",
INTEGRATION = "integration",
SINGLE_SELECT = "single_select",
APPCONFIG = "appconfig"
}
}
}
/**
* The resource group in which the pipeline was created.
*/
export interface ResourceGroupReference {
/** ID. */
id?: string;
}
/**
* Reference to the pipeline definition of a pipeline run.
*/
export interface RunDefinition {
/** The ID of the definition used for a pipeline run. */
id?: string;
}
/**
* Reference to the pipeline to which a pipeline run belongs.
*/
export interface RunPipeline {
/** The ID of the pipeline to which a pipeline run belongs. */
id?: string;
}
/**
* First page of pipeline runs.
*/
export interface RunsFirstPage {
/** General href URL. */
href: string;
}
/**
* Last page of pipeline runs relative to the `start` and `limit` params. Only included when the last page has been
* reached.
*/
export interface RunsLastPage {
/** General href URL. */
href: string;
}
/**
* Next page of pipeline runs relative to the `start` and `limit` params. Only included when there are more pages
* available.
*/
export interface RunsNextPage {
/** General href URL. */
href: string;
}
/**
* Logs for a Tekton pipeline run step.
*/
export interface StepLog {
/** The raw log content of the step. Only included when fetching an individual log object. */
data: string;
/** Step log ID. */
id: string;
}
/**
* Tekton pipeline object.
*/
export interface TektonPipeline {
/** String. */
name: string;
/** Pipeline status. */
status: TektonPipeline.Constants.Status | string;
/** The resource group in which the pipeline was created. */
resource_group: ResourceGroupReference;
/** Toolchain object containing references to the parent toolchain. */
toolchain: ToolchainReference;
/** Universally Unique Identifier. */
id: string;
/** Definition list. */
definitions: Definition[];
/** Tekton pipeline's environment properties. */
properties: Property[];
/** Standard RFC 3339 Date Time String. */
updated_at: string;
/** Standard RFC 3339 Date Time String. */
created_at: string;
/** Tekton pipeline triggers list. */
triggers: Trigger[];
/** Details of the worker used to run the pipeline. */
worker: Worker;
/** URL for this pipeline showing the list of pipeline runs. */
runs_url: string;
/** API URL for interacting with the pipeline. */
href?: string;
/** The latest pipeline run build number. If this property is absent, the pipeline hasn't had any pipeline runs. */
build_number: number;
/** The build number that will be used for the next pipeline run. */
next_build_number?: number;
/** Flag to enable notifications for this pipeline. If enabled, the Tekton pipeline run events will be published
* to all the destinations specified by the Slack and Event Notifications integrations in the parent toolchain. If
* omitted, this feature is disabled by default.
*/
enable_notifications: boolean;
/** Flag to enable partial cloning for this pipeline. When partial clone is enabled, only the files contained
* within the paths specified in definition repositories are read and cloned, this means that symbolic links might
* not work. If omitted, this feature is disabled by default.
*/
enable_partial_cloning: boolean;
/** Flag to check if the trigger is enabled. */
enabled: boolean;
}
export namespace TektonPipeline {
namespace Constants {
/** Pipeline status. */
enum Status {
CONFIGURED = "configured",
CONFIGURING = "configuring"
}
}
}
/**
* Reference to the repository tool in the parent toolchain.
*/
export interface Tool {
/** ID of the repository tool instance in the parent toolchain. */
id: string;
}
/**
* Toolchain object containing references to the parent toolchain.
*/
export interface ToolchainReference {
/** Universally Unique Identifier. */
id: string;
/** The CRN for the toolchain that contains the Tekton pipeline. */
crn: string;
}
/**
* Tekton pipeline trigger.
*/
export interface Trigger {
}
/**
* Trigger properties object.
*/
export interface TriggerPropertiesCollection {
/** Trigger properties list. */
properties: TriggerProperty[];
}
/**
* Trigger property object.
*/
export interface TriggerProperty {
/** Property name. */
name: string;
/** Property value. Any string value is valid. */
value?: string;
/** API URL for interacting with the trigger property. */
href?: string;
/** Options for `single_select` property type. Only needed for `single_select` property type. */
enum?: string[];
/** Property type. */
type: TriggerProperty.Constants.Type | string;
/** A dot notation path for `integration` type properties only, that selects a value from the tool integration.
* If left blank the full tool integration data will be used.
*/
path?: string;
/** When true, this property cannot be overridden at runtime. Attempting to override it will result in run
* requests being rejected. The default is false.
*/
locked?: boolean;
}
export namespace TriggerProperty {
namespace Constants {
/** Property type. */
enum Type {
SECURE = "secure",
TEXT = "text",
INTEGRATION = "integration",
SINGLE_SELECT = "single_select",
APPCONFIG = "appconfig"
}
}
}
/**
* Source repository for a Git trigger. Only required for Git triggers. The referenced repository URL must match the
* URL of a repository tool integration in the parent toolchain. Obtain the list of integrations from the toolchain
* API https://cloud.ibm.com/apidocs/toolchain#list-tools.
*/
export interface TriggerSource {
/** The only supported source type is "git", indicating that the source is a git repository. */
type: string;
/** Properties of the source, which define the URL of the repository and a branch or pattern. */
properties: TriggerSourceProperties;
}
/**
* Properties of the source, which define the URL of the repository and a branch or pattern.
*/
export interface TriggerSourceProperties {
/** URL of the repository to which the trigger is listening. */
url: string;
/** Name of a branch from the repo. Only one of branch, pattern, or filter should be specified. */
branch?: string;
/** The pattern of Git branch or tag. You can specify a glob pattern such as '!test' or '*master' to match
* against multiple tags or branches in the repository. The glob pattern used must conform to Bash 4.3
* specifications, see bash documentation for more info:
* https://www.gnu.org/software/bash/manual/bash.html#Pattern-Matching. Only one of branch, pattern, or filter
* should be specified.
*/
pattern?: string;
/** True if the repository server is not addressable on the public internet. IBM Cloud will not be able to
* validate the connection details you provide.
*/
blind_connection: boolean;
/** Repository webhook ID. It is generated upon trigger creation. */
hook_id?: string;
/** Reference to the repository tool in the parent toolchain. */
tool: Tool;
}
/**
* Properties of the source, which define the URL of the repository and a branch or pattern.
*/
export interface TriggerSourcePropertiesPrototype {
/** URL of the repository to which the trigger is listening. */
url: string;
/** Name of a branch from the repo. Only one of branch, pattern, or filter should be specified. */
branch?: string;
/** The pattern of Git branch or tag. You can specify a glob pattern such as '!test' or '*master' to match
* against multiple tags or branches in the repository. The glob pattern used must conform to Bash 4.3
* specifications, see bash documentation for more info:
* https://www.gnu.org/software/bash/manual/bash.html#Pattern-Matching. Only one of branch, pattern, or filter
* should be specified.
*/
pattern?: string;
}
/**
* Source repository for a Git trigger. Only required for Git triggers. The referenced repository URL must match the
* URL of a repository tool integration in the parent toolchain. Obtain the list of integrations from the toolchain
* API https://cloud.ibm.com/apidocs/toolchain#list-tools.
*/
export interface TriggerSourcePrototype {
/** The only supported source type is "git", indicating that the source is a git repository. */
type: string;
/** Properties of the source, which define the URL of the repository and a branch or pattern. */
properties: TriggerSourcePropertiesPrototype;
}
/**
* Tekton pipeline triggers object.
*/
export interface TriggersCollection {
/** Tekton pipeline triggers list. */
triggers: Trigger[];
}
/**
* Information about the user that triggered a pipeline run. Only included for pipeline runs that were manually
* triggered.
*/
export interface UserInfo {
/** IBM Cloud IAM ID. */
iam_id: string;
/** User email address. */
sub: string;
}
/**
* Details of the worker used to run the pipeline.
*/
export interface Worker {
/** Name of the worker. Computed based on the worker ID. */
name?: string;
/** Type of the worker. Computed based on the worker ID. */
type?: string;
/** ID of the worker. */
id: string;
}
/**
* Specify the worker that is to be used to run the trigger, indicated by a worker object with only the worker ID. If
* not specified or set as `worker: { id: 'public' }`, the IBM Managed shared workers are used.
*/
export interface WorkerIdentity {
/** ID of the worker. */
id: string;
}
/**
* Generic webhook trigger, which triggers a pipeline run when the Tekton Pipeline Service receives a POST event with
* secrets.
*/
export interface TriggerGenericTrigger extends Trigger {
/** Trigger type. */
type: string;
/** Trigger name. */
name: string;
/** API URL for interacting with the trigger. Only included when fetching the list of pipeline triggers. */
href?: string;
/** Event listener name. The name of the event listener to which the trigger is associated. The event listeners
* are defined in the definition repositories of the Tekton pipeline.
*/
event_listener: string;
/** The Trigger ID. */
id: string;
/** Optional trigger properties are used to override or supplement the pipeline properties when triggering a
* pipeline run.
*/
properties?: TriggerProperty[];
/** Optional trigger tags array. */
tags?: string[];
/** Details of the worker used to run the trigger. */
worker?: Worker;
/** Defines the maximum number of concurrent runs for this trigger. If omitted then the concurrency limit is
* disabled for this trigger.
*/
max_concurrent_runs?: number;
/** Flag to check if the trigger is enabled. */
enabled: boolean;
/** Mark the trigger as a favorite. */
favorite?: boolean;
/** Flag that will limit the trigger to a maximum of one waiting run. A newly triggered run will cause any other
* waiting run(s) to be automatically cancelled.
*/
limit_waiting_runs?: boolean;
/** Only needed for Generic Webhook trigger type. The secret is used to start the Generic Webhook trigger. */
secret?: GenericSecret;
/** Webhook URL that can be used to trigger pipeline runs. */
webhook_url?: string;
/** Stores the CEL (Common Expression Language) expression value which is used for event filtering against the
* webhook payloads.
*/
filter?: string;
}
/**
* Manual trigger.
*/
export interface TriggerManualTrigger extends Trigger {
/** Trigger type. */
type: string;
/** Trigger name. */
name: string;
/** API URL for interacting with the trigger. Only included when fetching the list of pipeline triggers. */
href?: string;
/** Event listener name. The name of the event listener to which the trigger is associated. The event listeners
* are defined in the definition repositories of the Tekton pipeline.
*/
event_listener: string;
/** The Trigger ID. */
id: string;
/** Optional trigger properties are used to override or supplement the pipeline properties when triggering a
* pipeline run.
*/
properties?: TriggerProperty[];
/** Optional trigger tags array. */
tags?: string[];
/** Details of the worker used to run the trigger. */
worker?: Worker;
/** Defines the maximum number of concurrent runs for this trigger. If omitted then the concurrency limit is
* disabled for this trigger.
*/
max_concurrent_runs?: number;
/** Flag to check if the trigger is enabled. */
enabled: boolean;
/** Mark the trigger as a favorite. */
favorite?: boolean;
/** Flag that will limit the trigger to a maximum of one waiting run. A newly triggered run will cause any other
* waiting run(s) to be automatically cancelled.
*/
limit_waiting_runs?: boolean;
}
/**
* Git trigger type. It automatically triggers a pipeline run when the Tekton Pipeline Service receives a
* corresponding Git webhook event.
*/
export interface TriggerScmTrigger extends Trigger {
/** Trigger type. */
type: string;
/** Trigger name. */
name: string;
/** API URL for interacting with the trigger. Only included when fetching the list of pipeline triggers. */
href?: string;
/** Event listener name. The name of the event listener to which the trigger is associated. The event listeners
* are defined in the definition repositories of the Tekton pipeline.
*/
event_listener: string;
/** The Trigger ID. */
id: string;
/** Optional trigger properties are used to override or supplement the pipeline properties when triggering a
* pipeline run.
*/
properties?: TriggerProperty[];
/** Optional trigger tags array. */
tags?: string[];
/** Details of the worker used to run the trigger. */
worker?: Worker;
/** Defines the maximum number of concurrent runs for this trigger. If omitted then the concurrency limit is
* disabled for this trigger.
*/
max_concurrent_runs?: number;
/** Flag to check if the trigger is enabled. */
enabled: boolean;
/** Mark the trigger as a favorite. */
favorite?: boolean;
/** Flag that will limit the trigger to a maximum of one waiting run. A newly triggered run will cause any other
* waiting run(s) to be automatically cancelled.
*/
limit_waiting_runs?: boolean;
/** When enabled, pull request events from forks of the selected repository will trigger a pipeline run. */
enable_events_from_forks?: boolean;
/** Prevent new pipeline runs from being triggered by events from draft pull requests. */
disable_draft_events?: boolean;
/** Source repository for a Git trigger. Only required for Git triggers. The referenced repository URL must
* match the URL of a repository tool integration in the parent toolchain. Obtain the list of integrations from the
* toolchain API https://cloud.ibm.com/apidocs/toolchain#list-tools.
*/
source?: TriggerSource;
/** Either 'events' or 'filter' is required specifically for Git triggers. Stores a list of events that a Git
* trigger listens to. Choose one or more from 'push', 'pull_request', and 'pull_request_closed'. If SCM
* repositories use the 'merge request' term, they correspond to the generic term i.e. 'pull request'.
*/
events?: TriggerScmTrigger.Constants.Events[] | string[];
/** Either 'events' or 'filter' can be used. Stores the CEL (Common Expression Language) expression value which
* is used for event filtering against the Git webhook payloads.
*/
filter?: string;
}
export namespace TriggerScmTrigger {
namespace Constants {
/** Either 'events' or 'filter' is required specifically for Git triggers. Stores a list of events that a Git trigger listens to. Choose one or more from 'push', 'pull_request', and 'pull_request_closed'. If SCM repositories use the 'merge request' term, they correspond to the generic term i.e. 'pull request'. */
enum Events {
PUSH = "push",
PULL_REQUEST = "pull_request",
PULL_REQUEST_CLOSED = "pull_request_closed"
}
}
}
/**
* Timer trigger, which triggers pipeline runs according to the provided CRON value and timezone.
*/
export interface TriggerTimerTrigger extends Trigger {
/** Trigger type. */
type: string;
/** Trigger name. */
name: string;
/** API URL for interacting with the trigger. Only included when fetching the list of pipeline triggers. */
href?: string;
/** Event listener name. The name of the event listener to which the trigger is associated. The event listeners
* are defined in the definition repositories of the Tekton pipeline.
*/
event_listener: string;
/** The Trigger ID. */
id: string;
/** Optional trigger properties are used to override or supplement the pipeline properties when triggering a
* pipeline run.
*/
properties?: TriggerProperty[];
/** Optional trigger tags array. */
tags?: string[];
/** Details of the worker used to run the trigger. */
worker?: Worker;
/** Defines the maximum number of concurrent runs for this trigger. If omitted then the concurrency limit is
* disabled for this trigger.
*/
max_concurrent_runs?: number;
/** Flag to check if the trigger is enabled. */
enabled: boolean;
/** Mark the trigger as a favorite. */
favorite?: boolean;
/** Flag that will limit the trigger to a maximum of one waiting run. A newly triggered run will cause any other
* waiting run(s) to be automatically cancelled.
*/
limit_waiting_runs?: boolean;
/** Only needed for timer triggers. CRON expression that indicates when this trigger will activate. Maximum
* frequency is every 5 minutes. The string is based on UNIX crontab syntax: minute, hour, day of month, month, day
* of week. Example: The CRON expression 0 *_/2 * * * - translates to - every 2 hours.
*/
cron?: string;
/** Only used for timer triggers. Specify the timezone used for this timer trigger, which will ensure the CRON
* activates this trigger relative to the specified timezone. If no timezone is specified, the default timezone
* used is UTC. Valid timezones are those listed in the IANA timezone database, https://www.iana.org/time-zones.
*/
timezone?: string;
}
/*************************
* pager classes
************************/
/**
* TektonPipelineRunsPager can be used to simplify the use of listTektonPipelineRuns().
*/
export class TektonPipelineRunsPager {
protected _hasNext: boolean;
protected pageContext: any;
protected client: CdTektonPipelineV2;
protected params: CdTektonPipelineV2.ListTektonPipelineRunsParams;
/**
* Construct a TektonPipelineRunsPager object.
*
* @param {CdTektonPipelineV2} client - The service client instance used to invoke listTektonPipelineRuns()
* @param {Object} params - The parameters to be passed to listTektonPipelineRuns()
* @constructor
* @returns {TektonPipelineRunsPager}
*/
constructor(client: CdTektonPipelineV2, params: CdTektonPipelineV2.ListTektonPipelineRunsParams);
/**
* Returns true if there are potentially more results to be retrieved by invoking getNext().
* @returns {boolean}
*/
hasNext(): boolean;
/**
* Returns the next page of results by invoking listTektonPipelineRuns().
* @returns {Promise}
*/
getNext(): Promise;
/**
* Returns all results by invoking listTektonPipelineRuns() repeatedly until all pages of results have been retrieved.
* @returns {Promise}
*/
getAll(): Promise;
}
export {};
}
export = CdTektonPipelineV2;