Class SchemaMetadata

    • Constructor Detail

      • SchemaMetadata

        public SchemaMetadata()
    • Method Detail

      • get__type

        @NotNull
        public @NotNull java.lang.String get__type()
        Name of this subclass in SimpleClassName format
        Returns:
        __type
      • schemaName

        public SchemaMetadata schemaName​(java.lang.String schemaName)
      • getSchemaName

        @NotNull
        public @NotNull java.lang.String getSchemaName()
        Schema name e.g. PageViewEvent, identity.Profile, ams.account_management_tracking
        Returns:
        schemaName
      • setSchemaName

        public void setSchemaName​(java.lang.String schemaName)
      • platform

        public SchemaMetadata platform​(java.lang.String platform)
      • getPlatform

        @NotNull
        public @NotNull java.lang.String getPlatform()
        Standardized platform urn where schema is defined. The data platform Urn (urn:li:platform:{platform_name})
        Returns:
        platform
      • setPlatform

        public void setPlatform​(java.lang.String platform)
      • getVersion

        @NotNull
        @Min(-9223372036854775808L)
        @Max(9223372036854775807L)
        public @NotNull @Min(-9223372036854775808L) @Max(9223372036854775807L) java.lang.Long getVersion()
        Every change to SchemaMetadata in the resource results in a new version. Version is server assigned. This version is differ from platform native schema version. minimum: -9223372036854775808 maximum: 9223372036854775807
        Returns:
        version
      • setVersion

        public void setVersion​(java.lang.Long version)
      • getCreated

        @NotNull
        @Valid
        public @NotNull @Valid AuditStamp getCreated()
        Get created
        Returns:
        created
      • setCreated

        public void setCreated​(AuditStamp created)
      • getLastModified

        @NotNull
        @Valid
        public @NotNull @Valid AuditStamp getLastModified()
        Get lastModified
        Returns:
        lastModified
      • setLastModified

        public void setLastModified​(AuditStamp lastModified)
      • getDeleted

        @Valid
        public @Valid AuditStamp getDeleted()
        Get deleted
        Returns:
        deleted
      • setDeleted

        public void setDeleted​(AuditStamp deleted)
      • dataset

        public SchemaMetadata dataset​(java.lang.String dataset)
      • getDataset

        public java.lang.String getDataset()
        Dataset this schema metadata is associated with.
        Returns:
        dataset
      • setDataset

        public void setDataset​(java.lang.String dataset)
      • cluster

        public SchemaMetadata cluster​(java.lang.String cluster)
      • getCluster

        public java.lang.String getCluster()
        The cluster this schema metadata resides from
        Returns:
        cluster
      • setCluster

        public void setCluster​(java.lang.String cluster)
      • getHash

        @NotNull
        public @NotNull java.lang.String getHash()
        the SHA1 hash of the schema content
        Returns:
        hash
      • setHash

        public void setHash​(java.lang.String hash)
      • getPlatformSchema

        @NotNull
        public @NotNull OneOfSchemaMetadataPlatformSchema getPlatformSchema()
        The native schema in the dataset's platform.
        Returns:
        platformSchema
      • getFields

        @NotNull
        @Valid
        public @NotNull @Valid java.util.List<SchemaField> getFields()
        Client provided a list of fields from document schema.
        Returns:
        fields
      • setFields

        public void setFields​(java.util.List<SchemaField> fields)
      • primaryKeys

        public SchemaMetadata primaryKeys​(java.util.List<java.lang.String> primaryKeys)
      • addPrimaryKeysItem

        public SchemaMetadata addPrimaryKeysItem​(java.lang.String primaryKeysItem)
      • getPrimaryKeys

        public java.util.List<java.lang.String> getPrimaryKeys()
        Client provided list of fields that define primary keys to access record. Field order defines hierarchical espresso keys. Empty lists indicates absence of primary key access patter. Value is a SchemaField@fieldPath.
        Returns:
        primaryKeys
      • setPrimaryKeys

        public void setPrimaryKeys​(java.util.List<java.lang.String> primaryKeys)
      • getForeignKeysSpecs

        @Valid
        public @Valid java.util.Map<java.lang.String,​ForeignKeySpec> getForeignKeysSpecs()
        Map captures all the references schema makes to external datasets. Map key is ForeignKeySpecName typeref.
        Returns:
        foreignKeysSpecs
      • setForeignKeysSpecs

        public void setForeignKeysSpecs​(java.util.Map<java.lang.String,​ForeignKeySpec> foreignKeysSpecs)
      • getForeignKeys

        @Valid
        public @Valid java.util.List<ForeignKeyConstraint> getForeignKeys()
        List of foreign key constraints for the schema
        Returns:
        foreignKeys
      • 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