ModelDeploymentMonitoringJob class final

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.

Inheritance
  • Object
  • ProtoMessage
  • ModelDeploymentMonitoringJob

Constructors

ModelDeploymentMonitoringJob({String name = '', required String displayName, required String endpoint, JobState state = JobState.$default, ModelDeploymentMonitoringJob_MonitoringScheduleState scheduleState = ModelDeploymentMonitoringJob_MonitoringScheduleState.$default, ModelDeploymentMonitoringJob_LatestMonitoringPipelineMetadata? latestMonitoringPipelineMetadata, required List<ModelDeploymentMonitoringObjectiveConfig> modelDeploymentMonitoringObjectiveConfigs, required ModelDeploymentMonitoringScheduleConfig? modelDeploymentMonitoringScheduleConfig, required SamplingStrategy? loggingSamplingStrategy, ModelMonitoringAlertConfig? modelMonitoringAlertConfig, String predictInstanceSchemaUri = '', Value? samplePredictInstance, String analysisInstanceSchemaUri = '', List<ModelDeploymentMonitoringBigQueryTable> bigqueryTables = const [], Duration? logTtl, Map<String, String> labels = const {}, Timestamp? createTime, Timestamp? updateTime, Timestamp? nextScheduleTime, GcsDestination? statsAnomaliesBaseDirectory, EncryptionSpec? encryptionSpec, bool enableMonitoringPipelineLogs = false, Status? error, bool satisfiesPzs = false, bool satisfiesPzi = false})
ModelDeploymentMonitoringJob.fromJson(Object? j)
factory

Properties

analysisInstanceSchemaUri → String
YAML schema file uri describing the format of a single instance that you want Tensorflow Data Validation (TFDV) to analyze.
final
bigqueryTables → List<ModelDeploymentMonitoringBigQueryTable>
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:
final
createTime → Timestamp?
Output only. Timestamp when this ModelDeploymentMonitoringJob was created.
final
displayName → String
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.
final
enableMonitoringPipelineLogs → bool
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.
final
encryptionSpec → EncryptionSpec?
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.
final
endpoint → String
Required. Endpoint resource name. Format: projects/{project}/locations/{location}/endpoints/{endpoint}
final
error → Status?
Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
final
hashCode → int
The hash code for this object.
no setterinherited
labels → Map<String, String>
The labels with user-defined metadata to organize your ModelDeploymentMonitoringJob.
final
latestMonitoringPipelineMetadata → ModelDeploymentMonitoringJob_LatestMonitoringPipelineMetadata?
Output only. Latest triggered monitoring pipeline metadata.
final
loggingSamplingStrategy → SamplingStrategy?
Required. Sample Strategy for logging.
final
logTtl → Duration?
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.
final
modelDeploymentMonitoringObjectiveConfigs → List<ModelDeploymentMonitoringObjectiveConfig>
Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately.
final
modelDeploymentMonitoringScheduleConfig → ModelDeploymentMonitoringScheduleConfig?
Required. Schedule config for running the monitoring job.
final
modelMonitoringAlertConfig → ModelMonitoringAlertConfig?
Alert config for model monitoring.
final
name → String
Output only. Resource name of a ModelDeploymentMonitoringJob.
final
nextScheduleTime → Timestamp?
Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round.
final
predictInstanceSchemaUri → String
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.
final
qualifiedName → String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
samplePredictInstance → Value?
Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests.
final
satisfiesPzi → bool
Output only. Reserved for future use.
final
satisfiesPzs → bool
Output only. Reserved for future use.
final
scheduleState → ModelDeploymentMonitoringJob_MonitoringScheduleState
Output only. Schedule state when the monitoring job is in Running state.
final
state → JobState
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'.
final
statsAnomaliesBaseDirectory → GcsDestination?
Stats anomalies base folder path.
final
updateTime → Timestamp?
Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Object
override
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

fullyQualifiedName → const String