Package com.google.cloud.aiplatform.v1

Class ModelDeploymentMonitoringJob

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob
All Implemented Interfaces:
ModelDeploymentMonitoringJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ModelDeploymentMonitoringJob extends com.google.protobuf.GeneratedMessage implements ModelDeploymentMonitoringJobOrBuilder
 Represents a job that runs periodically to monitor the deployed models in an
 endpoint. It will analyze the logged training & prediction data to detect any
 abnormal behaviors.
Protobuf type google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob
See Also:

  • Field Details

    • 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:

    • ENDPOINT_FIELD_NUMBER

      public static final int ENDPOINT_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • SCHEDULE_STATE_FIELD_NUMBER

      public static final int SCHEDULE_STATE_FIELD_NUMBER
      See Also:

    • LATEST_MONITORING_PIPELINE_METADATA_FIELD_NUMBER

      public static final int LATEST_MONITORING_PIPELINE_METADATA_FIELD_NUMBER
      See Also:

    • MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_CONFIGS_FIELD_NUMBER

      public static final int MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_CONFIGS_FIELD_NUMBER
      See Also:

    • MODEL_DEPLOYMENT_MONITORING_SCHEDULE_CONFIG_FIELD_NUMBER

      public static final int MODEL_DEPLOYMENT_MONITORING_SCHEDULE_CONFIG_FIELD_NUMBER
      See Also:

    • LOGGING_SAMPLING_STRATEGY_FIELD_NUMBER

      public static final int LOGGING_SAMPLING_STRATEGY_FIELD_NUMBER
      See Also:

    • MODEL_MONITORING_ALERT_CONFIG_FIELD_NUMBER

      public static final int MODEL_MONITORING_ALERT_CONFIG_FIELD_NUMBER
      See Also:

    • PREDICT_INSTANCE_SCHEMA_URI_FIELD_NUMBER

      public static final int PREDICT_INSTANCE_SCHEMA_URI_FIELD_NUMBER
      See Also:

    • SAMPLE_PREDICT_INSTANCE_FIELD_NUMBER

      public static final int SAMPLE_PREDICT_INSTANCE_FIELD_NUMBER
      See Also:

    • ANALYSIS_INSTANCE_SCHEMA_URI_FIELD_NUMBER

      public static final int ANALYSIS_INSTANCE_SCHEMA_URI_FIELD_NUMBER
      See Also:

    • BIGQUERY_TABLES_FIELD_NUMBER

      public static final int BIGQUERY_TABLES_FIELD_NUMBER
      See Also:

    • LOG_TTL_FIELD_NUMBER

      public static final int LOG_TTL_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

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

    • NEXT_SCHEDULE_TIME_FIELD_NUMBER

      public static final int NEXT_SCHEDULE_TIME_FIELD_NUMBER
      See Also:

    • STATS_ANOMALIES_BASE_DIRECTORY_FIELD_NUMBER

      public static final int STATS_ANOMALIES_BASE_DIRECTORY_FIELD_NUMBER
      See Also:

    • ENCRYPTION_SPEC_FIELD_NUMBER

      public static final int ENCRYPTION_SPEC_FIELD_NUMBER
      See Also:

    • ENABLE_MONITORING_PIPELINE_LOGS_FIELD_NUMBER

      public static final int ENABLE_MONITORING_PIPELINE_LOGS_FIELD_NUMBER
      See Also:

    • ERROR_FIELD_NUMBER

      public static final int ERROR_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()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Output only. Resource name of a ModelDeploymentMonitoringJob.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getName in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Output only. Resource name of a ModelDeploymentMonitoringJob.
      string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNameBytes in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The bytes for name.

    • getDisplayName

      public String getDisplayName()
       Required. The user-defined name of the ModelDeploymentMonitoringJob.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
 Display name of a ModelDeploymentMonitoringJob.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayName in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Required. The user-defined name of the ModelDeploymentMonitoringJob.
 The name can be up to 128 characters long and can consist of any UTF-8
 characters.
 Display name of a ModelDeploymentMonitoringJob.
      string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getDisplayNameBytes in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The bytes for displayName.

    • getEndpoint

      public String getEndpoint()
       Required. Endpoint resource name.
 Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
      string endpoint = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getEndpoint in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The endpoint.

    • getEndpointBytes

      public com.google.protobuf.ByteString getEndpointBytes()
       Required. Endpoint resource name.
 Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
      string endpoint = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getEndpointBytes in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The bytes for endpoint.

    • getStateValue

      public int getStateValue()
       Output only. The detailed state of the monitoring job.
 When the job is still creating, the state will be 'PENDING'.
 Once the job is successfully created, the state will be 'RUNNING'.
 Pause the job, the state will be 'PAUSED'.
 Resume the job, the state will return to 'RUNNING'.
      .google.cloud.aiplatform.v1.JobState state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public JobState getState()
       Output only. The detailed state of the monitoring job.
 When the job is still creating, the state will be 'PENDING'.
 Once the job is successfully created, the state will be 'RUNNING'.
 Pause the job, the state will be 'PAUSED'.
 Resume the job, the state will return to 'RUNNING'.
      .google.cloud.aiplatform.v1.JobState state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The state.

    • getScheduleStateValue

      public int getScheduleStateValue()
       Output only. Schedule state when the monitoring job is in Running state.
      .google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.MonitoringScheduleState schedule_state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getScheduleStateValue in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The enum numeric value on the wire for scheduleState.

    • getScheduleState

      public ModelDeploymentMonitoringJob.MonitoringScheduleState getScheduleState()
       Output only. Schedule state when the monitoring job is in Running state.
      .google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.MonitoringScheduleState schedule_state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getScheduleState in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The scheduleState.

    • hasLatestMonitoringPipelineMetadata

      public boolean hasLatestMonitoringPipelineMetadata()
       Output only. Latest triggered monitoring pipeline metadata.
      .google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasLatestMonitoringPipelineMetadata in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      Whether the latestMonitoringPipelineMetadata field is set.

    • getLatestMonitoringPipelineMetadata

      public ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata getLatestMonitoringPipelineMetadata()
       Output only. Latest triggered monitoring pipeline metadata.
      .google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLatestMonitoringPipelineMetadata in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The latestMonitoringPipelineMetadata.

    • getLatestMonitoringPipelineMetadataOrBuilder

      public ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadataOrBuilder getLatestMonitoringPipelineMetadataOrBuilder()
       Output only. Latest triggered monitoring pipeline metadata.
      .google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getLatestMonitoringPipelineMetadataOrBuilder in interface ModelDeploymentMonitoringJobOrBuilder

    • getModelDeploymentMonitoringObjectiveConfigsList

      public List<ModelDeploymentMonitoringObjectiveConfig> getModelDeploymentMonitoringObjectiveConfigsList()
       Required. The config for monitoring objectives. This is a per DeployedModel
 config. Each DeployedModel needs to be configured separately.
      repeated .google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getModelDeploymentMonitoringObjectiveConfigsList in interface ModelDeploymentMonitoringJobOrBuilder

    • getModelDeploymentMonitoringObjectiveConfigsOrBuilderList

      public List<? extends ModelDeploymentMonitoringObjectiveConfigOrBuilder> getModelDeploymentMonitoringObjectiveConfigsOrBuilderList()
       Required. The config for monitoring objectives. This is a per DeployedModel
 config. Each DeployedModel needs to be configured separately.
      repeated .google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getModelDeploymentMonitoringObjectiveConfigsOrBuilderList in interface ModelDeploymentMonitoringJobOrBuilder

    • getModelDeploymentMonitoringObjectiveConfigsCount

      public int getModelDeploymentMonitoringObjectiveConfigsCount()
       Required. The config for monitoring objectives. This is a per DeployedModel
 config. Each DeployedModel needs to be configured separately.
      repeated .google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getModelDeploymentMonitoringObjectiveConfigsCount in interface ModelDeploymentMonitoringJobOrBuilder

    • getModelDeploymentMonitoringObjectiveConfigs

      public ModelDeploymentMonitoringObjectiveConfig getModelDeploymentMonitoringObjectiveConfigs(int index)
       Required. The config for monitoring objectives. This is a per DeployedModel
 config. Each DeployedModel needs to be configured separately.
      repeated .google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getModelDeploymentMonitoringObjectiveConfigs in interface ModelDeploymentMonitoringJobOrBuilder

    • getModelDeploymentMonitoringObjectiveConfigsOrBuilder

      public ModelDeploymentMonitoringObjectiveConfigOrBuilder getModelDeploymentMonitoringObjectiveConfigsOrBuilder(int index)
       Required. The config for monitoring objectives. This is a per DeployedModel
 config. Each DeployedModel needs to be configured separately.
      repeated .google.cloud.aiplatform.v1.ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getModelDeploymentMonitoringObjectiveConfigsOrBuilder in interface ModelDeploymentMonitoringJobOrBuilder

    • hasModelDeploymentMonitoringScheduleConfig

      public boolean hasModelDeploymentMonitoringScheduleConfig()
       Required. Schedule config for running the monitoring job.
      .google.cloud.aiplatform.v1.ModelDeploymentMonitoringScheduleConfig model_deployment_monitoring_schedule_config = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasModelDeploymentMonitoringScheduleConfig in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      Whether the modelDeploymentMonitoringScheduleConfig field is set.

    • getModelDeploymentMonitoringScheduleConfig

      public ModelDeploymentMonitoringScheduleConfig getModelDeploymentMonitoringScheduleConfig()
       Required. Schedule config for running the monitoring job.
      .google.cloud.aiplatform.v1.ModelDeploymentMonitoringScheduleConfig model_deployment_monitoring_schedule_config = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getModelDeploymentMonitoringScheduleConfig in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The modelDeploymentMonitoringScheduleConfig.

    • getModelDeploymentMonitoringScheduleConfigOrBuilder

      public ModelDeploymentMonitoringScheduleConfigOrBuilder getModelDeploymentMonitoringScheduleConfigOrBuilder()
       Required. Schedule config for running the monitoring job.
      .google.cloud.aiplatform.v1.ModelDeploymentMonitoringScheduleConfig model_deployment_monitoring_schedule_config = 7 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getModelDeploymentMonitoringScheduleConfigOrBuilder in interface ModelDeploymentMonitoringJobOrBuilder

    • hasLoggingSamplingStrategy

      public boolean hasLoggingSamplingStrategy()
       Required. Sample Strategy for logging.
      .google.cloud.aiplatform.v1.SamplingStrategy logging_sampling_strategy = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasLoggingSamplingStrategy in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      Whether the loggingSamplingStrategy field is set.

    • getLoggingSamplingStrategy

      public SamplingStrategy getLoggingSamplingStrategy()
       Required. Sample Strategy for logging.
      .google.cloud.aiplatform.v1.SamplingStrategy logging_sampling_strategy = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getLoggingSamplingStrategy in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The loggingSamplingStrategy.

    • getLoggingSamplingStrategyOrBuilder

      public SamplingStrategyOrBuilder getLoggingSamplingStrategyOrBuilder()
       Required. Sample Strategy for logging.
      .google.cloud.aiplatform.v1.SamplingStrategy logging_sampling_strategy = 8 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getLoggingSamplingStrategyOrBuilder in interface ModelDeploymentMonitoringJobOrBuilder

    • hasModelMonitoringAlertConfig

      public boolean hasModelMonitoringAlertConfig()
       Alert config for model monitoring.
      .google.cloud.aiplatform.v1.ModelMonitoringAlertConfig model_monitoring_alert_config = 15;
      Specified by:
      hasModelMonitoringAlertConfig in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      Whether the modelMonitoringAlertConfig field is set.

    • getModelMonitoringAlertConfig

      public ModelMonitoringAlertConfig getModelMonitoringAlertConfig()
       Alert config for model monitoring.
      .google.cloud.aiplatform.v1.ModelMonitoringAlertConfig model_monitoring_alert_config = 15;
      Specified by:
      getModelMonitoringAlertConfig in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The modelMonitoringAlertConfig.

    • getModelMonitoringAlertConfigOrBuilder

      public ModelMonitoringAlertConfigOrBuilder getModelMonitoringAlertConfigOrBuilder()
       Alert config for model monitoring.
      .google.cloud.aiplatform.v1.ModelMonitoringAlertConfig model_monitoring_alert_config = 15;
      Specified by:
      getModelMonitoringAlertConfigOrBuilder in interface ModelDeploymentMonitoringJobOrBuilder

    • getPredictInstanceSchemaUri

      public String getPredictInstanceSchemaUri()
       YAML schema file uri describing the format of a single instance,
 which are given to format this Endpoint's prediction (and explanation).
 If not set, we will generate predict schema from collected predict
 requests.
      string predict_instance_schema_uri = 9;
      Specified by:
      getPredictInstanceSchemaUri in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The predictInstanceSchemaUri.

    • getPredictInstanceSchemaUriBytes

      public com.google.protobuf.ByteString getPredictInstanceSchemaUriBytes()
       YAML schema file uri describing the format of a single instance,
 which are given to format this Endpoint's prediction (and explanation).
 If not set, we will generate predict schema from collected predict
 requests.
      string predict_instance_schema_uri = 9;
      Specified by:
      getPredictInstanceSchemaUriBytes in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The bytes for predictInstanceSchemaUri.

    • hasSamplePredictInstance

      public boolean hasSamplePredictInstance()
       Sample Predict instance, same format as
 [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
 this can be set as a replacement of
 [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.predict_instance_schema_uri].
 If not set, we will generate predict schema from collected predict
 requests.
      .google.protobuf.Value sample_predict_instance = 19;
      Specified by:
      hasSamplePredictInstance in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      Whether the samplePredictInstance field is set.

    • getSamplePredictInstance

      public com.google.protobuf.Value getSamplePredictInstance()
       Sample Predict instance, same format as
 [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
 this can be set as a replacement of
 [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.predict_instance_schema_uri].
 If not set, we will generate predict schema from collected predict
 requests.
      .google.protobuf.Value sample_predict_instance = 19;
      Specified by:
      getSamplePredictInstance in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The samplePredictInstance.

    • getSamplePredictInstanceOrBuilder

      public com.google.protobuf.ValueOrBuilder getSamplePredictInstanceOrBuilder()
       Sample Predict instance, same format as
 [PredictRequest.instances][google.cloud.aiplatform.v1.PredictRequest.instances],
 this can be set as a replacement of
 [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.predict_instance_schema_uri].
 If not set, we will generate predict schema from collected predict
 requests.
      .google.protobuf.Value sample_predict_instance = 19;
      Specified by:
      getSamplePredictInstanceOrBuilder in interface ModelDeploymentMonitoringJobOrBuilder

    • getAnalysisInstanceSchemaUri

      public String getAnalysisInstanceSchemaUri()
       YAML schema file uri describing the format of a single instance that you
 want Tensorflow Data Validation (TFDV) to analyze.

 If this field is empty, all the feature data types are inferred from
 [predict_instance_schema_uri][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.predict_instance_schema_uri],
 meaning that TFDV will use the data in the exact format(data type) as
 prediction request/response.
 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 = 16;
      Specified by:
      getAnalysisInstanceSchemaUri in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The analysisInstanceSchemaUri.

    • getAnalysisInstanceSchemaUriBytes

      public com.google.protobuf.ByteString getAnalysisInstanceSchemaUriBytes()
       YAML schema file uri describing the format of a single instance that you
 want Tensorflow Data Validation (TFDV) to analyze.

 If this field is empty, all the feature data types are inferred from
 [predict_instance_schema_uri][google.cloud.aiplatform.v1.ModelDeploymentMonitoringJob.predict_instance_schema_uri],
 meaning that TFDV will use the data in the exact format(data type) as
 prediction request/response.
 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 = 16;
      Specified by:
      getAnalysisInstanceSchemaUriBytes in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The bytes for analysisInstanceSchemaUri.

    • getBigqueryTablesList

      public List<ModelDeploymentMonitoringBigQueryTable> getBigqueryTablesList()
       Output only. The created bigquery tables for the job under customer
 project. Customer could do their own query & analysis. There could be 4 log
 tables in maximum:
 1. Training data logging predict request/response
 2. Serving data logging predict request/response
      repeated .google.cloud.aiplatform.v1.ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getBigqueryTablesList in interface ModelDeploymentMonitoringJobOrBuilder

    • getBigqueryTablesOrBuilderList

      public List<? extends ModelDeploymentMonitoringBigQueryTableOrBuilder> getBigqueryTablesOrBuilderList()
       Output only. The created bigquery tables for the job under customer
 project. Customer could do their own query & analysis. There could be 4 log
 tables in maximum:
 1. Training data logging predict request/response
 2. Serving data logging predict request/response
      repeated .google.cloud.aiplatform.v1.ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getBigqueryTablesOrBuilderList in interface ModelDeploymentMonitoringJobOrBuilder

    • getBigqueryTablesCount

      public int getBigqueryTablesCount()
       Output only. The created bigquery tables for the job under customer
 project. Customer could do their own query & analysis. There could be 4 log
 tables in maximum:
 1. Training data logging predict request/response
 2. Serving data logging predict request/response
      repeated .google.cloud.aiplatform.v1.ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getBigqueryTablesCount in interface ModelDeploymentMonitoringJobOrBuilder

    • getBigqueryTables

      public ModelDeploymentMonitoringBigQueryTable getBigqueryTables(int index)
       Output only. The created bigquery tables for the job under customer
 project. Customer could do their own query & analysis. There could be 4 log
 tables in maximum:
 1. Training data logging predict request/response
 2. Serving data logging predict request/response
      repeated .google.cloud.aiplatform.v1.ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getBigqueryTables in interface ModelDeploymentMonitoringJobOrBuilder

    • getBigqueryTablesOrBuilder

      public ModelDeploymentMonitoringBigQueryTableOrBuilder getBigqueryTablesOrBuilder(int index)
       Output only. The created bigquery tables for the job under customer
 project. Customer could do their own query & analysis. There could be 4 log
 tables in maximum:
 1. Training data logging predict request/response
 2. Serving data logging predict request/response
      repeated .google.cloud.aiplatform.v1.ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getBigqueryTablesOrBuilder in interface ModelDeploymentMonitoringJobOrBuilder

    • hasLogTtl

      public boolean hasLogTtl()
       The TTL of BigQuery tables in user projects which stores logs.
 A day is the basic unit of the TTL and we take the ceil of TTL/86400(a
 day). e.g. { second: 3600} indicates ttl = 1 day.
      .google.protobuf.Duration log_ttl = 17;
      Specified by:
      hasLogTtl in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      Whether the logTtl field is set.

    • getLogTtl

      public com.google.protobuf.Duration getLogTtl()
       The TTL of BigQuery tables in user projects which stores logs.
 A day is the basic unit of the TTL and we take the ceil of TTL/86400(a
 day). e.g. { second: 3600} indicates ttl = 1 day.
      .google.protobuf.Duration log_ttl = 17;
      Specified by:
      getLogTtl in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The logTtl.

    • getLogTtlOrBuilder

      public com.google.protobuf.DurationOrBuilder getLogTtlOrBuilder()
       The TTL of BigQuery tables in user projects which stores logs.
 A day is the basic unit of the TTL and we take the ceil of TTL/86400(a
 day). e.g. { second: 3600} indicates ttl = 1 day.
      .google.protobuf.Duration log_ttl = 17;
      Specified by:
      getLogTtlOrBuilder in interface ModelDeploymentMonitoringJobOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: ModelDeploymentMonitoringJobOrBuilder
       The labels with user-defined metadata to organize your
 ModelDeploymentMonitoringJob.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
      map<string, string> labels = 11;
      Specified by:
      getLabelsCount in interface ModelDeploymentMonitoringJobOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       The labels with user-defined metadata to organize your
 ModelDeploymentMonitoringJob.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
      map<string, string> labels = 11;
      Specified by:
      containsLabels in interface ModelDeploymentMonitoringJobOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface ModelDeploymentMonitoringJobOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       The labels with user-defined metadata to organize your
 ModelDeploymentMonitoringJob.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
      map<string, string> labels = 11;
      Specified by:
      getLabelsMap in interface ModelDeploymentMonitoringJobOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       The labels with user-defined metadata to organize your
 ModelDeploymentMonitoringJob.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
      map<string, string> labels = 11;
      Specified by:
      getLabelsOrDefault in interface ModelDeploymentMonitoringJobOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       The labels with user-defined metadata to organize your
 ModelDeploymentMonitoringJob.

 Label keys and values can be no longer than 64 characters
 (Unicode codepoints), can only contain lowercase letters, numeric
 characters, underscores and dashes. International characters are allowed.

 See https://goo.gl/xmQnxf for more information and examples of labels.
      map<string, string> labels = 11;
      Specified by:
      getLabelsOrThrow in interface ModelDeploymentMonitoringJobOrBuilder

    • hasCreateTime

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

    • getCreateTime

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

    • getCreateTimeOrBuilder

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

    • hasUpdateTime

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

    • getUpdateTime

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

    • getUpdateTimeOrBuilder

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

    • hasNextScheduleTime

      public boolean hasNextScheduleTime()
       Output only. Timestamp when this monitoring pipeline will be scheduled to
 run for the next round.
      .google.protobuf.Timestamp next_schedule_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasNextScheduleTime in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      Whether the nextScheduleTime field is set.

    • getNextScheduleTime

      public com.google.protobuf.Timestamp getNextScheduleTime()
       Output only. Timestamp when this monitoring pipeline will be scheduled to
 run for the next round.
      .google.protobuf.Timestamp next_schedule_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNextScheduleTime in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The nextScheduleTime.

    • getNextScheduleTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getNextScheduleTimeOrBuilder()
       Output only. Timestamp when this monitoring pipeline will be scheduled to
 run for the next round.
      .google.protobuf.Timestamp next_schedule_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getNextScheduleTimeOrBuilder in interface ModelDeploymentMonitoringJobOrBuilder

    • hasStatsAnomaliesBaseDirectory

      public boolean hasStatsAnomaliesBaseDirectory()
       Stats anomalies base folder path.
      .google.cloud.aiplatform.v1.GcsDestination stats_anomalies_base_directory = 20;
      Specified by:
      hasStatsAnomaliesBaseDirectory in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      Whether the statsAnomaliesBaseDirectory field is set.

    • getStatsAnomaliesBaseDirectory

      public GcsDestination getStatsAnomaliesBaseDirectory()
       Stats anomalies base folder path.
      .google.cloud.aiplatform.v1.GcsDestination stats_anomalies_base_directory = 20;
      Specified by:
      getStatsAnomaliesBaseDirectory in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The statsAnomaliesBaseDirectory.

    • getStatsAnomaliesBaseDirectoryOrBuilder

      public GcsDestinationOrBuilder getStatsAnomaliesBaseDirectoryOrBuilder()
       Stats anomalies base folder path.
      .google.cloud.aiplatform.v1.GcsDestination stats_anomalies_base_directory = 20;
      Specified by:
      getStatsAnomaliesBaseDirectoryOrBuilder in interface ModelDeploymentMonitoringJobOrBuilder

    • hasEncryptionSpec

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

    • getEncryptionSpec

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

    • getEncryptionSpecOrBuilder

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

    • getEnableMonitoringPipelineLogs

      public boolean getEnableMonitoringPipelineLogs()
       If true, the scheduled monitoring pipeline logs are sent to
 Google Cloud Logging, including pipeline status and anomalies detected.
 Please note the logs incur cost, which are subject to [Cloud Logging
 pricing](https://cloud.google.com/logging#pricing).
      bool enable_monitoring_pipeline_logs = 22;
      Specified by:
      getEnableMonitoringPipelineLogs in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The enableMonitoringPipelineLogs.

    • hasError

      public boolean hasError()
       Output only. Only populated when the job's state is `JOB_STATE_FAILED` or
 `JOB_STATE_CANCELLED`.
      .google.rpc.Status error = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasError in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      Whether the error field is set.

    • getError

      public Status getError()
       Output only. Only populated when the job's state is `JOB_STATE_FAILED` or
 `JOB_STATE_CANCELLED`.
      .google.rpc.Status error = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getError in interface ModelDeploymentMonitoringJobOrBuilder
      Returns:
      The error.

    • getErrorOrBuilder

      public StatusOrBuilder getErrorOrBuilder()
       Output only. Only populated when the job's state is `JOB_STATE_FAILED` or
 `JOB_STATE_CANCELLED`.
      .google.rpc.Status error = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getErrorOrBuilder in interface ModelDeploymentMonitoringJobOrBuilder

    • getSatisfiesPzs

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

    • getSatisfiesPzi

      public boolean getSatisfiesPzi()
       Output only. Reserved for future use.
      bool satisfies_pzi = 27 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getSatisfiesPzi in interface ModelDeploymentMonitoringJobOrBuilder
      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 ModelDeploymentMonitoringJob parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ModelDeploymentMonitoringJob.Builder newBuilder()

    • newBuilder

      public static ModelDeploymentMonitoringJob.Builder newBuilder(ModelDeploymentMonitoringJob prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ModelDeploymentMonitoringJob getDefaultInstance()

    • parser

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

    • getParserForType

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