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

Class CreateDataProductDraftOptions

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class CreateDataProductDraftOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    The createDataProductDraft options.

    • Method Detail

      • dataProductId

        public java.lang.String dataProductId()
        Gets the dataProductId. Data product ID.
        Returns:
        the dataProductId

      • asset

        public AssetReference asset()
        Gets the asset. The asset referenced by the data product version.
        Returns:
        the asset

      • version

        public java.lang.String version()
        Gets the version. The data product version number.
        Returns:
        the version

      • state

        public java.lang.String state()
        Gets the state. The state of the data product version. If not specified, the data product version will be created in `draft` state.
        Returns:
        the state

      • dataProduct

        public DataProductIdentity dataProduct()
        Gets the dataProduct. Data product identifier.
        Returns:
        the dataProduct

      • name

        public java.lang.String name()
        Gets the name. The name that refers to the new data product version. If this is a new data product, this value must be specified. If this is a new version of an existing data product, the name will default to the name of the previous data product version. A name can contain letters, numbers, understores, dashes, spaces or periods. A name must contain at least one non-space character.
        Returns:
        the name

      • description

        public java.lang.String description()
        Gets the description. Description of the data product version. If this is a new version of an existing data product, the description will default to the description of the previous version of the data product.
        Returns:
        the description

      • tags

        public java.util.List<java.lang.String> tags()
        Gets the tags. Tags on the new data product version. If this is the first version of a data product, tags defaults to an empty list. If this is a new version of an existing data product, tags will default to the list of tags on the previous version of the data product.
        Returns:
        the tags

      • useCases

        public java.util.List<UseCase> useCases()
        Gets the useCases. Use cases that the data product version serves. If this is the first version of a data product, use cases defaults to an empty list. If this is a new version of an existing data product, use cases will default to the list of use cases on the previous version of the data product.
        Returns:
        the useCases

      • domain

        public Domain domain()
        Gets the domain. Domain that the data product version belongs to. If this is the first version of a data product, this field is required. If this is a new version of an existing data product, the domain will default to the domain of the previous version of the data product.
        Returns:
        the domain

      • types

        public java.util.List<java.lang.String> types()
        Gets the types. The types of the parts included in this data product version. If this is the first version of a data product, this field defaults to an empty list. If this is a new version of an existing data product, the types will default to the types of the previous version of the data product.
        Returns:
        the types

      • partsOut

        public java.util.List<DataProductPart> partsOut()
        Gets the partsOut. The outgoing parts of this data product version to be delivered to consumers. If this is the first version of a data product, this field defaults to an empty list. If this is a new version of an existing data product, the data product parts will default to the parts list from the previous version of the data product.
        Returns:
        the partsOut

      • contractTerms

        public java.util.List<DataProductContractTerms> contractTerms()
        Gets the contractTerms. The contract terms that bind interactions with this data product version.
        Returns:
        the contractTerms

      • isRestricted

        public java.lang.Boolean isRestricted()
        Gets the isRestricted. Indicates whether the data product is restricted or not. A restricted data product indicates that orders of the data product requires explicit approval before data is delivered.
        Returns:
        the isRestricted