Class ModelMonitoringObjectiveSpec.DataDriftSpec (3.56.0)

public static final class ModelMonitoringObjectiveSpec.DataDriftSpec extends GeneratedMessageV3 implements ModelMonitoringObjectiveSpec.DataDriftSpecOrBuilder

Data drift monitoring spec. Data drift measures the distribution distance between the current dataset and a baseline dataset. A typical use case is to detect data drift between the recent production serving dataset and the training dataset, or to compare the recent production dataset with a dataset from a previous period.

Protobuf type google.cloud.aiplatform.v1beta1.ModelMonitoringObjectiveSpec.DataDriftSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ModelMonitoringObjectiveSpec.DataDriftSpec

Static Fields

CATEGORICAL_METRIC_TYPE_FIELD_NUMBER

public static final int CATEGORICAL_METRIC_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_CATEGORICAL_ALERT_CONDITION_FIELD_NUMBER

public static final int DEFAULT_CATEGORICAL_ALERT_CONDITION_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_NUMERIC_ALERT_CONDITION_FIELD_NUMBER

public static final int DEFAULT_NUMERIC_ALERT_CONDITION_FIELD_NUMBER
Field Value
Type Description
int

FEATURES_FIELD_NUMBER

public static final int FEATURES_FIELD_NUMBER
Field Value
Type Description
int

FEATURE_ALERT_CONDITIONS_FIELD_NUMBER

public static final int FEATURE_ALERT_CONDITIONS_FIELD_NUMBER
Field Value
Type Description
int

NUMERIC_METRIC_TYPE_FIELD_NUMBER

public static final int NUMERIC_METRIC_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ModelMonitoringObjectiveSpec.DataDriftSpec getDefaultInstance()
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ModelMonitoringObjectiveSpec.DataDriftSpec.Builder newBuilder()
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec.Builder

newBuilder(ModelMonitoringObjectiveSpec.DataDriftSpec prototype)

public static ModelMonitoringObjectiveSpec.DataDriftSpec.Builder newBuilder(ModelMonitoringObjectiveSpec.DataDriftSpec prototype)
Parameter
Name Description
prototype ModelMonitoringObjectiveSpec.DataDriftSpec
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec.Builder

parseDelimitedFrom(InputStream input)

public static ModelMonitoringObjectiveSpec.DataDriftSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringObjectiveSpec.DataDriftSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ModelMonitoringObjectiveSpec.DataDriftSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringObjectiveSpec.DataDriftSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ModelMonitoringObjectiveSpec.DataDriftSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringObjectiveSpec.DataDriftSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ModelMonitoringObjectiveSpec.DataDriftSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringObjectiveSpec.DataDriftSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ModelMonitoringObjectiveSpec.DataDriftSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringObjectiveSpec.DataDriftSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ModelMonitoringObjectiveSpec.DataDriftSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringObjectiveSpec.DataDriftSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ModelMonitoringObjectiveSpec.DataDriftSpec> parser()
Returns
Type Description
Parser<DataDriftSpec>

Methods

containsFeatureAlertConditions(String key)

public boolean containsFeatureAlertConditions(String key)

Per feature alert condition will override default alert condition.

map<string, .google.cloud.aiplatform.v1beta1.ModelMonitoringAlertCondition> feature_alert_conditions = 6;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCategoricalMetricType()

public String getCategoricalMetricType()

Supported metrics type:

  • l_infinity
  • jensen_shannon_divergence

string categorical_metric_type = 2;

Returns
Type Description
String

The categoricalMetricType.

getCategoricalMetricTypeBytes()

public ByteString getCategoricalMetricTypeBytes()

Supported metrics type:

  • l_infinity
  • jensen_shannon_divergence

string categorical_metric_type = 2;

Returns
Type Description
ByteString

The bytes for categoricalMetricType.

getDefaultCategoricalAlertCondition()

public ModelMonitoringAlertCondition getDefaultCategoricalAlertCondition()

Default alert condition for all the categorical features.

.google.cloud.aiplatform.v1beta1.ModelMonitoringAlertCondition default_categorical_alert_condition = 4;

Returns
Type Description
ModelMonitoringAlertCondition

The defaultCategoricalAlertCondition.

getDefaultCategoricalAlertConditionOrBuilder()

public ModelMonitoringAlertConditionOrBuilder getDefaultCategoricalAlertConditionOrBuilder()

Default alert condition for all the categorical features.

.google.cloud.aiplatform.v1beta1.ModelMonitoringAlertCondition default_categorical_alert_condition = 4;

Returns
Type Description
ModelMonitoringAlertConditionOrBuilder

getDefaultInstanceForType()

public ModelMonitoringObjectiveSpec.DataDriftSpec getDefaultInstanceForType()
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec

getDefaultNumericAlertCondition()

public ModelMonitoringAlertCondition getDefaultNumericAlertCondition()

Default alert condition for all the numeric features.

.google.cloud.aiplatform.v1beta1.ModelMonitoringAlertCondition default_numeric_alert_condition = 5;

Returns
Type Description
ModelMonitoringAlertCondition

The defaultNumericAlertCondition.

getDefaultNumericAlertConditionOrBuilder()

public ModelMonitoringAlertConditionOrBuilder getDefaultNumericAlertConditionOrBuilder()

Default alert condition for all the numeric features.

.google.cloud.aiplatform.v1beta1.ModelMonitoringAlertCondition default_numeric_alert_condition = 5;

Returns
Type Description
ModelMonitoringAlertConditionOrBuilder

getFeatureAlertConditions() (deprecated)

public Map<String,ModelMonitoringAlertCondition> getFeatureAlertConditions()
Returns
Type Description
Map<String,ModelMonitoringAlertCondition>

getFeatureAlertConditionsCount()

public int getFeatureAlertConditionsCount()

Per feature alert condition will override default alert condition.

map<string, .google.cloud.aiplatform.v1beta1.ModelMonitoringAlertCondition> feature_alert_conditions = 6;

Returns
Type Description
int

getFeatureAlertConditionsMap()

public Map<String,ModelMonitoringAlertCondition> getFeatureAlertConditionsMap()

Per feature alert condition will override default alert condition.

map<string, .google.cloud.aiplatform.v1beta1.ModelMonitoringAlertCondition> feature_alert_conditions = 6;

Returns
Type Description
Map<String,ModelMonitoringAlertCondition>

getFeatureAlertConditionsOrDefault(String key, ModelMonitoringAlertCondition defaultValue)

public ModelMonitoringAlertCondition getFeatureAlertConditionsOrDefault(String key, ModelMonitoringAlertCondition defaultValue)

Per feature alert condition will override default alert condition.

map<string, .google.cloud.aiplatform.v1beta1.ModelMonitoringAlertCondition> feature_alert_conditions = 6;

Parameters
Name Description
key String
defaultValue ModelMonitoringAlertCondition
Returns
Type Description
ModelMonitoringAlertCondition

getFeatureAlertConditionsOrThrow(String key)

public ModelMonitoringAlertCondition getFeatureAlertConditionsOrThrow(String key)

Per feature alert condition will override default alert condition.

map<string, .google.cloud.aiplatform.v1beta1.ModelMonitoringAlertCondition> feature_alert_conditions = 6;

Parameter
Name Description
key String
Returns
Type Description
ModelMonitoringAlertCondition

getFeatures(int index)

public String getFeatures(int index)

Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.

repeated string features = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The features at the given index.

getFeaturesBytes(int index)

public ByteString getFeaturesBytes(int index)

Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.

repeated string features = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the features at the given index.

getFeaturesCount()

public int getFeaturesCount()

Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.

repeated string features = 1;

Returns
Type Description
int

The count of features.

getFeaturesList()

public ProtocolStringList getFeaturesList()

Feature names / Prediction output names interested in monitoring. These should be a subset of the input feature names or prediction output names specified in the monitoring schema. If the field is not specified all features / prediction outputs outlied in the monitoring schema will be used.

repeated string features = 1;

Returns
Type Description
ProtocolStringList

A list containing the features.

getNumericMetricType()

public String getNumericMetricType()

Supported metrics type:

  • jensen_shannon_divergence

string numeric_metric_type = 3;

Returns
Type Description
String

The numericMetricType.

getNumericMetricTypeBytes()

public ByteString getNumericMetricTypeBytes()

Supported metrics type:

  • jensen_shannon_divergence

string numeric_metric_type = 3;

Returns
Type Description
ByteString

The bytes for numericMetricType.

getParserForType()

public Parser<ModelMonitoringObjectiveSpec.DataDriftSpec> getParserForType()
Returns
Type Description
Parser<DataDriftSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDefaultCategoricalAlertCondition()

public boolean hasDefaultCategoricalAlertCondition()

Default alert condition for all the categorical features.

.google.cloud.aiplatform.v1beta1.ModelMonitoringAlertCondition default_categorical_alert_condition = 4;

Returns
Type Description
boolean

Whether the defaultCategoricalAlertCondition field is set.

hasDefaultNumericAlertCondition()

public boolean hasDefaultNumericAlertCondition()

Default alert condition for all the numeric features.

.google.cloud.aiplatform.v1beta1.ModelMonitoringAlertCondition default_numeric_alert_condition = 5;

Returns
Type Description
boolean

Whether the defaultNumericAlertCondition field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ModelMonitoringObjectiveSpec.DataDriftSpec.Builder newBuilderForType()
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ModelMonitoringObjectiveSpec.DataDriftSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ModelMonitoringObjectiveSpec.DataDriftSpec.Builder toBuilder()
Returns
Type Description
ModelMonitoringObjectiveSpec.DataDriftSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException