com.google.cloud.aiplatform.v1beta1

Class FeatureStatsAndAnomaly

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.FeatureStatsAndAnomaly

All Implemented Interfaces:

FeatureStatsAndAnomalyOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class FeatureStatsAndAnomaly
extends com.google.protobuf.GeneratedMessageV3
implements FeatureStatsAndAnomalyOrBuilder

 Stats and Anomaly generated by FeatureMonitorJobs. Anomaly only includes
 Drift.
 

Protobuf type google.cloud.aiplatform.v1beta1.FeatureStatsAndAnomaly

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FeatureStatsAndAnomaly.Builder Stats and Anomaly generated by FeatureMonitorJobs.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISTRIBUTION_DEVIATION_FIELD_NUMBER
static int	DRIFT_DETECTED_FIELD_NUMBER
static int	DRIFT_DETECTION_THRESHOLD_FIELD_NUMBER
static int	FEATURE_ID_FIELD_NUMBER
static int	FEATURE_MONITOR_ID_FIELD_NUMBER
static int	FEATURE_MONITOR_JOB_ID_FIELD_NUMBER
static int	FEATURE_STATS_FIELD_NUMBER
static int	STATS_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static FeatureStatsAndAnomaly	getDefaultInstance()
FeatureStatsAndAnomaly	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
double	getDistributionDeviation() Deviation from the current stats to baseline stats. 1.
boolean	getDriftDetected() If set to true, indicates current stats is detected as and comparing with baseline stats.
double	getDriftDetectionThreshold() This is the threshold used when detecting drifts, which is set in FeatureMonitor.FeatureSelectionConfig.FeatureConfig.drift_threshold double drift_detection_threshold = 4;
String	getFeatureId() Feature Id.
com.google.protobuf.ByteString	getFeatureIdBytes() Feature Id.
String	getFeatureMonitorId() The ID of the FeatureMonitor that this FeatureStatsAndAnomaly generated according to.
com.google.protobuf.ByteString	getFeatureMonitorIdBytes() The ID of the FeatureMonitor that this FeatureStatsAndAnomaly generated according to.
long	getFeatureMonitorJobId() The ID of the FeatureMonitorJob that generated this FeatureStatsAndAnomaly.
com.google.protobuf.Value	getFeatureStats() Feature stats. e.g. histogram buckets.
com.google.protobuf.ValueOrBuilder	getFeatureStatsOrBuilder() Feature stats. e.g. histogram buckets.
com.google.protobuf.Parser<FeatureStatsAndAnomaly>	getParserForType()
int	getSerializedSize()
com.google.protobuf.Timestamp	getStatsTime() The timestamp we take snapshot for feature values to generate stats.
com.google.protobuf.TimestampOrBuilder	getStatsTimeOrBuilder() The timestamp we take snapshot for feature values to generate stats.
boolean	hasFeatureStats() Feature stats. e.g. histogram buckets.
int	hashCode()
boolean	hasStatsTime() The timestamp we take snapshot for feature values to generate stats.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static FeatureStatsAndAnomaly.Builder	newBuilder()
static FeatureStatsAndAnomaly.Builder	newBuilder(FeatureStatsAndAnomaly prototype)
FeatureStatsAndAnomaly.Builder	newBuilderForType()
protected FeatureStatsAndAnomaly.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FeatureStatsAndAnomaly	parseDelimitedFrom(InputStream input)
static FeatureStatsAndAnomaly	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FeatureStatsAndAnomaly	parseFrom(byte[] data)
static FeatureStatsAndAnomaly	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FeatureStatsAndAnomaly	parseFrom(ByteBuffer data)
static FeatureStatsAndAnomaly	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FeatureStatsAndAnomaly	parseFrom(com.google.protobuf.ByteString data)
static FeatureStatsAndAnomaly	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FeatureStatsAndAnomaly	parseFrom(com.google.protobuf.CodedInputStream input)
static FeatureStatsAndAnomaly	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FeatureStatsAndAnomaly	parseFrom(InputStream input)
static FeatureStatsAndAnomaly	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FeatureStatsAndAnomaly>	parser()
FeatureStatsAndAnomaly.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FEATURE_ID_FIELD_NUMBER

public static final int FEATURE_ID_FIELD_NUMBER

See Also:

Constant Field Values

FEATURE_STATS_FIELD_NUMBER

public static final int FEATURE_STATS_FIELD_NUMBER

See Also:

Constant Field Values

DISTRIBUTION_DEVIATION_FIELD_NUMBER

public static final int DISTRIBUTION_DEVIATION_FIELD_NUMBER

See Also:

Constant Field Values

DRIFT_DETECTION_THRESHOLD_FIELD_NUMBER

public static final int DRIFT_DETECTION_THRESHOLD_FIELD_NUMBER

See Also:

Constant Field Values

DRIFT_DETECTED_FIELD_NUMBER

public static final int DRIFT_DETECTED_FIELD_NUMBER

See Also:

Constant Field Values

STATS_TIME_FIELD_NUMBER

public static final int STATS_TIME_FIELD_NUMBER

See Also:

Constant Field Values

FEATURE_MONITOR_JOB_ID_FIELD_NUMBER

public static final int FEATURE_MONITOR_JOB_ID_FIELD_NUMBER

See Also:

Constant Field Values

FEATURE_MONITOR_ID_FIELD_NUMBER

public static final int FEATURE_MONITOR_ID_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getFeatureId

public String getFeatureId()

 Feature Id.
 

string feature_id = 1;

Specified by:

getFeatureId in interface FeatureStatsAndAnomalyOrBuilder

Returns:

The featureId.

getFeatureIdBytes

public com.google.protobuf.ByteString getFeatureIdBytes()

 Feature Id.
 

string feature_id = 1;

Specified by:

getFeatureIdBytes in interface FeatureStatsAndAnomalyOrBuilder

Returns:

The bytes for featureId.

hasFeatureStats

public boolean hasFeatureStats()

 Feature stats. e.g. histogram buckets.
 In the format of tensorflow.metadata.v0.DatasetFeatureStatistics.
 

.google.protobuf.Value feature_stats = 2;

Specified by:

hasFeatureStats in interface FeatureStatsAndAnomalyOrBuilder

Returns:

Whether the featureStats field is set.

getFeatureStats

public com.google.protobuf.Value getFeatureStats()

 Feature stats. e.g. histogram buckets.
 In the format of tensorflow.metadata.v0.DatasetFeatureStatistics.
 

.google.protobuf.Value feature_stats = 2;

Specified by:

getFeatureStats in interface FeatureStatsAndAnomalyOrBuilder

Returns:

The featureStats.

getFeatureStatsOrBuilder

public com.google.protobuf.ValueOrBuilder getFeatureStatsOrBuilder()

 Feature stats. e.g. histogram buckets.
 In the format of tensorflow.metadata.v0.DatasetFeatureStatistics.
 

.google.protobuf.Value feature_stats = 2;

Specified by:

getFeatureStatsOrBuilder in interface FeatureStatsAndAnomalyOrBuilder

getDistributionDeviation

public double getDistributionDeviation()

 Deviation from the current stats to baseline stats.
   1. For categorical feature, the distribution distance is calculated by
      L-inifinity norm.
   2. For numerical feature, the distribution distance is calculated by
      Jensen–Shannon divergence.
 

double distribution_deviation = 3;

Specified by:

getDistributionDeviation in interface FeatureStatsAndAnomalyOrBuilder

Returns:

The distributionDeviation.

getDriftDetectionThreshold

public double getDriftDetectionThreshold()

 This is the threshold used when detecting drifts, which is set in
 FeatureMonitor.FeatureSelectionConfig.FeatureConfig.drift_threshold
 

double drift_detection_threshold = 4;

Specified by:

getDriftDetectionThreshold in interface FeatureStatsAndAnomalyOrBuilder

Returns:

The driftDetectionThreshold.

getDriftDetected

public boolean getDriftDetected()

 If set to true, indicates current stats is detected as and comparing
 with baseline stats.
 

bool drift_detected = 5;

Specified by:

getDriftDetected in interface FeatureStatsAndAnomalyOrBuilder

Returns:

The driftDetected.

hasStatsTime

public boolean hasStatsTime()

 The timestamp we take snapshot for feature values to generate stats.
 

.google.protobuf.Timestamp stats_time = 6;

Specified by:

hasStatsTime in interface FeatureStatsAndAnomalyOrBuilder

Returns:

Whether the statsTime field is set.

getStatsTime

public com.google.protobuf.Timestamp getStatsTime()

 The timestamp we take snapshot for feature values to generate stats.
 

.google.protobuf.Timestamp stats_time = 6;

Specified by:

getStatsTime in interface FeatureStatsAndAnomalyOrBuilder

Returns:

The statsTime.

getStatsTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getStatsTimeOrBuilder()

 The timestamp we take snapshot for feature values to generate stats.
 

.google.protobuf.Timestamp stats_time = 6;

Specified by:

getStatsTimeOrBuilder in interface FeatureStatsAndAnomalyOrBuilder

getFeatureMonitorJobId

public long getFeatureMonitorJobId()

 The ID of the FeatureMonitorJob that generated this FeatureStatsAndAnomaly.
 

int64 feature_monitor_job_id = 7;

Specified by:

getFeatureMonitorJobId in interface FeatureStatsAndAnomalyOrBuilder

Returns:

The featureMonitorJobId.

getFeatureMonitorId

public String getFeatureMonitorId()

 The ID of the FeatureMonitor that this FeatureStatsAndAnomaly generated
 according to.
 

string feature_monitor_id = 8;

Specified by:

getFeatureMonitorId in interface FeatureStatsAndAnomalyOrBuilder

Returns:

The featureMonitorId.

getFeatureMonitorIdBytes

public com.google.protobuf.ByteString getFeatureMonitorIdBytes()

 The ID of the FeatureMonitor that this FeatureStatsAndAnomaly generated
 according to.
 

string feature_monitor_id = 8;

Specified by:

getFeatureMonitorIdBytes in interface FeatureStatsAndAnomalyOrBuilder

Returns:

The bytes for featureMonitorId.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static FeatureStatsAndAnomaly parseFrom(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FeatureStatsAndAnomaly parseFrom(ByteBuffer data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FeatureStatsAndAnomaly parseFrom(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FeatureStatsAndAnomaly parseFrom(com.google.protobuf.ByteString data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FeatureStatsAndAnomaly parseFrom(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FeatureStatsAndAnomaly parseFrom(byte[] data,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FeatureStatsAndAnomaly parseFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static FeatureStatsAndAnomaly parseFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static FeatureStatsAndAnomaly parseDelimitedFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static FeatureStatsAndAnomaly parseDelimitedFrom(InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

parseFrom

public static FeatureStatsAndAnomaly parseFrom(com.google.protobuf.CodedInputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static FeatureStatsAndAnomaly parseFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

newBuilderForType

public FeatureStatsAndAnomaly.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FeatureStatsAndAnomaly.Builder newBuilder()

newBuilder

public static FeatureStatsAndAnomaly.Builder newBuilder(FeatureStatsAndAnomaly prototype)

toBuilder

public FeatureStatsAndAnomaly.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected FeatureStatsAndAnomaly.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FeatureStatsAndAnomaly getDefaultInstance()

parser

public static com.google.protobuf.Parser<FeatureStatsAndAnomaly> parser()

getParserForType

public com.google.protobuf.Parser<FeatureStatsAndAnomaly> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public FeatureStatsAndAnomaly getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder