com.whylogs.core

Class DatasetProfile

java.lang.Object

com.whylogs.core.DatasetProfile

All Implemented Interfaces:

java.io.Serializable

public class DatasetProfile
extends java.lang.Object
implements java.io.Serializable

Representing a DatasetProfile that tracks

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DatasetProfile(java.lang.String sessionId, java.time.Instant sessionTimestamp)
DatasetProfile(@NonNull java.lang.String sessionId, @NonNull java.time.Instant sessionTimestamp, java.time.Instant dataTimestamp, @NonNull java.util.Map<java.lang.String,java.lang.String> tags, @NonNull java.util.Map<java.lang.String,ColumnProfile> columns) DEVELOPER API.
DatasetProfile(@NonNull java.lang.String sessionId, @NonNull java.time.Instant sessionTimestamp, @NonNull java.util.Map<java.lang.String,java.lang.String> tags) Create a new Dataset profile

Method Summary

Modifier and Type	Method and Description
static DatasetProfile	fromProtobuf(com.whylogs.core.message.DatasetProfileMessage message)
java.util.Map<java.lang.String,ColumnProfile>	getColumns()
DatasetProfile	merge(@NonNull DatasetProfile other)
java.util.Iterator<com.whylogs.core.message.MessageSegment>	toChunkIterator()
com.whylogs.core.message.DatasetProfileMessage.Builder	toProtobuf()
com.whylogs.core.message.DatasetSummary	toSummary()
void	track(java.util.Map<java.lang.String,?> columns)
void	track(java.lang.String columnName, java.lang.Object data)
DatasetProfile	withAllMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)
DatasetProfile	withMetadata(java.lang.String key, java.lang.String value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DatasetProfile

public DatasetProfile(@NonNull
                      @NonNull java.lang.String sessionId,
                      @NonNull
                      @NonNull java.time.Instant sessionTimestamp,
                      @Nullable
                      java.time.Instant dataTimestamp,
                      @NonNull
                      @NonNull java.util.Map<java.lang.String,java.lang.String> tags,
                      @NonNull
                      @NonNull java.util.Map<java.lang.String,ColumnProfile> columns)

DEVELOPER API. DO NOT USE DIRECTLY

Parameters:

sessionId - dataset name

sessionTimestamp - the timestamp for the current profiling session

dataTimestamp - the timestamp for the dataset. Used to aggregate across different cadences

tags - tags of the dataset

columns - the columns that we're copying over. Note that the source of columns should stop using these column objects as they will back this DatasetProfile instead

DatasetProfile

public DatasetProfile(@NonNull
                      @NonNull java.lang.String sessionId,
                      @NonNull
                      @NonNull java.time.Instant sessionTimestamp,
                      @NonNull
                      @NonNull java.util.Map<java.lang.String,java.lang.String> tags)

Create a new Dataset profile

Parameters:

sessionId - the name of the dataset profile

sessionTimestamp - the timestamp for this run

tags - the tags to track the dataset with

DatasetProfile

public DatasetProfile(java.lang.String sessionId,
                      java.time.Instant sessionTimestamp)

Method Detail

getColumns

public java.util.Map<java.lang.String,ColumnProfile> getColumns()

withMetadata

public DatasetProfile withMetadata(java.lang.String key,
                                   java.lang.String value)

withAllMetadata

public DatasetProfile withAllMetadata(java.util.Map<java.lang.String,java.lang.String> metadata)

track

public void track(java.lang.String columnName,
                  java.lang.Object data)

track

public void track(java.util.Map<java.lang.String,?> columns)

toSummary

public com.whylogs.core.message.DatasetSummary toSummary()

toChunkIterator

public java.util.Iterator<com.whylogs.core.message.MessageSegment> toChunkIterator()

merge

public DatasetProfile merge(@NonNull
                            @NonNull DatasetProfile other)

toProtobuf

public com.whylogs.core.message.DatasetProfileMessage.Builder toProtobuf()

fromProtobuf

public static DatasetProfile fromProtobuf(com.whylogs.core.message.DatasetProfileMessage message)