Class Type.Builder

  • Enclosing class:
    Type

    public static class Type.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • key

        public Type.Builder key​(String key)
        Unique type key that is immutable.
        Parameters:
        key - the value to set
        Returns:
        this builder
      • name

        public Type.Builder name​(String name)
        The immutable name of the type.
        Parameters:
        name - the value to set
        Returns:
        this builder
      • description

        public Type.Builder description​(String description)
        Detailed description of the type.
        Parameters:
        description - the value to set
        Returns:
        this builder
      • catalogId

        public Type.Builder catalogId​(String catalogId)
        The data catalog’s OCID.
        Parameters:
        catalogId - the value to set
        Returns:
        this builder
      • properties

        public Type.Builder properties​(Map<String,​List<PropertyDefinition>> properties)
        A map of arrays which defines the type specific properties, both required and optional.

        The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the “default” category. Example: { “properties”: { “default”: { “attributes:”: [ { “name”: “host”, “type”: “string”, “isRequired”: true, “isUpdatable”: false }, … ] } } }

        Parameters:
        properties - the value to set
        Returns:
        this builder
      • lifecycleState

        public Type.Builder lifecycleState​(LifecycleState lifecycleState)
        The current state of the type.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder
      • isInternal

        public Type.Builder isInternal​(Boolean isInternal)
        Indicates whether the type is internal, making it unavailable for use by metadata elements.
        Parameters:
        isInternal - the value to set
        Returns:
        this builder
      • isTag

        public Type.Builder isTag​(Boolean isTag)
        Indicates whether the type can be used for tagging metadata elements.
        Parameters:
        isTag - the value to set
        Returns:
        this builder
      • isApproved

        public Type.Builder isApproved​(Boolean isApproved)
        Indicates whether the type is approved for use as a classifying object.
        Parameters:
        isApproved - the value to set
        Returns:
        this builder
      • typeCategory

        public Type.Builder typeCategory​(String typeCategory)
        Indicates the category this type belongs to.

        For instance, data assets, connections.

        Parameters:
        typeCategory - the value to set
        Returns:
        this builder
      • externalTypeName

        public Type.Builder externalTypeName​(String externalTypeName)
        Mapping type equivalence in the external system.
        Parameters:
        externalTypeName - the value to set
        Returns:
        this builder
      • uri

        public Type.Builder uri​(String uri)
        URI to the type instance in the API.
        Parameters:
        uri - the value to set
        Returns:
        this builder
      • customProperties

        public Type.Builder customProperties​(List<CustomPropertySummary> customProperties)
        Custom properties associated with this Type.
        Parameters:
        customProperties - the value to set
        Returns:
        this builder
      • parentTypeKey

        public Type.Builder parentTypeKey​(String parentTypeKey)
        Unique key of the parent type.
        Parameters:
        parentTypeKey - the value to set
        Returns:
        this builder
      • parentTypeName

        public Type.Builder parentTypeName​(String parentTypeName)
        Name of the parent type.
        Parameters:
        parentTypeName - the value to set
        Returns:
        this builder
      • build

        public Type build()