REST Resource: projects.locations.featureGroups.featureMonitors.featureMonitorJobs

Resource: FeatureMonitorJob

Vertex AI feature Monitor Job.

Fields
name string

Identifier. name of the FeatureMonitorJob. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}/featureMonitors/{featureMonitor}/featureMonitorJobs/{featureMonitorJob}.

createTime string (Timestamp format)

Output only. timestamp when this FeatureMonitorJob was created. Creation of a FeatureMonitorJob means that the job is pending / waiting for sufficient resources but may not have started running yet.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

finalStatus object (Status)

Output only. Final status of the FeatureMonitorJob.

jobSummary object (JobSummary)

Output only. Summary from the FeatureMonitorJob.

labels map (key: string, value: string)

Optional. The labels with user-defined metadata to organize your FeatureMonitorJob.

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 on and examples of labels. No more than 64 user labels can be associated with one FeatureMonitor(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.

description string

Optional. description of the FeatureMonitor.

driftBaseFeatureMonitorJobId string (int64 format)

Output only. FeatureMonitorJob id comparing to which the drift is calculated.

driftBaseSnapshotTime string (Timestamp format)

Output only. data snapshot time comparing to which the drift is calculated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

featureSelectionConfig object (FeatureSelectionConfig)

Output only. feature selection config used when creating FeatureMonitorJob.

triggerType enum (FeatureMonitorJobTrigger)

Output only. Trigger type of the feature Monitor Job.

JSON representation 
{
  "name": string,
  "createTime": string,
  "finalStatus": {
    object (Status)
  },
  "jobSummary": {
    object (JobSummary)
  },
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "driftBaseFeatureMonitorJobId": string,
  "driftBaseSnapshotTime": string,
  "featureSelectionConfig": {
    object (FeatureSelectionConfig)
  },
  "triggerType": enum (FeatureMonitorJobTrigger)
}

JobSummary

Summary from the FeatureMonitorJob.

Fields
totalSlotMs string (int64 format)

Output only. BigQuery slot milliseconds consumed.

featureStatsAndAnomalies[] object (FeatureStatsAndAnomaly)

Output only. Features and their stats and anomalies

JSON representation 
{
  "totalSlotMs": string,
  "featureStatsAndAnomalies": [
    {
      object (FeatureStatsAndAnomaly)
    }
  ]
}

FeatureMonitorJobTrigger

Choices of the trigger type.

Enums
FEATURE_MONITOR_JOB_TRIGGER_UNSPECIFIED Trigger type unspecified.
FEATURE_MONITOR_JOB_TRIGGER_PERIODIC Triggered by periodic schedule.
FEATURE_MONITOR_JOB_TRIGGER_ON_DEMAND Triggered on demand by featureMonitorJobs.create request.

Methods

create

 Creates a new feature monitor job.

get

 Get a feature monitor job.

list

 List feature monitor jobs.