Class ModelMonitoringConfig (3.46.0)

public final class ModelMonitoringConfig extends GeneratedMessageV3 implements ModelMonitoringConfigOrBuilder

The model monitoring configuration used for Batch Prediction Job.

Protobuf type google.cloud.aiplatform.v1beta1.ModelMonitoringConfig

Static Fields

ALERT_CONFIG_FIELD_NUMBER

public static final int ALERT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

ANALYSIS_INSTANCE_SCHEMA_URI_FIELD_NUMBER

public static final int ANALYSIS_INSTANCE_SCHEMA_URI_FIELD_NUMBER
Field Value
Type Description
int

OBJECTIVE_CONFIGS_FIELD_NUMBER

public static final int OBJECTIVE_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

STATS_ANOMALIES_BASE_DIRECTORY_FIELD_NUMBER

public static final int STATS_ANOMALIES_BASE_DIRECTORY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ModelMonitoringConfig getDefaultInstance()
Returns
Type Description
ModelMonitoringConfig

getDescriptor()

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

newBuilder()

public static ModelMonitoringConfig.Builder newBuilder()
Returns
Type Description
ModelMonitoringConfig.Builder

newBuilder(ModelMonitoringConfig prototype)

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

parseDelimitedFrom(InputStream input)

public static ModelMonitoringConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelMonitoringConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ModelMonitoringConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ModelMonitoringConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ModelMonitoringConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ModelMonitoringConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ModelMonitoringConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelMonitoringConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ModelMonitoringConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ModelMonitoringConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ModelMonitoringConfig> parser()
Returns
Type Description
Parser<ModelMonitoringConfig>

Methods

equals(Object obj)

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

getAlertConfig()

public ModelMonitoringAlertConfig getAlertConfig()

Model monitoring alert config.

.google.cloud.aiplatform.v1beta1.ModelMonitoringAlertConfig alert_config = 2;

Returns
Type Description
ModelMonitoringAlertConfig

The alertConfig.

getAlertConfigOrBuilder()

public ModelMonitoringAlertConfigOrBuilder getAlertConfigOrBuilder()

Model monitoring alert config.

.google.cloud.aiplatform.v1beta1.ModelMonitoringAlertConfig alert_config = 2;

Returns
Type Description
ModelMonitoringAlertConfigOrBuilder

getAnalysisInstanceSchemaUri()

public String getAnalysisInstanceSchemaUri()

YAML schema file uri in Cloud Storage describing the format of a single instance that you want Tensorflow Data Validation (TFDV) to analyze.

If there are any data type differences between predict instance and TFDV instance, this field can be used to override the schema. For models trained with Vertex AI, this field must be set as all the fields in predict instance formatted as string.

string analysis_instance_schema_uri = 4;

Returns
Type Description
String

The analysisInstanceSchemaUri.

getAnalysisInstanceSchemaUriBytes()

public ByteString getAnalysisInstanceSchemaUriBytes()

YAML schema file uri in Cloud Storage describing the format of a single instance that you want Tensorflow Data Validation (TFDV) to analyze.

If there are any data type differences between predict instance and TFDV instance, this field can be used to override the schema. For models trained with Vertex AI, this field must be set as all the fields in predict instance formatted as string.

string analysis_instance_schema_uri = 4;

Returns
Type Description
ByteString

The bytes for analysisInstanceSchemaUri.

getDefaultInstanceForType()

public ModelMonitoringConfig getDefaultInstanceForType()
Returns
Type Description
ModelMonitoringConfig

getObjectiveConfigs(int index)

public ModelMonitoringObjectiveConfig getObjectiveConfigs(int index)

Model monitoring objective config.

repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringObjectiveConfig objective_configs = 3;

Parameter
Name Description
index int
Returns
Type Description
ModelMonitoringObjectiveConfig

getObjectiveConfigsCount()

public int getObjectiveConfigsCount()

Model monitoring objective config.

repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringObjectiveConfig objective_configs = 3;

Returns
Type Description
int

getObjectiveConfigsList()

public List<ModelMonitoringObjectiveConfig> getObjectiveConfigsList()

Model monitoring objective config.

repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringObjectiveConfig objective_configs = 3;

Returns
Type Description
List<ModelMonitoringObjectiveConfig>

getObjectiveConfigsOrBuilder(int index)

public ModelMonitoringObjectiveConfigOrBuilder getObjectiveConfigsOrBuilder(int index)

Model monitoring objective config.

repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringObjectiveConfig objective_configs = 3;

Parameter
Name Description
index int
Returns
Type Description
ModelMonitoringObjectiveConfigOrBuilder

getObjectiveConfigsOrBuilderList()

public List<? extends ModelMonitoringObjectiveConfigOrBuilder> getObjectiveConfigsOrBuilderList()

Model monitoring objective config.

repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringObjectiveConfig objective_configs = 3;

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.ModelMonitoringObjectiveConfigOrBuilder>

getParserForType()

public Parser<ModelMonitoringConfig> getParserForType()
Returns
Type Description
Parser<ModelMonitoringConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatsAnomaliesBaseDirectory()

public GcsDestination getStatsAnomaliesBaseDirectory()

A Google Cloud Storage location for batch prediction model monitoring to dump statistics and anomalies. If not provided, a folder will be created in customer project to hold statistics and anomalies.

.google.cloud.aiplatform.v1beta1.GcsDestination stats_anomalies_base_directory = 5;

Returns
Type Description
GcsDestination

The statsAnomaliesBaseDirectory.

getStatsAnomaliesBaseDirectoryOrBuilder()

public GcsDestinationOrBuilder getStatsAnomaliesBaseDirectoryOrBuilder()

A Google Cloud Storage location for batch prediction model monitoring to dump statistics and anomalies. If not provided, a folder will be created in customer project to hold statistics and anomalies.

.google.cloud.aiplatform.v1beta1.GcsDestination stats_anomalies_base_directory = 5;

Returns
Type Description
GcsDestinationOrBuilder

hasAlertConfig()

public boolean hasAlertConfig()

Model monitoring alert config.

.google.cloud.aiplatform.v1beta1.ModelMonitoringAlertConfig alert_config = 2;

Returns
Type Description
boolean

Whether the alertConfig field is set.

hasStatsAnomaliesBaseDirectory()

public boolean hasStatsAnomaliesBaseDirectory()

A Google Cloud Storage location for batch prediction model monitoring to dump statistics and anomalies. If not provided, a folder will be created in customer project to hold statistics and anomalies.

.google.cloud.aiplatform.v1beta1.GcsDestination stats_anomalies_base_directory = 5;

Returns
Type Description
boolean

Whether the statsAnomaliesBaseDirectory field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ModelMonitoringConfig.Builder newBuilderForType()
Returns
Type Description
ModelMonitoringConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ModelMonitoringConfig.Builder toBuilder()
Returns
Type Description
ModelMonitoringConfig.Builder

writeTo(CodedOutputStream output)

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