Package com.ibm.cloud.continuous_delivery.cd_tekton_pipeline.v2

Class CdTektonPipeline

  • public class CdTektonPipeline
extends com.ibm.cloud.sdk.core.service.BaseService
    Continuous Delivery Tekton pipeline API definition <br><br> Maximum request payload size is 512 KB <br><br> All calls require an <strong>Authorization</strong> HTTP header. <br><br> The following header is the accepted authentication mechanism and required credentials for each <ul><li><b>Bearer:</b> an IBM Cloud IAM token (authorized for all endpoints)</li>. API Version: 2.0.0

    • Field Detail

      • DEFAULT_SERVICE_NAME

        public static final java.lang.String DEFAULT_SERVICE_NAME
        Default service name used when configuring the `CdTektonPipeline` client.
        See Also:
        Constant Field Values

      • DEFAULT_SERVICE_URL

        public static final java.lang.String DEFAULT_SERVICE_URL
        Default service endpoint URL.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CdTektonPipeline

        public CdTektonPipeline​(java.lang.String serviceName,
                        com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `CdTektonPipeline` client. The specified service name and authenticator are used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        authenticator - the Authenticator instance to be configured for this client

    • Method Detail

      • getServiceUrlForRegion

        public static java.lang.String getServiceUrlForRegion​(java.lang.String region)
        Returns the service URL associated with the specified region.
        Parameters:
        region - a string representing the region
        Returns:
        the service URL associated with the specified region or null if no mapping for the region exists

      • newInstance

        public static CdTektonPipeline newInstance()
        Class method which constructs an instance of the `CdTektonPipeline` client. The default service name is used to configure the client instance.
        Returns:
        an instance of the `CdTektonPipeline` client using external configuration

      • newInstance

        public static CdTektonPipeline newInstance​(java.lang.String serviceName)
        Class method which constructs an instance of the `CdTektonPipeline` client. The specified service name is used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        Returns:
        an instance of the `CdTektonPipeline` client using external configuration

      • createTektonPipeline

        public com.ibm.cloud.sdk.core.http.ServiceCall<TektonPipeline> createTektonPipeline​(CreateTektonPipelineOptions createTektonPipelineOptions)
        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.
        Parameters:
        createTektonPipelineOptions - the CreateTektonPipelineOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type TektonPipeline

      • getTektonPipeline

        public com.ibm.cloud.sdk.core.http.ServiceCall<TektonPipeline> getTektonPipeline​(GetTektonPipelineOptions getTektonPipelineOptions)
        Get Tekton pipeline data. This request retrieves the Tekton pipeline data for the pipeline identified by `{id}`.
        Parameters:
        getTektonPipelineOptions - the GetTektonPipelineOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type TektonPipeline

      • updateTektonPipeline

        public com.ibm.cloud.sdk.core.http.ServiceCall<TektonPipeline> updateTektonPipeline​(UpdateTektonPipelineOptions updateTektonPipelineOptions)
        Update Tekton pipeline data. This request updates Tekton pipeline data, but you can only change worker ID in this endpoint. Use other endpoints such as /definitions, /triggers, and /properties for other configuration updates.
        Parameters:
        updateTektonPipelineOptions - the UpdateTektonPipelineOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type TektonPipeline

      • deleteTektonPipeline

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteTektonPipeline​(DeleteTektonPipelineOptions deleteTektonPipelineOptions)
        Delete Tekton pipeline instance. This request deletes Tekton pipeline instance that is associated with the pipeline toolchain integration.
        Parameters:
        deleteTektonPipelineOptions - the DeleteTektonPipelineOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • listTektonPipelineRuns

        public com.ibm.cloud.sdk.core.http.ServiceCall<PipelineRunsCollection> listTektonPipelineRuns​(ListTektonPipelineRunsOptions listTektonPipelineRunsOptions)
        List pipeline run records. This request lists pipeline run records, which has data about the runs, such as status, user_info, trigger and other information. Default limit is 50.
        Parameters:
        listTektonPipelineRunsOptions - the ListTektonPipelineRunsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PipelineRunsCollection

      • createTektonPipelineRun

        public com.ibm.cloud.sdk.core.http.ServiceCall<PipelineRun> createTektonPipelineRun​(CreateTektonPipelineRunOptions createTektonPipelineRunOptions)
        Trigger a pipeline run. Trigger a new pipeline run with the named manual or timer trigger, using the provided additional or override properties.
        Parameters:
        createTektonPipelineRunOptions - the CreateTektonPipelineRunOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PipelineRun

      • getTektonPipelineRun

        public com.ibm.cloud.sdk.core.http.ServiceCall<PipelineRun> getTektonPipelineRun​(GetTektonPipelineRunOptions getTektonPipelineRunOptions)
        Get a pipeline run record. This request retrieves details of the pipeline run identified by `{id}`.
        Parameters:
        getTektonPipelineRunOptions - the GetTektonPipelineRunOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PipelineRun

      • deleteTektonPipelineRun

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteTektonPipelineRun​(DeleteTektonPipelineRunOptions deleteTektonPipelineRunOptions)
        Delete a pipeline run record. This request deletes the pipeline run record identified by `{id}`.
        Parameters:
        deleteTektonPipelineRunOptions - the DeleteTektonPipelineRunOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • cancelTektonPipelineRun

        public com.ibm.cloud.sdk.core.http.ServiceCall<PipelineRun> cancelTektonPipelineRun​(CancelTektonPipelineRunOptions cancelTektonPipelineRunOptions)
        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.
        Parameters:
        cancelTektonPipelineRunOptions - the CancelTektonPipelineRunOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PipelineRun

      • rerunTektonPipelineRun

        public com.ibm.cloud.sdk.core.http.ServiceCall<PipelineRun> rerunTektonPipelineRun​(RerunTektonPipelineRunOptions rerunTektonPipelineRunOptions)
        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.
        Parameters:
        rerunTektonPipelineRunOptions - the RerunTektonPipelineRunOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PipelineRun

      • getTektonPipelineRunLogs

        public com.ibm.cloud.sdk.core.http.ServiceCall<LogsCollection> getTektonPipelineRunLogs​(GetTektonPipelineRunLogsOptions getTektonPipelineRunLogsOptions)
        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.
        Parameters:
        getTektonPipelineRunLogsOptions - the GetTektonPipelineRunLogsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type LogsCollection

      • getTektonPipelineRunLogContent

        public com.ibm.cloud.sdk.core.http.ServiceCall<StepLog> getTektonPipelineRunLogContent​(GetTektonPipelineRunLogContentOptions getTektonPipelineRunLogContentOptions)
        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`.
        Parameters:
        getTektonPipelineRunLogContentOptions - the GetTektonPipelineRunLogContentOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type StepLog

      • listTektonPipelineDefinitions

        public com.ibm.cloud.sdk.core.http.ServiceCall<DefinitionsCollection> listTektonPipelineDefinitions​(ListTektonPipelineDefinitionsOptions listTektonPipelineDefinitionsOptions)
        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.
        Parameters:
        listTektonPipelineDefinitionsOptions - the ListTektonPipelineDefinitionsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type DefinitionsCollection

      • createTektonPipelineDefinition

        public com.ibm.cloud.sdk.core.http.ServiceCall<Definition> createTektonPipelineDefinition​(CreateTektonPipelineDefinitionOptions createTektonPipelineDefinitionOptions)
        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.
        Parameters:
        createTektonPipelineDefinitionOptions - the CreateTektonPipelineDefinitionOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Definition

      • getTektonPipelineDefinition

        public com.ibm.cloud.sdk.core.http.ServiceCall<Definition> getTektonPipelineDefinition​(GetTektonPipelineDefinitionOptions getTektonPipelineDefinitionOptions)
        Retrieve a single definition entry. This request fetches a single definition entry, which consists of the definition repository URL, branch/tag and path.
        Parameters:
        getTektonPipelineDefinitionOptions - the GetTektonPipelineDefinitionOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Definition

      • replaceTektonPipelineDefinition

        public com.ibm.cloud.sdk.core.http.ServiceCall<Definition> replaceTektonPipelineDefinition​(ReplaceTektonPipelineDefinitionOptions replaceTektonPipelineDefinitionOptions)
        Edit a single definition entry. This request updates a definition entry identified by `{definition_id}`.
        Parameters:
        replaceTektonPipelineDefinitionOptions - the ReplaceTektonPipelineDefinitionOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Definition

      • deleteTektonPipelineDefinition

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteTektonPipelineDefinition​(DeleteTektonPipelineDefinitionOptions deleteTektonPipelineDefinitionOptions)
        Delete a single definition entry. This request deletes a single definition from the definition list.
        Parameters:
        deleteTektonPipelineDefinitionOptions - the DeleteTektonPipelineDefinitionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • createTektonPipelineProperties

        public com.ibm.cloud.sdk.core.http.ServiceCall<Property> createTektonPipelineProperties​(CreateTektonPipelinePropertiesOptions createTektonPipelinePropertiesOptions)
        Create a pipeline environment property. This request creates an environment property.
        Parameters:
        createTektonPipelinePropertiesOptions - the CreateTektonPipelinePropertiesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Property

      • getTektonPipelineProperty

        public com.ibm.cloud.sdk.core.http.ServiceCall<Property> getTektonPipelineProperty​(GetTektonPipelinePropertyOptions getTektonPipelinePropertyOptions)
        Get a pipeline environment property. This request gets the data of an environment property identified by `{property_name}`.
        Parameters:
        getTektonPipelinePropertyOptions - the GetTektonPipelinePropertyOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Property

      • replaceTektonPipelineProperty

        public com.ibm.cloud.sdk.core.http.ServiceCall<Property> replaceTektonPipelineProperty​(ReplaceTektonPipelinePropertyOptions replaceTektonPipelinePropertyOptions)
        Replace the value of an environment property. This request updates the value of an environment property identified by `{property_name}`, its type or name are immutable.
        Parameters:
        replaceTektonPipelinePropertyOptions - the ReplaceTektonPipelinePropertyOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Property

      • deleteTektonPipelineProperty

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteTektonPipelineProperty​(DeleteTektonPipelinePropertyOptions deleteTektonPipelinePropertyOptions)
        Delete a single pipeline environment property. This request deletes a single pipeline environment property.
        Parameters:
        deleteTektonPipelinePropertyOptions - the DeleteTektonPipelinePropertyOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • createTektonPipelineTrigger

        public com.ibm.cloud.sdk.core.http.ServiceCall<Trigger> createTektonPipelineTrigger​(CreateTektonPipelineTriggerOptions createTektonPipelineTriggerOptions)
        Create a trigger. This request creates a trigger.
        Parameters:
        createTektonPipelineTriggerOptions - the CreateTektonPipelineTriggerOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Trigger

      • getTektonPipelineTrigger

        public com.ibm.cloud.sdk.core.http.ServiceCall<Trigger> getTektonPipelineTrigger​(GetTektonPipelineTriggerOptions getTektonPipelineTriggerOptions)
        Get a single trigger. This request retrieves a single trigger identified by `{trigger_id}`.
        Parameters:
        getTektonPipelineTriggerOptions - the GetTektonPipelineTriggerOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Trigger

      • updateTektonPipelineTrigger

        public com.ibm.cloud.sdk.core.http.ServiceCall<Trigger> updateTektonPipelineTrigger​(UpdateTektonPipelineTriggerOptions updateTektonPipelineTriggerOptions)
        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.
        Parameters:
        updateTektonPipelineTriggerOptions - the UpdateTektonPipelineTriggerOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Trigger

      • deleteTektonPipelineTrigger

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteTektonPipelineTrigger​(DeleteTektonPipelineTriggerOptions deleteTektonPipelineTriggerOptions)
        Delete a single trigger. This request deletes the trigger identified by `{trigger_id}`.
        Parameters:
        deleteTektonPipelineTriggerOptions - the DeleteTektonPipelineTriggerOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • duplicateTektonPipelineTrigger

        public com.ibm.cloud.sdk.core.http.ServiceCall<Trigger> duplicateTektonPipelineTrigger​(DuplicateTektonPipelineTriggerOptions duplicateTektonPipelineTriggerOptions)
        Duplicate a trigger. This request duplicates a trigger from an existing trigger identified by `{source_trigger_id}`.
        Parameters:
        duplicateTektonPipelineTriggerOptions - the DuplicateTektonPipelineTriggerOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Trigger

      • deleteTektonPipelineTriggerProperty

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteTektonPipelineTriggerProperty​(DeleteTektonPipelineTriggerPropertyOptions deleteTektonPipelineTriggerPropertyOptions)
        Delete a trigger property. This request deletes a trigger property.
        Parameters:
        deleteTektonPipelineTriggerPropertyOptions - the DeleteTektonPipelineTriggerPropertyOptions containing the options for the call
        Returns:
        a ServiceCall with a void result