Package com.google.cloud.aiplatform.v1beta1

Class ModelMonitor

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1beta1.ModelMonitor
All Implemented Interfaces:
ModelMonitorOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ModelMonitor extends com.google.protobuf.GeneratedMessage implements ModelMonitorOrBuilder
 Vertex AI Model Monitoring Service serves as a central hub for the analysis
 and visualization of data quality and performance related to models.
 ModelMonitor stands as a top level resource for overseeing your model
 monitoring tasks.
Protobuf type google.cloud.aiplatform.v1beta1.ModelMonitor
See Also:

  • Field Details

    • TABULAR_OBJECTIVE_FIELD_NUMBER

      public static final int TABULAR_OBJECTIVE_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • MODEL_MONITORING_TARGET_FIELD_NUMBER

      public static final int MODEL_MONITORING_TARGET_FIELD_NUMBER
      See Also:

    • TRAINING_DATASET_FIELD_NUMBER

      public static final int TRAINING_DATASET_FIELD_NUMBER
      See Also:

    • NOTIFICATION_SPEC_FIELD_NUMBER

      public static final int NOTIFICATION_SPEC_FIELD_NUMBER
      See Also:

    • OUTPUT_SPEC_FIELD_NUMBER

      public static final int OUTPUT_SPEC_FIELD_NUMBER
      See Also:

    • EXPLANATION_SPEC_FIELD_NUMBER

      public static final int EXPLANATION_SPEC_FIELD_NUMBER
      See Also:

    • MODEL_MONITORING_SCHEMA_FIELD_NUMBER

      public static final int MODEL_MONITORING_SCHEMA_FIELD_NUMBER
      See Also:

    • ENCRYPTION_SPEC_FIELD_NUMBER

      public static final int ENCRYPTION_SPEC_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • SATISFIES_PZS_FIELD_NUMBER

      public static final int SATISFIES_PZS_FIELD_NUMBER
      See Also:

    • SATISFIES_PZI_FIELD_NUMBER

      public static final int SATISFIES_PZI_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getDefaultObjectiveCase

      public ModelMonitor.DefaultObjectiveCase getDefaultObjectiveCase()
      Specified by:
      getDefaultObjectiveCase in interface ModelMonitorOrBuilder

    • hasTabularObjective

      public boolean hasTabularObjective()
       Optional default tabular model monitoring objective.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringObjectiveSpec.TabularObjective tabular_objective = 11;
      Specified by:
      hasTabularObjective in interface ModelMonitorOrBuilder
      Returns:
      Whether the tabularObjective field is set.

    • getTabularObjective

      public ModelMonitoringObjectiveSpec.TabularObjective getTabularObjective()
       Optional default tabular model monitoring objective.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringObjectiveSpec.TabularObjective tabular_objective = 11;
      Specified by:
      getTabularObjective in interface ModelMonitorOrBuilder
      Returns:
      The tabularObjective.

    • getTabularObjectiveOrBuilder

      public ModelMonitoringObjectiveSpec.TabularObjectiveOrBuilder getTabularObjectiveOrBuilder()
       Optional default tabular model monitoring objective.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringObjectiveSpec.TabularObjective tabular_objective = 11;
      Specified by:
      getTabularObjectiveOrBuilder in interface ModelMonitorOrBuilder

    • getName

      public String getName()
       Immutable. Resource name of the ModelMonitor. Format:
 `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getName in interface ModelMonitorOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Immutable. Resource name of the ModelMonitor. Format:
 `projects/{project}/locations/{location}/modelMonitors/{model_monitor}`.
      string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
      Specified by:
      getNameBytes in interface ModelMonitorOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       The display name of the ModelMonitor.
 The name can be up to 128 characters long and can consist of any UTF-8.
      string display_name = 2;
      Specified by:
      getDisplayName in interface ModelMonitorOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       The display name of the ModelMonitor.
 The name can be up to 128 characters long and can consist of any UTF-8.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface ModelMonitorOrBuilder
      Returns:
      The bytes for displayName.

    • hasModelMonitoringTarget

      public boolean hasModelMonitoringTarget()
       The entity that is subject to analysis.
 Currently only models in Vertex AI Model Registry are supported. If you
 want to analyze the model which is outside the Vertex AI, you could
 register a model in Vertex AI Model Registry using just a display name.
      .google.cloud.aiplatform.v1beta1.ModelMonitor.ModelMonitoringTarget model_monitoring_target = 3;
      Specified by:
      hasModelMonitoringTarget in interface ModelMonitorOrBuilder
      Returns:
      Whether the modelMonitoringTarget field is set.

    • getModelMonitoringTarget

      public ModelMonitor.ModelMonitoringTarget getModelMonitoringTarget()
       The entity that is subject to analysis.
 Currently only models in Vertex AI Model Registry are supported. If you
 want to analyze the model which is outside the Vertex AI, you could
 register a model in Vertex AI Model Registry using just a display name.
      .google.cloud.aiplatform.v1beta1.ModelMonitor.ModelMonitoringTarget model_monitoring_target = 3;
      Specified by:
      getModelMonitoringTarget in interface ModelMonitorOrBuilder
      Returns:
      The modelMonitoringTarget.

    • getModelMonitoringTargetOrBuilder

      public ModelMonitor.ModelMonitoringTargetOrBuilder getModelMonitoringTargetOrBuilder()
       The entity that is subject to analysis.
 Currently only models in Vertex AI Model Registry are supported. If you
 want to analyze the model which is outside the Vertex AI, you could
 register a model in Vertex AI Model Registry using just a display name.
      .google.cloud.aiplatform.v1beta1.ModelMonitor.ModelMonitoringTarget model_monitoring_target = 3;
      Specified by:
      getModelMonitoringTargetOrBuilder in interface ModelMonitorOrBuilder

    • hasTrainingDataset

      public boolean hasTrainingDataset()
       Optional training dataset used to train the model.
 It can serve as a reference dataset to identify changes in production.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringInput training_dataset = 10;
      Specified by:
      hasTrainingDataset in interface ModelMonitorOrBuilder
      Returns:
      Whether the trainingDataset field is set.

    • getTrainingDataset

      public ModelMonitoringInput getTrainingDataset()
       Optional training dataset used to train the model.
 It can serve as a reference dataset to identify changes in production.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringInput training_dataset = 10;
      Specified by:
      getTrainingDataset in interface ModelMonitorOrBuilder
      Returns:
      The trainingDataset.

    • getTrainingDatasetOrBuilder

      public ModelMonitoringInputOrBuilder getTrainingDatasetOrBuilder()
       Optional training dataset used to train the model.
 It can serve as a reference dataset to identify changes in production.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringInput training_dataset = 10;
      Specified by:
      getTrainingDatasetOrBuilder in interface ModelMonitorOrBuilder

    • hasNotificationSpec

      public boolean hasNotificationSpec()
       Optional default notification spec, it can be overridden in the
 ModelMonitoringJob notification spec.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringNotificationSpec notification_spec = 12;
      Specified by:
      hasNotificationSpec in interface ModelMonitorOrBuilder
      Returns:
      Whether the notificationSpec field is set.

    • getNotificationSpec

      public ModelMonitoringNotificationSpec getNotificationSpec()
       Optional default notification spec, it can be overridden in the
 ModelMonitoringJob notification spec.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringNotificationSpec notification_spec = 12;
      Specified by:
      getNotificationSpec in interface ModelMonitorOrBuilder
      Returns:
      The notificationSpec.

    • getNotificationSpecOrBuilder

      public ModelMonitoringNotificationSpecOrBuilder getNotificationSpecOrBuilder()
       Optional default notification spec, it can be overridden in the
 ModelMonitoringJob notification spec.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringNotificationSpec notification_spec = 12;
      Specified by:
      getNotificationSpecOrBuilder in interface ModelMonitorOrBuilder

    • hasOutputSpec

      public boolean hasOutputSpec()
       Optional default monitoring metrics/logs export spec, it can be overridden
 in the ModelMonitoringJob output spec.
 If not specified, a default Google Cloud Storage bucket will be created
 under your project.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringOutputSpec output_spec = 13;
      Specified by:
      hasOutputSpec in interface ModelMonitorOrBuilder
      Returns:
      Whether the outputSpec field is set.

    • getOutputSpec

      public ModelMonitoringOutputSpec getOutputSpec()
       Optional default monitoring metrics/logs export spec, it can be overridden
 in the ModelMonitoringJob output spec.
 If not specified, a default Google Cloud Storage bucket will be created
 under your project.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringOutputSpec output_spec = 13;
      Specified by:
      getOutputSpec in interface ModelMonitorOrBuilder
      Returns:
      The outputSpec.

    • getOutputSpecOrBuilder

      public ModelMonitoringOutputSpecOrBuilder getOutputSpecOrBuilder()
       Optional default monitoring metrics/logs export spec, it can be overridden
 in the ModelMonitoringJob output spec.
 If not specified, a default Google Cloud Storage bucket will be created
 under your project.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringOutputSpec output_spec = 13;
      Specified by:
      getOutputSpecOrBuilder in interface ModelMonitorOrBuilder

    • hasExplanationSpec

      public boolean hasExplanationSpec()
       Optional model explanation spec. It is used for feature attribution
 monitoring.
      .google.cloud.aiplatform.v1beta1.ExplanationSpec explanation_spec = 16;
      Specified by:
      hasExplanationSpec in interface ModelMonitorOrBuilder
      Returns:
      Whether the explanationSpec field is set.

    • getExplanationSpec

      public ExplanationSpec getExplanationSpec()
       Optional model explanation spec. It is used for feature attribution
 monitoring.
      .google.cloud.aiplatform.v1beta1.ExplanationSpec explanation_spec = 16;
      Specified by:
      getExplanationSpec in interface ModelMonitorOrBuilder
      Returns:
      The explanationSpec.

    • getExplanationSpecOrBuilder

      public ExplanationSpecOrBuilder getExplanationSpecOrBuilder()
       Optional model explanation spec. It is used for feature attribution
 monitoring.
      .google.cloud.aiplatform.v1beta1.ExplanationSpec explanation_spec = 16;
      Specified by:
      getExplanationSpecOrBuilder in interface ModelMonitorOrBuilder

    • hasModelMonitoringSchema

      public boolean hasModelMonitoringSchema()
       Monitoring Schema is to specify the model's features, prediction outputs
 and ground truth properties. It is used to extract pertinent data from the
 dataset and to process features based on their properties.
 Make sure that the schema aligns with your dataset, if it does not, we will
 be unable to extract data from the dataset.
 It is required for most models, but optional for Vertex AI AutoML Tables
 unless the schem information is not available.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringSchema model_monitoring_schema = 9;
      Specified by:
      hasModelMonitoringSchema in interface ModelMonitorOrBuilder
      Returns:
      Whether the modelMonitoringSchema field is set.

    • getModelMonitoringSchema

      public ModelMonitoringSchema getModelMonitoringSchema()
       Monitoring Schema is to specify the model's features, prediction outputs
 and ground truth properties. It is used to extract pertinent data from the
 dataset and to process features based on their properties.
 Make sure that the schema aligns with your dataset, if it does not, we will
 be unable to extract data from the dataset.
 It is required for most models, but optional for Vertex AI AutoML Tables
 unless the schem information is not available.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringSchema model_monitoring_schema = 9;
      Specified by:
      getModelMonitoringSchema in interface ModelMonitorOrBuilder
      Returns:
      The modelMonitoringSchema.

    • getModelMonitoringSchemaOrBuilder

      public ModelMonitoringSchemaOrBuilder getModelMonitoringSchemaOrBuilder()
       Monitoring Schema is to specify the model's features, prediction outputs
 and ground truth properties. It is used to extract pertinent data from the
 dataset and to process features based on their properties.
 Make sure that the schema aligns with your dataset, if it does not, we will
 be unable to extract data from the dataset.
 It is required for most models, but optional for Vertex AI AutoML Tables
 unless the schem information is not available.
      .google.cloud.aiplatform.v1beta1.ModelMonitoringSchema model_monitoring_schema = 9;
      Specified by:
      getModelMonitoringSchemaOrBuilder in interface ModelMonitorOrBuilder

    • hasEncryptionSpec

      public boolean hasEncryptionSpec()
       Customer-managed encryption key spec for a ModelMonitor. If
 set, this ModelMonitor and all sub-resources of this
 ModelMonitor will be secured by this key.
      .google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 5;
      Specified by:
      hasEncryptionSpec in interface ModelMonitorOrBuilder
      Returns:
      Whether the encryptionSpec field is set.

    • getEncryptionSpec

      public EncryptionSpec getEncryptionSpec()
       Customer-managed encryption key spec for a ModelMonitor. If
 set, this ModelMonitor and all sub-resources of this
 ModelMonitor will be secured by this key.
      .google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 5;
      Specified by:
      getEncryptionSpec in interface ModelMonitorOrBuilder
      Returns:
      The encryptionSpec.

    • getEncryptionSpecOrBuilder

      public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
       Customer-managed encryption key spec for a ModelMonitor. If
 set, this ModelMonitor and all sub-resources of this
 ModelMonitor will be secured by this key.
      .google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 5;
      Specified by:
      getEncryptionSpecOrBuilder in interface ModelMonitorOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp when this ModelMonitor was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface ModelMonitorOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp when this ModelMonitor was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface ModelMonitorOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp when this ModelMonitor was created.
      .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface ModelMonitorOrBuilder

    • hasUpdateTime

      public boolean hasUpdateTime()
       Output only. Timestamp when this ModelMonitor was updated most recently.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasUpdateTime in interface ModelMonitorOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public com.google.protobuf.Timestamp getUpdateTime()
       Output only. Timestamp when this ModelMonitor was updated most recently.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTime in interface ModelMonitorOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Timestamp when this ModelMonitor was updated most recently.
      .google.protobuf.Timestamp update_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getUpdateTimeOrBuilder in interface ModelMonitorOrBuilder

    • getSatisfiesPzs

      public boolean getSatisfiesPzs()
       Output only. Reserved for future use.
      bool satisfies_pzs = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzs in interface ModelMonitorOrBuilder
      Returns:
      The satisfiesPzs.

    • getSatisfiesPzi

      public boolean getSatisfiesPzi()
       Output only. Reserved for future use.
      bool satisfies_pzi = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzi in interface ModelMonitorOrBuilder
      Returns:
      The satisfiesPzi.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static ModelMonitor parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static ModelMonitor parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static ModelMonitor parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ModelMonitor.Builder newBuilder()

    • newBuilder

      public static ModelMonitor.Builder newBuilder(ModelMonitor prototype)

    • toBuilder

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

    • newBuilderForType

      protected ModelMonitor.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ModelMonitor getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<ModelMonitor> 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.GeneratedMessage

    • getDefaultInstanceForType

      public ModelMonitor getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder