Package com.ibm.cloud.continuous_delivery.cd_toolchain.v2

Class CdToolchain

  • public class CdToolchain
extends com.ibm.cloud.sdk.core.service.BaseService

    • Field Detail

      • DEFAULT_SERVICE_NAME

        public static final java.lang.String DEFAULT_SERVICE_NAME
        Default service name used when configuring the `CdToolchain` 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

      • CdToolchain

        public CdToolchain​(java.lang.String serviceName,
                   com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `CdToolchain` 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 CdToolchain newInstance()
        Class method which constructs an instance of the `CdToolchain` client. The default service name is used to configure the client instance.
        Returns:
        an instance of the `CdToolchain` client using external configuration

      • newInstance

        public static CdToolchain newInstance​(java.lang.String serviceName)
        Class method which constructs an instance of the `CdToolchain` 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 `CdToolchain` client using external configuration

      • listToolchains

        public com.ibm.cloud.sdk.core.http.ServiceCall<ToolchainCollection> listToolchains​(ListToolchainsOptions listToolchainsOptions)
        Get a list of toolchains. Returns a list of toolchains that the caller is authorized to access and that meets the provided query parameters.
        Parameters:
        listToolchainsOptions - the ListToolchainsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ToolchainCollection

      • createToolchain

        public com.ibm.cloud.sdk.core.http.ServiceCall<ToolchainPost> createToolchain​(CreateToolchainOptions createToolchainOptions)
        Create a toolchain. Creates a new toolchain based off the provided parameters in the body.
        Parameters:
        createToolchainOptions - the CreateToolchainOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ToolchainPost

      • getToolchainById

        public com.ibm.cloud.sdk.core.http.ServiceCall<Toolchain> getToolchainById​(GetToolchainByIdOptions getToolchainByIdOptions)
        Get a toolchain. Returns data for a single toolchain identified by its ID.
        Parameters:
        getToolchainByIdOptions - the GetToolchainByIdOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Toolchain

      • deleteToolchain

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteToolchain​(DeleteToolchainOptions deleteToolchainOptions)
        Delete a toolchain. Delete the toolchain with the specified ID.
        Parameters:
        deleteToolchainOptions - the DeleteToolchainOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • updateToolchain

        public com.ibm.cloud.sdk.core.http.ServiceCall<ToolchainPatch> updateToolchain​(UpdateToolchainOptions updateToolchainOptions)
        Update a toolchain. Update the toolchain with the specified ID.
        Parameters:
        updateToolchainOptions - the UpdateToolchainOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ToolchainPatch

      • createToolchainEvent

        public com.ibm.cloud.sdk.core.http.ServiceCall<ToolchainEventPost> createToolchainEvent​(CreateToolchainEventOptions createToolchainEventOptions)
        Create a toolchain event. Creates and sends a custom event to each Event Notifications instance configured as a tool into the toolchain. This operation will fail if no Event Notifications instances are configured into the toolchain.
        Parameters:
        createToolchainEventOptions - the CreateToolchainEventOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ToolchainEventPost

      • listTools

        public com.ibm.cloud.sdk.core.http.ServiceCall<ToolchainToolCollection> listTools​(ListToolsOptions listToolsOptions)
        Get a list of tools bound to a toolchain. Returns a list of tools bound to a toolchain that the caller is authorized to access and that meet the provided query parameters.
        Parameters:
        listToolsOptions - the ListToolsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ToolchainToolCollection

      • createTool

        public com.ibm.cloud.sdk.core.http.ServiceCall<ToolchainToolPost> createTool​(CreateToolOptions createToolOptions)
        Create a tool. Provisions a new tool based off the provided parameters in the body and binds it to the specified toolchain.
        Parameters:
        createToolOptions - the CreateToolOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ToolchainToolPost

      • getToolById

        public com.ibm.cloud.sdk.core.http.ServiceCall<ToolchainTool> getToolById​(GetToolByIdOptions getToolByIdOptions)
        Get a tool. Returns a tool that is bound to the provided toolchain.
        Parameters:
        getToolByIdOptions - the GetToolByIdOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ToolchainTool

      • deleteTool

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteTool​(DeleteToolOptions deleteToolOptions)
        Delete a tool. Delete the tool with the specified ID.
        Parameters:
        deleteToolOptions - the DeleteToolOptions containing the options for the call
        Returns:
        a ServiceCall with a void result