Class CreateDataProductDraftOptions
- java.lang.Object
-
- com.ibm.cloud.sdk.core.service.model.GenericModel
-
- com.ibm.cloud.dph_services.dph.v1.model.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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CreateDataProductDraftOptions.Builder
Builder.static interface
CreateDataProductDraftOptions.State
The state of the data product version.static interface
CreateDataProductDraftOptions.Types
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AssetPrototype
asset()
Gets the asset.java.util.List<DataProductContractTerms>
contractTerms()
Gets the contractTerms.DataProductIdentity
dataProduct()
Gets the dataProduct.java.lang.String
dataProductId()
Gets the dataProductId.java.lang.String
description()
Gets the description.Domain
domain()
Gets the domain.java.lang.Boolean
isRestricted()
Gets the isRestricted.java.lang.String
name()
Gets the name.CreateDataProductDraftOptions.Builder
newBuilder()
New builder.java.util.List<DataProductPart>
partsOut()
Gets the partsOut.java.lang.String
state()
Gets the state.java.util.List<java.lang.String>
tags()
Gets the tags.java.util.List<java.lang.String>
types()
Gets the types.java.util.List<UseCase>
useCases()
Gets the useCases.java.lang.String
version()
Gets the version.DataProductWorkflows
workflows()
Gets the workflows.
-
-
-
Method Detail
-
newBuilder
public CreateDataProductDraftOptions.Builder newBuilder()
New builder.- Returns:
- a CreateDataProductDraftOptions builder
-
dataProductId
public java.lang.String dataProductId()
Gets the dataProductId. Data product ID.- Returns:
- the dataProductId
-
asset
public AssetPrototype asset()
Gets the asset. New asset input properties.- 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 data product.- Returns:
- the tags
-
useCases
public java.util.List<UseCase> useCases()
Gets the useCases. A list of use cases associated with the data product version.- Returns:
- the useCases
-
types
public java.util.List<java.lang.String> types()
Gets the types. Types of parts on the data product.- Returns:
- the types
-
contractTerms
public java.util.List<DataProductContractTerms> contractTerms()
Gets the contractTerms. Contract terms binding various aspects of the data product.- 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
-
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
-
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
-
workflows
public DataProductWorkflows workflows()
Gets the workflows. The workflows associated with the data product version.- Returns:
- the workflows
-
-