Package com.google.cloud.aiplatform.v1beta1

Class ModelMonitoringConfig

  • All Implemented Interfaces:
    ModelMonitoringConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ModelMonitoringConfig
extends com.google.protobuf.GeneratedMessageV3
implements ModelMonitoringConfigOrBuilder
     The model monitoring configuration used for Batch Prediction Job.
    Protobuf type google.cloud.aiplatform.v1beta1.ModelMonitoringConfig
    See Also:
    Serialized Form

    • Field Detail

      • OBJECTIVE_CONFIGS_FIELD_NUMBER

        public static final int OBJECTIVE_CONFIGS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ALERT_CONFIG_FIELD_NUMBER

        public static final int ALERT_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ANALYSIS_INSTANCE_SCHEMA_URI_FIELD_NUMBER

        public static final int ANALYSIS_INSTANCE_SCHEMA_URI_FIELD_NUMBER
        See Also:
        Constant Field Values

      • STATS_ANOMALIES_BASE_DIRECTORY_FIELD_NUMBER

        public static final int STATS_ANOMALIES_BASE_DIRECTORY_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

      • getObjectiveConfigsCount

        public int getObjectiveConfigsCount()
         Model monitoring objective config.
        repeated .google.cloud.aiplatform.v1beta1.ModelMonitoringObjectiveConfig objective_configs = 3;
        Specified by:
        getObjectiveConfigsCount in interface ModelMonitoringConfigOrBuilder

      • hasAlertConfig

        public boolean hasAlertConfig()
         Model monitoring alert config.
        .google.cloud.aiplatform.v1beta1.ModelMonitoringAlertConfig alert_config = 2;
        Specified by:
        hasAlertConfig in interface ModelMonitoringConfigOrBuilder
        Returns:
        Whether the alertConfig field is set.

      • 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;
        Specified by:
        getAnalysisInstanceSchemaUri in interface ModelMonitoringConfigOrBuilder
        Returns:
        The analysisInstanceSchemaUri.

      • getAnalysisInstanceSchemaUriBytes

        public com.google.protobuf.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;
        Specified by:
        getAnalysisInstanceSchemaUriBytes in interface ModelMonitoringConfigOrBuilder
        Returns:
        The bytes for analysisInstanceSchemaUri.

      • 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;
        Specified by:
        hasStatsAnomaliesBaseDirectory in interface ModelMonitoringConfigOrBuilder
        Returns:
        Whether the statsAnomaliesBaseDirectory field is set.

      • 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;
        Specified by:
        getStatsAnomaliesBaseDirectory in interface ModelMonitoringConfigOrBuilder
        Returns:
        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;
        Specified by:
        getStatsAnomaliesBaseDirectoryOrBuilder in interface ModelMonitoringConfigOrBuilder

      • 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 ModelMonitoringConfig parseFrom​(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelMonitoringConfig parseFrom​(ByteBuffer data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelMonitoringConfig parseFrom​(com.google.protobuf.ByteString data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelMonitoringConfig parseFrom​(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelMonitoringConfig parseFrom​(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelMonitoringConfig parseFrom​(byte[] data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

        public ModelMonitoringConfig.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ModelMonitoringConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ModelMonitoringConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ModelMonitoringConfig> 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 ModelMonitoringConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder