Class ModelMonitoringConfig.Builder (3.43.0)

public static final class ModelMonitoringConfig.Builder extends GeneratedMessageV3.Builder<ModelMonitoringConfig.Builder> implements ModelMonitoringConfigOrBuilder

The model monitoring configuration used for Batch Prediction Job.

Protobuf type google.cloud.aiplatform.v1beta1.ModelMonitoringConfig

Static Methods

getDescriptor()

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

Methods

addAllObjectiveConfigs(Iterable<? extends ModelMonitoringObjectiveConfig> values)

public ModelMonitoringConfig.Builder addAllObjectiveConfigs(Iterable<? extends ModelMonitoringObjectiveConfig> values)

Model monitoring objective config.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1beta1.ModelMonitoringObjectiveConfig>
Returns
Type Description
ModelMonitoringConfig.Builder

addObjectiveConfigs(ModelMonitoringObjectiveConfig value)

public ModelMonitoringConfig.Builder addObjectiveConfigs(ModelMonitoringObjectiveConfig value)

Model monitoring objective config.

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

Parameter
Name Description
value ModelMonitoringObjectiveConfig
Returns
Type Description
ModelMonitoringConfig.Builder

addObjectiveConfigs(ModelMonitoringObjectiveConfig.Builder builderForValue)

public ModelMonitoringConfig.Builder addObjectiveConfigs(ModelMonitoringObjectiveConfig.Builder builderForValue)

Model monitoring objective config.

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

Parameter
Name Description
builderForValue ModelMonitoringObjectiveConfig.Builder
Returns
Type Description
ModelMonitoringConfig.Builder

addObjectiveConfigs(int index, ModelMonitoringObjectiveConfig value)

public ModelMonitoringConfig.Builder addObjectiveConfigs(int index, ModelMonitoringObjectiveConfig value)

Model monitoring objective config.

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

Parameters
Name Description
index int
value ModelMonitoringObjectiveConfig
Returns
Type Description
ModelMonitoringConfig.Builder

addObjectiveConfigs(int index, ModelMonitoringObjectiveConfig.Builder builderForValue)

public ModelMonitoringConfig.Builder addObjectiveConfigs(int index, ModelMonitoringObjectiveConfig.Builder builderForValue)

Model monitoring objective config.

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

Parameters
Name Description
index int
builderForValue ModelMonitoringObjectiveConfig.Builder
Returns
Type Description
ModelMonitoringConfig.Builder

addObjectiveConfigsBuilder()

public ModelMonitoringObjectiveConfig.Builder addObjectiveConfigsBuilder()

Model monitoring objective config.

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

Returns
Type Description
ModelMonitoringObjectiveConfig.Builder

addObjectiveConfigsBuilder(int index)

public ModelMonitoringObjectiveConfig.Builder addObjectiveConfigsBuilder(int index)

Model monitoring objective config.

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

Parameter
Name Description
index int
Returns
Type Description
ModelMonitoringObjectiveConfig.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ModelMonitoringConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ModelMonitoringConfig.Builder
Overrides

build()

public ModelMonitoringConfig build()
Returns
Type Description
ModelMonitoringConfig

buildPartial()

public ModelMonitoringConfig buildPartial()
Returns
Type Description
ModelMonitoringConfig

clear()

public ModelMonitoringConfig.Builder clear()
Returns
Type Description
ModelMonitoringConfig.Builder
Overrides

clearAlertConfig()

public ModelMonitoringConfig.Builder clearAlertConfig()

Model monitoring alert config.

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

Returns
Type Description
ModelMonitoringConfig.Builder

clearAnalysisInstanceSchemaUri()

public ModelMonitoringConfig.Builder clearAnalysisInstanceSchemaUri()

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
ModelMonitoringConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ModelMonitoringConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ModelMonitoringConfig.Builder
Overrides

clearObjectiveConfigs()

public ModelMonitoringConfig.Builder clearObjectiveConfigs()

Model monitoring objective config.

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

Returns
Type Description
ModelMonitoringConfig.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ModelMonitoringConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ModelMonitoringConfig.Builder
Overrides

clearStatsAnomaliesBaseDirectory()

public ModelMonitoringConfig.Builder clearStatsAnomaliesBaseDirectory()

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
ModelMonitoringConfig.Builder

clone()

public ModelMonitoringConfig.Builder clone()
Returns
Type Description
ModelMonitoringConfig.Builder
Overrides

getAlertConfig()

public ModelMonitoringAlertConfig getAlertConfig()

Model monitoring alert config.

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

Returns
Type Description
ModelMonitoringAlertConfig

The alertConfig.

getAlertConfigBuilder()

public ModelMonitoringAlertConfig.Builder getAlertConfigBuilder()

Model monitoring alert config.

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

Returns
Type Description
ModelMonitoringAlertConfig.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

getObjectiveConfigsBuilder(int index)

public ModelMonitoringObjectiveConfig.Builder getObjectiveConfigsBuilder(int index)

Model monitoring objective config.

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

Parameter
Name Description
index int
Returns
Type Description
ModelMonitoringObjectiveConfig.Builder

getObjectiveConfigsBuilderList()

public List<ModelMonitoringObjectiveConfig.Builder> getObjectiveConfigsBuilderList()

Model monitoring objective config.

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

Returns
Type Description
List<Builder>

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>

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.

getStatsAnomaliesBaseDirectoryBuilder()

public GcsDestination.Builder getStatsAnomaliesBaseDirectoryBuilder()

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.Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAlertConfig(ModelMonitoringAlertConfig value)

public ModelMonitoringConfig.Builder mergeAlertConfig(ModelMonitoringAlertConfig value)

Model monitoring alert config.

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

Parameter
Name Description
value ModelMonitoringAlertConfig
Returns
Type Description
ModelMonitoringConfig.Builder

mergeFrom(ModelMonitoringConfig other)

public ModelMonitoringConfig.Builder mergeFrom(ModelMonitoringConfig other)
Parameter
Name Description
other ModelMonitoringConfig
Returns
Type Description
ModelMonitoringConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ModelMonitoringConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelMonitoringConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ModelMonitoringConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ModelMonitoringConfig.Builder
Overrides

mergeStatsAnomaliesBaseDirectory(GcsDestination value)

public ModelMonitoringConfig.Builder mergeStatsAnomaliesBaseDirectory(GcsDestination value)

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;

Parameter
Name Description
value GcsDestination
Returns
Type Description
ModelMonitoringConfig.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ModelMonitoringConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ModelMonitoringConfig.Builder
Overrides

removeObjectiveConfigs(int index)

public ModelMonitoringConfig.Builder removeObjectiveConfigs(int index)

Model monitoring objective config.

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

Parameter
Name Description
index int
Returns
Type Description
ModelMonitoringConfig.Builder

setAlertConfig(ModelMonitoringAlertConfig value)

public ModelMonitoringConfig.Builder setAlertConfig(ModelMonitoringAlertConfig value)

Model monitoring alert config.

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

Parameter
Name Description
value ModelMonitoringAlertConfig
Returns
Type Description
ModelMonitoringConfig.Builder

setAlertConfig(ModelMonitoringAlertConfig.Builder builderForValue)

public ModelMonitoringConfig.Builder setAlertConfig(ModelMonitoringAlertConfig.Builder builderForValue)

Model monitoring alert config.

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

Parameter
Name Description
builderForValue ModelMonitoringAlertConfig.Builder
Returns
Type Description
ModelMonitoringConfig.Builder

setAnalysisInstanceSchemaUri(String value)

public ModelMonitoringConfig.Builder setAnalysisInstanceSchemaUri(String value)

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;

Parameter
Name Description
value String

The analysisInstanceSchemaUri to set.

Returns
Type Description
ModelMonitoringConfig.Builder

This builder for chaining.

setAnalysisInstanceSchemaUriBytes(ByteString value)

public ModelMonitoringConfig.Builder setAnalysisInstanceSchemaUriBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for analysisInstanceSchemaUri to set.

Returns
Type Description
ModelMonitoringConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ModelMonitoringConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ModelMonitoringConfig.Builder
Overrides

setObjectiveConfigs(int index, ModelMonitoringObjectiveConfig value)

public ModelMonitoringConfig.Builder setObjectiveConfigs(int index, ModelMonitoringObjectiveConfig value)

Model monitoring objective config.

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

Parameters
Name Description
index int
value ModelMonitoringObjectiveConfig
Returns
Type Description
ModelMonitoringConfig.Builder

setObjectiveConfigs(int index, ModelMonitoringObjectiveConfig.Builder builderForValue)

public ModelMonitoringConfig.Builder setObjectiveConfigs(int index, ModelMonitoringObjectiveConfig.Builder builderForValue)

Model monitoring objective config.

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

Parameters
Name Description
index int
builderForValue ModelMonitoringObjectiveConfig.Builder
Returns
Type Description
ModelMonitoringConfig.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ModelMonitoringConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ModelMonitoringConfig.Builder
Overrides

setStatsAnomaliesBaseDirectory(GcsDestination value)

public ModelMonitoringConfig.Builder setStatsAnomaliesBaseDirectory(GcsDestination value)

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;

Parameter
Name Description
value GcsDestination
Returns
Type Description
ModelMonitoringConfig.Builder

setStatsAnomaliesBaseDirectory(GcsDestination.Builder builderForValue)

public ModelMonitoringConfig.Builder setStatsAnomaliesBaseDirectory(GcsDestination.Builder builderForValue)

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;

Parameter
Name Description
builderForValue GcsDestination.Builder
Returns
Type Description
ModelMonitoringConfig.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ModelMonitoringConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ModelMonitoringConfig.Builder
Overrides