Package io.datahubproject.openapi.generated

Class SchemaField

  • @Validated
@Generated(value="io.swagger.codegen.v3.generators.java.SpringCodegen",
           date="2023-05-10T05:58:32.374063Z[Etc/UTC]")
public class SchemaField
extends java.lang.Object
    SchemaField to describe metadata related to dataset schema.

    • Constructor Detail

      • SchemaField

        public SchemaField()

    • Method Detail

      • fieldPath

        public SchemaField fieldPath​(java.lang.String fieldPath)

      • getFieldPath

        @NotNull
public @NotNull java.lang.String getFieldPath()
        Flattened name of the field. Field is computed from jsonPath field.
        Returns:
        fieldPath

      • setFieldPath

        public void setFieldPath​(java.lang.String fieldPath)

      • jsonPath

        public SchemaField jsonPath​(java.lang.String jsonPath)

      • getJsonPath

        public java.lang.String getJsonPath()
        Flattened name of a field in JSON Path notation.
        Returns:
        jsonPath

      • setJsonPath

        public void setJsonPath​(java.lang.String jsonPath)

      • nullable

        public SchemaField nullable​(java.lang.Boolean nullable)

      • isNullable

        @NotNull
public @NotNull java.lang.Boolean isNullable()
        Indicates if this field is optional or nullable
        Returns:
        nullable

      • setNullable

        public void setNullable​(java.lang.Boolean nullable)

      • description

        public SchemaField description​(java.lang.String description)

      • getDescription

        public java.lang.String getDescription()
        Description
        Returns:
        description

      • setDescription

        public void setDescription​(java.lang.String description)

      • label

        public SchemaField label​(java.lang.String label)

      • getLabel

        public java.lang.String getLabel()
        Label of the field. Provides a more human-readable name for the field than field path. Some sources will provide this metadata but not all sources have the concept of a label. If just one string is associated with a field in a source, that is most likely a description.
        Returns:
        label

      • setLabel

        public void setLabel​(java.lang.String label)

      • getCreated

        @Valid
public @Valid AuditStamp getCreated()
        Get created
        Returns:
        created

      • setCreated

        public void setCreated​(AuditStamp created)

      • getLastModified

        @Valid
public @Valid AuditStamp getLastModified()
        Get lastModified
        Returns:
        lastModified

      • setLastModified

        public void setLastModified​(AuditStamp lastModified)

      • getType

        @NotNull
@Valid
public @NotNull @Valid SchemaFieldDataType getType()
        Get type
        Returns:
        type

      • nativeDataType

        public SchemaField nativeDataType​(java.lang.String nativeDataType)

      • getNativeDataType

        @NotNull
public @NotNull java.lang.String getNativeDataType()
        The native type of the field in the dataset's platform as declared by platform schema.
        Returns:
        nativeDataType

      • setNativeDataType

        public void setNativeDataType​(java.lang.String nativeDataType)

      • recursive

        public SchemaField recursive​(java.lang.Boolean recursive)

      • isRecursive

        @NotNull
public @NotNull java.lang.Boolean isRecursive()
        There are use cases when a field in type B references type A. A field in A references field of type B. In such cases, we will mark the first field as recursive.
        Returns:
        recursive

      • setRecursive

        public void setRecursive​(java.lang.Boolean recursive)

      • getGlobalTags

        @Valid
public @Valid GlobalTags getGlobalTags()
        Get globalTags
        Returns:
        globalTags

      • setGlobalTags

        public void setGlobalTags​(GlobalTags globalTags)

      • getGlossaryTerms

        @Valid
public @Valid GlossaryTerms getGlossaryTerms()
        Get glossaryTerms
        Returns:
        glossaryTerms

      • setGlossaryTerms

        public void setGlossaryTerms​(GlossaryTerms glossaryTerms)

      • isPartOfKey

        public SchemaField isPartOfKey​(java.lang.Boolean isPartOfKey)

      • isIsPartOfKey

        @NotNull
public @NotNull java.lang.Boolean isIsPartOfKey()
        For schema fields that are part of complex keys, set this field to true We do this to easily distinguish between value and key fields
        Returns:
        isPartOfKey

      • setIsPartOfKey

        public void setIsPartOfKey​(java.lang.Boolean isPartOfKey)

      • isPartitioningKey

        public SchemaField isPartitioningKey​(java.lang.Boolean isPartitioningKey)

      • isIsPartitioningKey

        public java.lang.Boolean isIsPartitioningKey()
        For Datasets which are partitioned, this determines the partitioning key.
        Returns:
        isPartitioningKey

      • setIsPartitioningKey

        public void setIsPartitioningKey​(java.lang.Boolean isPartitioningKey)

      • jsonProps

        public SchemaField jsonProps​(java.lang.String jsonProps)

      • getJsonProps

        public java.lang.String getJsonProps()
        For schema fields that have other properties that are not modeled explicitly, use this field to serialize those properties into a JSON string
        Returns:
        jsonProps

      • setJsonProps

        public void setJsonProps​(java.lang.String jsonProps)

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object