Class GoogleCloudAiplatformV1ModelDeploymentMonitoringJob

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
GoogleCloudAiplatformV1ModelDeploymentMonitoringJob
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1.Data
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class GoogleCloudAiplatformV1ModelDeploymentMonitoringJob : IDirectResponseSchema

Properties

AnalysisInstanceSchemaUri

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, 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.

Declaration
[JsonProperty("analysisInstanceSchemaUri")]
public virtual string AnalysisInstanceSchemaUri { get; set; }
Property Value
Type Description
string

BigqueryTables

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

Declaration
[JsonProperty("bigqueryTables")]
public virtual IList<GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable> BigqueryTables { get; set; }
Property Value
Type Description
IList<GoogleCloudAiplatformV1ModelDeploymentMonitoringBigQueryTable>

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp when this ModelDeploymentMonitoringJob was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DisplayName

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.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EnableMonitoringPipelineLogs

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.

Declaration
[JsonProperty("enableMonitoringPipelineLogs")]
public virtual bool? EnableMonitoringPipelineLogs { get; set; }
Property Value
Type Description
bool?

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.

Declaration
[JsonProperty("encryptionSpec")]
public virtual GoogleCloudAiplatformV1EncryptionSpec EncryptionSpec { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1EncryptionSpec

Endpoint

Required. Endpoint resource name. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

Declaration
[JsonProperty("endpoint")]
public virtual string Endpoint { get; set; }
Property Value
Type Description
string

Error

Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

Declaration
[JsonProperty("error")]
public virtual GoogleRpcStatus Error { get; set; }
Property Value
Type Description
GoogleRpcStatus

Labels

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.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

LatestMonitoringPipelineMetadata

Output only. Latest triggered monitoring pipeline metadata.

Declaration
[JsonProperty("latestMonitoringPipelineMetadata")]
public virtual GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata LatestMonitoringPipelineMetadata { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1ModelDeploymentMonitoringJobLatestMonitoringPipelineMetadata

LogTtl

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.

Declaration
[JsonProperty("logTtl")]
public virtual object LogTtl { get; set; }
Property Value
Type Description
object

LoggingSamplingStrategy

Required. Sample Strategy for logging.

Declaration
[JsonProperty("loggingSamplingStrategy")]
public virtual GoogleCloudAiplatformV1SamplingStrategy LoggingSamplingStrategy { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1SamplingStrategy

ModelDeploymentMonitoringObjectiveConfigs

Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately.

Declaration
[JsonProperty("modelDeploymentMonitoringObjectiveConfigs")]
public virtual IList<GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig> ModelDeploymentMonitoringObjectiveConfigs { get; set; }
Property Value
Type Description
IList<GoogleCloudAiplatformV1ModelDeploymentMonitoringObjectiveConfig>

ModelDeploymentMonitoringScheduleConfig

Required. Schedule config for running the monitoring job.

Declaration
[JsonProperty("modelDeploymentMonitoringScheduleConfig")]
public virtual GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig ModelDeploymentMonitoringScheduleConfig { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1ModelDeploymentMonitoringScheduleConfig

ModelMonitoringAlertConfig

Alert config for model monitoring.

Declaration
[JsonProperty("modelMonitoringAlertConfig")]
public virtual GoogleCloudAiplatformV1ModelMonitoringAlertConfig ModelMonitoringAlertConfig { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1ModelMonitoringAlertConfig

Name

Output only. Resource name of a ModelDeploymentMonitoringJob.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NextScheduleTime

object representation of NextScheduleTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use NextScheduleTimeDateTimeOffset instead.")]
public virtual object NextScheduleTime { get; set; }
Property Value
Type Description
object

NextScheduleTimeDateTimeOffset

DateTimeOffset representation of NextScheduleTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? NextScheduleTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

NextScheduleTimeRaw

Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round.

Declaration
[JsonProperty("nextScheduleTime")]
public virtual string NextScheduleTimeRaw { get; set; }
Property Value
Type Description
string

PredictInstanceSchemaUri

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.

Declaration
[JsonProperty("predictInstanceSchemaUri")]
public virtual string PredictInstanceSchemaUri { get; set; }
Property Value
Type Description
string

SamplePredictInstance

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.

Declaration
[JsonProperty("samplePredictInstance")]
public virtual object SamplePredictInstance { get; set; }
Property Value
Type Description
object

SatisfiesPzi

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
Type Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
Type Description
bool?

ScheduleState

Output only. Schedule state when the monitoring job is in Running state.

Declaration
[JsonProperty("scheduleState")]
public virtual string ScheduleState { get; set; }
Property Value
Type Description
string

State

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'.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

StatsAnomaliesBaseDirectory

Stats anomalies base folder path.

Declaration
[JsonProperty("statsAnomaliesBaseDirectory")]
public virtual GoogleCloudAiplatformV1GcsDestination StatsAnomaliesBaseDirectory { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1GcsDestination

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements