Package com.ibm.cloud.dph_services.dph.v1.model

Class Overview

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class Overview
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    Overview details of a data contract.

    • Method Detail

      • newBuilder

        public Overview.Builder newBuilder()
        New builder.
        Returns:
        a Overview builder

      • apiVersion

        public java.lang.String apiVersion()
        Gets the apiVersion. The API version of the contract.
        Returns:
        the apiVersion

      • kind

        public java.lang.String kind()
        Gets the kind. The kind of contract.
        Returns:
        the kind

      • status

        public java.lang.String status()
        Gets the status. Status of the contract test (pass or fail).
        Returns:
        the status

      • name

        public java.lang.String name()
        Gets the name. The name of the contract.
        Returns:
        the name

      • version

        public java.lang.String version()
        Gets the version. The version of the contract.
        Returns:
        the version

      • 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

      • authoritativeDefinitions

        public java.util.List<ContractAuthoritativeDefinition> authoritativeDefinitions()
        Gets the authoritativeDefinitions. List of links to sources that provide more details on the data contract.
        Returns:
        the authoritativeDefinitions

      • id

        public java.lang.String id()
        Gets the id. A unique identifier used to reduce the risk of dataset name collisions, such as a UUID.
        Returns:
        the id

      • tenant

        public java.lang.String tenant()
        Gets the tenant. Indicates the property the data is primarily associated with. Value is case insensitive.
        Returns:
        the tenant

      • dataProduct

        public java.lang.String dataProduct()
        Gets the dataProduct. Name of the data product.
        Returns:
        the dataProduct

      • contractCreatedTs

        public java.util.Date contractCreatedTs()
        Gets the contractCreatedTs. Timestamp in UTC of when the data contract was created (ISO 8601 format).
        Returns:
        the contractCreatedTs

      • tags

        public java.util.List<java.lang.String> tags()
        Gets the tags. Tags associated with the data contract.
        Returns:
        the tags