Class Dph
- java.lang.Object
-
- com.ibm.cloud.sdk.core.service.BaseService
-
- com.ibm.cloud.dph_services.dph.v1.Dph
-
public class Dph extends com.ibm.cloud.sdk.core.service.BaseService
Data Product Hub API Service. API Version: 1
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_SERVICE_NAME
Default service name used when configuring the `Dph` client.
-
Constructor Summary
Constructors Constructor Description Dph(java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)
Constructs an instance of the `Dph` client.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.ibm.cloud.sdk.core.http.ServiceCall<ContractTermsDocument>
completeDraftContractTermsDocument(CompleteDraftContractTermsDocumentOptions completeDraftContractTermsDocumentOptions)
Complete a contract document upload operation.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductContractTemplate>
createContractTemplate(CreateContractTemplateOptions createContractTemplateOptions)
Create new data product contract template.com.ibm.cloud.sdk.core.http.ServiceCall<DataAssetVisualizationRes>
createDataAssetVisualization()
Create visualization asset and initialize profiling for the provided data assets.com.ibm.cloud.sdk.core.http.ServiceCall<DataAssetVisualizationRes>
createDataAssetVisualization(CreateDataAssetVisualizationOptions createDataAssetVisualizationOptions)
Create visualization asset and initialize profiling for the provided data assets.com.ibm.cloud.sdk.core.http.ServiceCall<DataProduct>
createDataProduct(CreateDataProductOptions createDataProductOptions)
Create a new data product.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDomain>
createDataProductDomain(CreateDataProductDomainOptions createDataProductDomainOptions)
Create new data product domain.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDraft>
createDataProductDraft(CreateDataProductDraftOptions createDataProductDraftOptions)
Create a new draft of an existing data product.com.ibm.cloud.sdk.core.http.ServiceCall<InitializeSubDomain>
createDataProductSubdomain(CreateDataProductSubdomainOptions createDataProductSubdomainOptions)
Create data product subdomains for a specific domain identified by id.com.ibm.cloud.sdk.core.http.ServiceCall<ContractTermsDocument>
createDraftContractTermsDocument(CreateDraftContractTermsDocumentOptions createDraftContractTermsDocumentOptions)
Upload a contract document to the data product draft contract terms.com.ibm.cloud.sdk.core.http.ServiceCall<BucketResponse>
createS3Bucket(CreateS3BucketOptions createS3BucketOptions)
Create a new Bucket.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteDataProductContractTemplate(DeleteDataProductContractTemplateOptions deleteDataProductContractTemplateOptions)
Delete a data product contract template identified by id.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteDataProductDraft(DeleteDataProductDraftOptions deleteDataProductDraftOptions)
Delete a data product draft identified by ID.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteDomain(DeleteDomainOptions deleteDomainOptions)
Delete a data product domain identified by id.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
deleteDraftContractTermsDocument(DeleteDraftContractTermsDocumentOptions deleteDraftContractTermsDocumentOptions)
Delete a contract document.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductContractTemplate>
getContractTemplate(GetContractTemplateOptions getContractTemplateOptions)
Retrieve a data product contract template identified by id.com.ibm.cloud.sdk.core.http.ServiceCall<DataProduct>
getDataProduct(GetDataProductOptions getDataProductOptions)
Retrieve a data product identified by id.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductVersionCollection>
getDataProductByDomain(GetDataProductByDomainOptions getDataProductByDomainOptions)
Retrieve all data products in a domain specified by id or any of it's subdomains.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDraft>
getDataProductDraft(GetDataProductDraftOptions getDataProductDraftOptions)
Get a draft of an existing data product.com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream>
getDataProductDraftContractTerms(GetDataProductDraftContractTermsOptions getDataProductDraftContractTermsOptions)
Retrieve a data product contract terms identified by id.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductRelease>
getDataProductRelease(GetDataProductReleaseOptions getDataProductReleaseOptions)
Get a release of an existing data product.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDomain>
getDomain(GetDomainOptions getDomainOptions)
Retrieve a data product domain or subdomain identified by id.com.ibm.cloud.sdk.core.http.ServiceCall<ContractTermsDocument>
getDraftContractTermsDocument(GetDraftContractTermsDocumentOptions getDraftContractTermsDocumentOptions)
Get a contract document.com.ibm.cloud.sdk.core.http.ServiceCall<InitializeResource>
getInitializeStatus()
Get resource initialization status.com.ibm.cloud.sdk.core.http.ServiceCall<InitializeResource>
getInitializeStatus(GetInitializeStatusOptions getInitializeStatusOptions)
Get resource initialization status.com.ibm.cloud.sdk.core.http.ServiceCall<ContractTermsDocument>
getReleaseContractTermsDocument(GetReleaseContractTermsDocumentOptions getReleaseContractTermsDocumentOptions)
Get a contract document.com.ibm.cloud.sdk.core.http.ServiceCall<BucketValidationResponse>
getS3BucketValidation(GetS3BucketValidationOptions getS3BucketValidationOptions)
Validate the Bucket Existence.com.ibm.cloud.sdk.core.http.ServiceCall<ServiceIdCredentials>
getServiceIdCredentials()
Get service id credentials.com.ibm.cloud.sdk.core.http.ServiceCall<ServiceIdCredentials>
getServiceIdCredentials(GetServiceIdCredentialsOptions getServiceIdCredentialsOptions)
Get service id credentials.com.ibm.cloud.sdk.core.http.ServiceCall<InitializeResource>
initialize()
Initialize resources.com.ibm.cloud.sdk.core.http.ServiceCall<InitializeResource>
initialize(InitializeOptions initializeOptions)
Initialize resources.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductContractTemplateCollection>
listDataProductContractTemplate()
Retrieve a list of data product contract templates.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductContractTemplateCollection>
listDataProductContractTemplate(ListDataProductContractTemplateOptions listDataProductContractTemplateOptions)
Retrieve a list of data product contract templates.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDomainCollection>
listDataProductDomains()
Retrieve a list of data product domains.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDomainCollection>
listDataProductDomains(ListDataProductDomainsOptions listDataProductDomainsOptions)
Retrieve a list of data product domains.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDraftCollection>
listDataProductDrafts(ListDataProductDraftsOptions listDataProductDraftsOptions)
Retrieve a list of data product drafts.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductReleaseCollection>
listDataProductReleases(ListDataProductReleasesOptions listDataProductReleasesOptions)
Retrieve a list of data product releases.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductCollection>
listDataProducts()
Retrieve a list of data products.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductCollection>
listDataProducts(ListDataProductsOptions listDataProductsOptions)
Retrieve a list of data products.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
manageApiKeys()
Rotate credentials for a Data Product Hub instance.com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void>
manageApiKeys(ManageApiKeysOptions manageApiKeysOptions)
Rotate credentials for a Data Product Hub instance.static Dph
newInstance()
Class method which constructs an instance of the `Dph` client.static Dph
newInstance(java.lang.String serviceName)
Class method which constructs an instance of the `Dph` client.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductRelease>
publishDataProductDraft(PublishDataProductDraftOptions publishDataProductDraftOptions)
Publish a draft of an existing data product.com.ibm.cloud.sdk.core.http.ServiceCall<DataAssetVisualizationRes>
reinitiateDataAssetVisualization()
Reinitiate visualization for an asset.com.ibm.cloud.sdk.core.http.ServiceCall<DataAssetVisualizationRes>
reinitiateDataAssetVisualization(ReinitiateDataAssetVisualizationOptions reinitiateDataAssetVisualizationOptions)
Reinitiate visualization for an asset.com.ibm.cloud.sdk.core.http.ServiceCall<ContractTerms>
replaceDataProductDraftContractTerms(ReplaceDataProductDraftContractTermsOptions replaceDataProductDraftContractTermsOptions)
Update a data product contract terms identified by id.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductRelease>
retireDataProductRelease(RetireDataProductReleaseOptions retireDataProductReleaseOptions)
Retire a release of an existing data product.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductContractTemplate>
updateDataProductContractTemplate(UpdateDataProductContractTemplateOptions updateDataProductContractTemplateOptions)
Update the data product contract template identified by ID.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDomain>
updateDataProductDomain(UpdateDataProductDomainOptions updateDataProductDomainOptions)
Update the data product domain identified by ID.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDraft>
updateDataProductDraft(UpdateDataProductDraftOptions updateDataProductDraftOptions)
Update the data product draft identified by ID.com.ibm.cloud.sdk.core.http.ServiceCall<ContractTerms>
updateDataProductDraftContractTerms(UpdateDataProductDraftContractTermsOptions updateDataProductDraftContractTermsOptions)
Update a contract terms property.com.ibm.cloud.sdk.core.http.ServiceCall<DataProductRelease>
updateDataProductRelease(UpdateDataProductReleaseOptions updateDataProductReleaseOptions)
Update the data product release identified by ID.com.ibm.cloud.sdk.core.http.ServiceCall<ContractTermsDocument>
updateDraftContractTermsDocument(UpdateDraftContractTermsDocumentOptions updateDraftContractTermsDocumentOptions)
Update a contract document.-
Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService
configureClient, configureService, constructServiceUrl, constructServiceURL, disableRetries, enableGzipCompression, enableRetries, getAuthenticator, getClient, getDefaultHeaders, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, setClient, setDefaultHeaders, setEndPoint, setServiceUrl, toString
-
-
-
-
Field Detail
-
DEFAULT_SERVICE_NAME
public static final java.lang.String DEFAULT_SERVICE_NAME
Default service name used when configuring the `Dph` client.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
Dph
public Dph(java.lang.String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator)
Constructs an instance of the `Dph` 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 instanceauthenticator
- theAuthenticator
instance to be configured for this client
-
-
Method Detail
-
newInstance
public static Dph newInstance()
Class method which constructs an instance of the `Dph` client. The default service name is used to configure the client instance.- Returns:
- an instance of the `Dph` client using external configuration
-
newInstance
public static Dph newInstance(java.lang.String serviceName)
Class method which constructs an instance of the `Dph` 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 `Dph` 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 Hub.<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
- theGetInitializeStatusOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeInitializeResource
-
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 Hub.<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 typeInitializeResource
-
getServiceIdCredentials
public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceIdCredentials> getServiceIdCredentials(GetServiceIdCredentialsOptions getServiceIdCredentialsOptions)
Get service id credentials. Use this API to get the information of service id credentials in Data Product Hub.- Parameters:
getServiceIdCredentialsOptions
- theGetServiceIdCredentialsOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeServiceIdCredentials
-
getServiceIdCredentials
public com.ibm.cloud.sdk.core.http.ServiceCall<ServiceIdCredentials> getServiceIdCredentials()
Get service id credentials. Use this API to get the information of service id credentials in Data Product Hub.- Returns:
- a
ServiceCall
with a result of typeServiceIdCredentials
-
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 hub. <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 hub</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 hub</li><li>`workflows` - Workflows to enable restricted data products</li><li>`project` - A default project for exporting data assets to files</li><li>`catalog_configurations` - Catalog configurations for the default data product catalog</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 hub 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 hub 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
- theInitializeOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeInitializeResource
-
initialize
public com.ibm.cloud.sdk.core.http.ServiceCall<InitializeResource> initialize()
Initialize resources. Use this API to initialize default assets for data product hub. <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 hub</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 hub</li><li>`workflows` - Workflows to enable restricted data products</li><li>`project` - A default project for exporting data assets to files</li><li>`catalog_configurations` - Catalog configurations for the default data product catalog</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 hub 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 hub 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 typeInitializeResource
-
manageApiKeys
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> manageApiKeys(ManageApiKeysOptions manageApiKeysOptions)
Rotate credentials for a Data Product Hub instance. Use this API to rotate credentials for a Data Product Hub instance.- Parameters:
manageApiKeysOptions
- theManageApiKeysOptions
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 Hub instance. Use this API to rotate credentials for a Data Product Hub instance.- Returns:
- a
ServiceCall
with a void result
-
createDataAssetVisualization
public com.ibm.cloud.sdk.core.http.ServiceCall<DataAssetVisualizationRes> createDataAssetVisualization(CreateDataAssetVisualizationOptions createDataAssetVisualizationOptions)
Create visualization asset and initialize profiling for the provided data assets. Use this API to create visualization asset and initialize profiling for the provided data assets<br/><br/>Provide the below required fields<br/><br/>Required fields:<br/><br/>- catalog_id<br/>- Collection of assetId with it's related asset id<br/><br/>.- Parameters:
createDataAssetVisualizationOptions
- theCreateDataAssetVisualizationOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataAssetVisualizationRes
-
createDataAssetVisualization
public com.ibm.cloud.sdk.core.http.ServiceCall<DataAssetVisualizationRes> createDataAssetVisualization()
Create visualization asset and initialize profiling for the provided data assets. Use this API to create visualization asset and initialize profiling for the provided data assets<br/><br/>Provide the below required fields<br/><br/>Required fields:<br/><br/>- catalog_id<br/>- Collection of assetId with it's related asset id<br/><br/>.- Returns:
- a
ServiceCall
with a result of typeDataAssetVisualizationRes
-
reinitiateDataAssetVisualization
public com.ibm.cloud.sdk.core.http.ServiceCall<DataAssetVisualizationRes> reinitiateDataAssetVisualization(ReinitiateDataAssetVisualizationOptions reinitiateDataAssetVisualizationOptions)
Reinitiate visualization for an asset. Use this API to Reinitiate visualization for an asset which is in below scenarios<br/><br/>- Previous bucket got deleted and new bucket is created.<br/>- Data visualization attachment is missing in asset details.<br/>- Visualization asset reference is missing in related asset details.<br/><br/>.- Parameters:
reinitiateDataAssetVisualizationOptions
- theReinitiateDataAssetVisualizationOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataAssetVisualizationRes
-
reinitiateDataAssetVisualization
public com.ibm.cloud.sdk.core.http.ServiceCall<DataAssetVisualizationRes> reinitiateDataAssetVisualization()
Reinitiate visualization for an asset. Use this API to Reinitiate visualization for an asset which is in below scenarios<br/><br/>- Previous bucket got deleted and new bucket is created.<br/>- Data visualization attachment is missing in asset details.<br/>- Visualization asset reference is missing in related asset details.<br/><br/>.- Returns:
- a
ServiceCall
with a result of typeDataAssetVisualizationRes
-
listDataProducts
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductCollection> listDataProducts(ListDataProductsOptions listDataProductsOptions)
Retrieve a list of data products. Retrieve a list of data products.- Parameters:
listDataProductsOptions
- theListDataProductsOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductCollection
-
listDataProducts
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductCollection> listDataProducts()
Retrieve a list of data products. Retrieve a list of data products.- Returns:
- a
ServiceCall
with a result of typeDataProductCollection
-
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
- theCreateDataProductOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProduct
-
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
- theGetDataProductOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProduct
-
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. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly. - After the upload is marked as complete, the returned URL is displayed in the CommonConstants.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
- theCompleteDraftContractTermsDocumentOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeContractTermsDocument
-
listDataProductDrafts
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDraftCollection> listDataProductDrafts(ListDataProductDraftsOptions listDataProductDraftsOptions)
Retrieve a list of data product drafts. Retrieve a list of data product drafts. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.- Parameters:
listDataProductDraftsOptions
- theListDataProductDraftsOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductDraftCollection
-
createDataProductDraft
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDraft> createDataProductDraft(CreateDataProductDraftOptions createDataProductDraftOptions)
Create a new draft of an existing data product. Create a new draft of an existing data product.- Parameters:
createDataProductDraftOptions
- theCreateDataProductDraftOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductDraft
-
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. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly. - If the request object contains a CommonConstants.URL parameter, a referential document is created to store the provided url. - If the request object does not contain a CommonConstants.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 CommonConstants.URL parameter that can be used to download the attachment document.- Parameters:
createDraftContractTermsDocumentOptions
- theCreateDraftContractTermsDocumentOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeContractTermsDocument
-
getDataProductDraft
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDraft> getDataProductDraft(GetDataProductDraftOptions getDataProductDraftOptions)
Get a draft of an existing data product. Get a draft of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.- Parameters:
getDataProductDraftOptions
- theGetDataProductDraftOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductDraft
-
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. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.- Parameters:
deleteDataProductDraftOptions
- theDeleteDataProductDraftOptions
containing the options for the call- Returns:
- a
ServiceCall
with a void result
-
updateDataProductDraft
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDraft> 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. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.<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
- theUpdateDataProductDraftOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductDraft
-
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. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.- Parameters:
getDraftContractTermsDocumentOptions
- theGetDraftContractTermsDocumentOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeContractTermsDocument
-
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. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.- Parameters:
deleteDraftContractTermsDocumentOptions
- theDeleteDraftContractTermsDocumentOptions
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. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.- Parameters:
updateDraftContractTermsDocumentOptions
- theUpdateDraftContractTermsDocumentOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeContractTermsDocument
-
getDataProductDraftContractTerms
public com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream> getDataProductDraftContractTerms(GetDataProductDraftContractTermsOptions getDataProductDraftContractTermsOptions)
Retrieve a data product contract terms identified by id. Retrieve a data product contract terms identified by id.- Parameters:
getDataProductDraftContractTermsOptions
- theGetDataProductDraftContractTermsOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeInputStream
-
replaceDataProductDraftContractTerms
public com.ibm.cloud.sdk.core.http.ServiceCall<ContractTerms> replaceDataProductDraftContractTerms(ReplaceDataProductDraftContractTermsOptions replaceDataProductDraftContractTermsOptions)
Update a data product contract terms identified by id. Update a data product contract terms identified by id.- Parameters:
replaceDataProductDraftContractTermsOptions
- theReplaceDataProductDraftContractTermsOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeContractTerms
-
updateDataProductDraftContractTerms
public com.ibm.cloud.sdk.core.http.ServiceCall<ContractTerms> updateDataProductDraftContractTerms(UpdateDataProductDraftContractTermsOptions updateDataProductDraftContractTermsOptions)
Update a contract terms property. Use this API to update the properties of a contract terms that is identified by a valid ID. Specify patch operations using http://jsonpatch.com/ syntax. Supported patch operations include: - Update the contract terms properties. <br/><br/>Contract terms can only be updated if the associated data product version is in DRAFT state.- Parameters:
updateDataProductDraftContractTermsOptions
- theUpdateDataProductDraftContractTermsOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeContractTerms
-
publishDataProductDraft
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductRelease> publishDataProductDraft(PublishDataProductDraftOptions publishDataProductDraftOptions)
Publish a draft of an existing data product. Publish a draft of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.- Parameters:
publishDataProductDraftOptions
- thePublishDataProductDraftOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductRelease
-
getDataProductRelease
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductRelease> getDataProductRelease(GetDataProductReleaseOptions getDataProductReleaseOptions)
Get a release of an existing data product. Get a release of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.- Parameters:
getDataProductReleaseOptions
- theGetDataProductReleaseOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductRelease
-
updateDataProductRelease
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductRelease> 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. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.<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
- theUpdateDataProductReleaseOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductRelease
-
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. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.- Parameters:
getReleaseContractTermsDocumentOptions
- theGetReleaseContractTermsDocumentOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeContractTermsDocument
-
listDataProductReleases
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductReleaseCollection> listDataProductReleases(ListDataProductReleasesOptions listDataProductReleasesOptions)
Retrieve a list of data product releases. Retrieve a list of data product releases. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.- Parameters:
listDataProductReleasesOptions
- theListDataProductReleasesOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductReleaseCollection
-
retireDataProductRelease
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductRelease> retireDataProductRelease(RetireDataProductReleaseOptions retireDataProductReleaseOptions)
Retire a release of an existing data product. Retire a release of an existing data product. Use '-' for the `data_product_id` to skip specifying the data product ID explicitly.- Parameters:
retireDataProductReleaseOptions
- theRetireDataProductReleaseOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductRelease
-
listDataProductContractTemplate
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductContractTemplateCollection> listDataProductContractTemplate(ListDataProductContractTemplateOptions listDataProductContractTemplateOptions)
Retrieve a list of data product contract templates. Retrieve a list of data product contract templates.- Parameters:
listDataProductContractTemplateOptions
- theListDataProductContractTemplateOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductContractTemplateCollection
-
listDataProductContractTemplate
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductContractTemplateCollection> listDataProductContractTemplate()
Retrieve a list of data product contract templates. Retrieve a list of data product contract templates.- Returns:
- a
ServiceCall
with a result of typeDataProductContractTemplateCollection
-
createContractTemplate
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductContractTemplate> createContractTemplate(CreateContractTemplateOptions createContractTemplateOptions)
Create new data product contract template. Create new data product contract template.- Parameters:
createContractTemplateOptions
- theCreateContractTemplateOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductContractTemplate
-
getContractTemplate
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductContractTemplate> getContractTemplate(GetContractTemplateOptions getContractTemplateOptions)
Retrieve a data product contract template identified by id. Retrieve a data product contract template identified by id.- Parameters:
getContractTemplateOptions
- theGetContractTemplateOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductContractTemplate
-
deleteDataProductContractTemplate
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteDataProductContractTemplate(DeleteDataProductContractTemplateOptions deleteDataProductContractTemplateOptions)
Delete a data product contract template identified by id. Delete a data product contract template identified by id.- Parameters:
deleteDataProductContractTemplateOptions
- theDeleteDataProductContractTemplateOptions
containing the options for the call- Returns:
- a
ServiceCall
with a void result
-
updateDataProductContractTemplate
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductContractTemplate> updateDataProductContractTemplate(UpdateDataProductContractTemplateOptions updateDataProductContractTemplateOptions)
Update the data product contract template identified by ID. Use this API to update the properties of a data product contract template 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 name of a data product contract template<br/><br/>- Update the contract terms of data product contract template<br/><br/>.- Parameters:
updateDataProductContractTemplateOptions
- theUpdateDataProductContractTemplateOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductContractTemplate
-
listDataProductDomains
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDomainCollection> listDataProductDomains(ListDataProductDomainsOptions listDataProductDomainsOptions)
Retrieve a list of data product domains. Retrieve a list of data product domains.- Parameters:
listDataProductDomainsOptions
- theListDataProductDomainsOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductDomainCollection
-
listDataProductDomains
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDomainCollection> listDataProductDomains()
Retrieve a list of data product domains. Retrieve a list of data product domains.- Returns:
- a
ServiceCall
with a result of typeDataProductDomainCollection
-
createDataProductDomain
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDomain> createDataProductDomain(CreateDataProductDomainOptions createDataProductDomainOptions)
Create new data product domain. Create new data product domain.- Parameters:
createDataProductDomainOptions
- theCreateDataProductDomainOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductDomain
-
createDataProductSubdomain
public com.ibm.cloud.sdk.core.http.ServiceCall<InitializeSubDomain> createDataProductSubdomain(CreateDataProductSubdomainOptions createDataProductSubdomainOptions)
Create data product subdomains for a specific domain identified by id. Create data product subdomains for a specific domain identified by id.- Parameters:
createDataProductSubdomainOptions
- theCreateDataProductSubdomainOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeInitializeSubDomain
-
getDomain
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDomain> getDomain(GetDomainOptions getDomainOptions)
Retrieve a data product domain or subdomain identified by id. Retrieve a data product domain or subdomain identified by id.- Parameters:
getDomainOptions
- theGetDomainOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductDomain
-
deleteDomain
public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteDomain(DeleteDomainOptions deleteDomainOptions)
Delete a data product domain identified by id. Delete a data product domain identified by id.- Parameters:
deleteDomainOptions
- theDeleteDomainOptions
containing the options for the call- Returns:
- a
ServiceCall
with a void result
-
updateDataProductDomain
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductDomain> updateDataProductDomain(UpdateDataProductDomainOptions updateDataProductDomainOptions)
Update the data product domain identified by ID. Use this API to update the properties of a data product domain 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 name of a data product domain<br/><br/>- Update the description of a data product domain<br/><br/>- Update the rov of a data product domain<br/><br/>.- Parameters:
updateDataProductDomainOptions
- theUpdateDataProductDomainOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductDomain
-
getDataProductByDomain
public com.ibm.cloud.sdk.core.http.ServiceCall<DataProductVersionCollection> getDataProductByDomain(GetDataProductByDomainOptions getDataProductByDomainOptions)
Retrieve all data products in a domain specified by id or any of it's subdomains. Retrieve all the data products tagged to the domain identified by id or any of it's subdomains.- Parameters:
getDataProductByDomainOptions
- theGetDataProductByDomainOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeDataProductVersionCollection
-
createS3Bucket
public com.ibm.cloud.sdk.core.http.ServiceCall<BucketResponse> createS3Bucket(CreateS3BucketOptions createS3BucketOptions)
Create a new Bucket. Use this API to create a new S3 Bucket on an AWS Hosting.- Parameters:
createS3BucketOptions
- theCreateS3BucketOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeBucketResponse
-
getS3BucketValidation
public com.ibm.cloud.sdk.core.http.ServiceCall<BucketValidationResponse> getS3BucketValidation(GetS3BucketValidationOptions getS3BucketValidationOptions)
Validate the Bucket Existence. Use this API to validate the bucket existence on an AWS hosting.- Parameters:
getS3BucketValidationOptions
- theGetS3BucketValidationOptions
containing the options for the call- Returns:
- a
ServiceCall
with a result of typeBucketValidationResponse
-
-