Package com.ibm.cloud.dpx_services.dpx.v1

Class Dpx

  • public class Dpx
extends com.ibm.cloud.sdk.core.service.BaseService
    Data Product Exchange API Service. API Version: 1.0.0

    • Field Detail

      • DEFAULT_SERVICE_NAME

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

    • Constructor Detail

      • Dpx

        public Dpx​(java.lang.String serviceName,
           com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `Dpx` 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

      • newInstance

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

      • newInstance

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

      • getInitializeStatus

        public com.ibm.cloud.sdk.core.http.ServiceCall<InitializeResource> getInitializeStatus​(GetInitializeStatusOptions getInitializeStatusOptions)
        Get resource initialization status. Use this API to get the status of resource initialization in Data Product Exchange.<br/><br/>If the data product catalog exists but has never been initialized, the status will be "not_started".<br/><br/>If the data product catalog exists and has been or is being initialized, the response will contain the status of the last or current initialization. If the initialization failed, the "errors" and "trace" fields will contain the error(s) encountered during the initialization, including the ID to trace the error(s).<br/><br/>If the data product catalog doesn't exist, an HTTP 404 response is returned.
        Parameters:
        getInitializeStatusOptions - the GetInitializeStatusOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InitializeResource

      • getInitializeStatus

        public com.ibm.cloud.sdk.core.http.ServiceCall<InitializeResource> getInitializeStatus()
        Get resource initialization status. Use this API to get the status of resource initialization in Data Product Exchange.<br/><br/>If the data product catalog exists but has never been initialized, the status will be "not_started".<br/><br/>If the data product catalog exists and has been or is being initialized, the response will contain the status of the last or current initialization. If the initialization failed, the "errors" and "trace" fields will contain the error(s) encountered during the initialization, including the ID to trace the error(s).<br/><br/>If the data product catalog doesn't exist, an HTTP 404 response is returned.
        Returns:
        a ServiceCall with a result of type InitializeResource

      • initialize

        public com.ibm.cloud.sdk.core.http.ServiceCall<InitializeResource> initialize​(InitializeOptions initializeOptions)
        Initialize resources. Use this API to initialize default assets for data product exchange. <br/><br/>You can initialize: <br/><ul><li>`delivery_methods` - Methods through which data product parts can be delivered to consumers of the data product exchange</li><li>`domains_multi_industry` - Taxonomy of domains and use cases applicable to multiple industries</li><li>`data_product_samples` - Sample data products used to illustrate capabilities of the data product exchange</li></ul><br/><br/>If a resource depends on resources that are not specified in the request, these dependent resources will be automatically initialized. E.g., initializing `data_product_samples` will also initialize `domains_multi_industry` and `delivery_methods` even if they are not specified in the request because it depends on them.<br/><br/>If initializing the data product exchange for the first time, do not specify a container. The default data product catalog will be created.<br/>For first time initialization, it is recommended that at least `delivery_methods` and `domains_multi_industry` is included in the initialize operation.<br/><br/>If the data product exchange has already been initialized, you may call this API again to initialize new resources, such as new delivery methods.In this case, specify the default data product catalog container information.
        Parameters:
        initializeOptions - the InitializeOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InitializeResource

      • initialize

        public com.ibm.cloud.sdk.core.http.ServiceCall<InitializeResource> initialize()
        Initialize resources. Use this API to initialize default assets for data product exchange. <br/><br/>You can initialize: <br/><ul><li>`delivery_methods` - Methods through which data product parts can be delivered to consumers of the data product exchange</li><li>`domains_multi_industry` - Taxonomy of domains and use cases applicable to multiple industries</li><li>`data_product_samples` - Sample data products used to illustrate capabilities of the data product exchange</li></ul><br/><br/>If a resource depends on resources that are not specified in the request, these dependent resources will be automatically initialized. E.g., initializing `data_product_samples` will also initialize `domains_multi_industry` and `delivery_methods` even if they are not specified in the request because it depends on them.<br/><br/>If initializing the data product exchange for the first time, do not specify a container. The default data product catalog will be created.<br/>For first time initialization, it is recommended that at least `delivery_methods` and `domains_multi_industry` is included in the initialize operation.<br/><br/>If the data product exchange has already been initialized, you may call this API again to initialize new resources, such as new delivery methods.In this case, specify the default data product catalog container information.
        Returns:
        a ServiceCall with a result of type InitializeResource

      • manageApiKeys

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> manageApiKeys​(ManageApiKeysOptions manageApiKeysOptions)
        Rotate credentials for a Data Product Exchange instance. Use this API to rotate credentials for a Data Product Exchange instance.
        Parameters:
        manageApiKeysOptions - the ManageApiKeysOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • manageApiKeys

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> manageApiKeys()
        Rotate credentials for a Data Product Exchange instance. Use this API to rotate credentials for a Data Product Exchange instance.
        Returns:
        a ServiceCall with a void result

      • createDataProduct

        public com.ibm.cloud.sdk.core.http.ServiceCall<DataProduct> createDataProduct​(CreateDataProductOptions createDataProductOptions)
        Create a new data product. Use this API to create a new data product.<br/><br/>Provide the initial draft of the data product.<br/><br/>Required fields:<br/><br/>- name<br/>- container<br/><br/>If `version` is not specified, the default version **1.0.0** will be used.<br/><br/>The `domain` is optional.
        Parameters:
        createDataProductOptions - the CreateDataProductOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type DataProduct

      • getDataProduct

        public com.ibm.cloud.sdk.core.http.ServiceCall<DataProduct> getDataProduct​(GetDataProductOptions getDataProductOptions)
        Retrieve a data product identified by id. Retrieve a data product identified by id.
        Parameters:
        getDataProductOptions - the GetDataProductOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type DataProduct

      • completeDraftContractTermsDocument

        public com.ibm.cloud.sdk.core.http.ServiceCall<ContractTermsDocument> completeDraftContractTermsDocument​(CompleteDraftContractTermsDocumentOptions completeDraftContractTermsDocumentOptions)
        Complete a contract document upload operation. After uploading a file to the provided signed URL, call this endpoint to mark the upload as complete. After the upload operation is marked as complete, the file is available to download. - After the upload is marked as complete, the returned URL is displayed in the "url" field. The signed URL is used to download the document. - Calling complete on referential documents results in an error. - Calling complete on attachment documents for which the file has not been uploaded will result in an error.
        Parameters:
        completeDraftContractTermsDocumentOptions - the CompleteDraftContractTermsDocumentOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ContractTermsDocument

      • createDraftContractTermsDocument

        public com.ibm.cloud.sdk.core.http.ServiceCall<ContractTermsDocument> createDraftContractTermsDocument​(CreateDraftContractTermsDocumentOptions createDraftContractTermsDocumentOptions)
        Upload a contract document to the data product draft contract terms. Upload a contract document to the data product draft identified by draft_id. - If the request object contains a "url" parameter, a referential document is created to store the provided url. - If the request object does not contain a "url" parameter, an attachment document is created, and a signed url will be returned in an "upload_url" parameter. The data product producer can upload the document using the provided "upload_url". After the upload is completed, call "complete_contract_terms_document" for the given document needs to be called to mark the upload as completed. After completion of the upload, "get_contract_terms_document" for the given document returns a signed "url" parameter that can be used to download the attachment document.
        Parameters:
        createDraftContractTermsDocumentOptions - the CreateDraftContractTermsDocumentOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ContractTermsDocument

      • deleteDataProductDraft

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteDataProductDraft​(DeleteDataProductDraftOptions deleteDataProductDraftOptions)
        Delete a data product draft identified by ID. Delete a data product draft identified by a valid ID.
        Parameters:
        deleteDataProductDraftOptions - the DeleteDataProductDraftOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • updateDataProductDraft

        public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductVersion> updateDataProductDraft​(UpdateDataProductDraftOptions updateDataProductDraftOptions)
        Update the data product draft identified by ID. Use this API to update the properties of a data product draft identified by a valid ID.<br/><br/>Specify patch operations using http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations include:<br/><br/>- Update the properties of a data product<br/><br/>- Add/Remove parts from a data product (up to 20 parts)<br/><br/>- Add/Remove use cases from a data product<br/><br/>- Update the data product state<br/><br/>.
        Parameters:
        updateDataProductDraftOptions - the UpdateDataProductDraftOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type DataProductVersion

      • getDraftContractTermsDocument

        public com.ibm.cloud.sdk.core.http.ServiceCall<ContractTermsDocument> getDraftContractTermsDocument​(GetDraftContractTermsDocumentOptions getDraftContractTermsDocumentOptions)
        Get a contract document. If a document has a completed attachment, the response contains the `url` which can be used to download the attachment. If a document does not have a completed attachment, the response contains the `url` which was submitted at document creation. If a document has an attachment that is incomplete, an error is returned to prompt the user to upload the document file and complete it.
        Parameters:
        getDraftContractTermsDocumentOptions - the GetDraftContractTermsDocumentOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ContractTermsDocument

      • deleteDraftContractTermsDocument

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteDraftContractTermsDocument​(DeleteDraftContractTermsDocumentOptions deleteDraftContractTermsDocumentOptions)
        Delete a contract document. Delete an existing contract document. Contract documents can only be deleted for data product versions that are in DRAFT state.
        Parameters:
        deleteDraftContractTermsDocumentOptions - the DeleteDraftContractTermsDocumentOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • updateDraftContractTermsDocument

        public com.ibm.cloud.sdk.core.http.ServiceCall<ContractTermsDocument> updateDraftContractTermsDocument​(UpdateDraftContractTermsDocumentOptions updateDraftContractTermsDocumentOptions)
        Update a contract document. Use this API to update the properties of a contract document that is identified by a valid ID. Specify patch operations using http://jsonpatch.com/ syntax. Supported patch operations include: - Update the url of document if it does not have an attachment. - Update the type of the document. <br/><br/>Contract terms documents can only be updated if the associated data product version is in DRAFT state.
        Parameters:
        updateDraftContractTermsDocumentOptions - the UpdateDraftContractTermsDocumentOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ContractTermsDocument

      • updateDataProductRelease

        public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductVersion> updateDataProductRelease​(UpdateDataProductReleaseOptions updateDataProductReleaseOptions)
        Update the data product release identified by ID. Use this API to update the properties of a data product release identified by a valid ID.<br/><br/>Specify patch operations using http://jsonpatch.com/ syntax.<br/><br/>Supported patch operations include:<br/><br/>- Update the properties of a data product<br/><br/>- Add/remove parts from a data product (up to 20 parts)<br/><br/>- Add/remove use cases from a data product<br/><br/>.
        Parameters:
        updateDataProductReleaseOptions - the UpdateDataProductReleaseOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type DataProductVersion

      • getReleaseContractTermsDocument

        public com.ibm.cloud.sdk.core.http.ServiceCall<ContractTermsDocument> getReleaseContractTermsDocument​(GetReleaseContractTermsDocumentOptions getReleaseContractTermsDocumentOptions)
        Get a contract document. If the document has a completed attachment, the response contains the `url` to download the attachment.<br/><br/> If the document does not have an attachment, the response contains the `url` which was submitted at document creation.<br/><br/> If the document has an incomplete attachment, an error is returned to prompt the user to upload the document file to complete the attachment.
        Parameters:
        getReleaseContractTermsDocumentOptions - the GetReleaseContractTermsDocumentOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ContractTermsDocument