Interface ModelMonitoringJobOrBuilder (3.47.0)

public interface ModelMonitoringJobOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. Timestamp when this ModelMonitoringJob was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this ModelMonitoringJob was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDisplayName()

public abstract String getDisplayName()

The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

The display name of the ModelMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8.

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getJobExecutionDetail()

public abstract ModelMonitoringJobExecutionDetail getJobExecutionDetail()

Output only. Execution results for all the monitoring objectives.

.google.cloud.aiplatform.v1beta1.ModelMonitoringJobExecutionDetail job_execution_detail = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelMonitoringJobExecutionDetail

The jobExecutionDetail.

getJobExecutionDetailOrBuilder()

public abstract ModelMonitoringJobExecutionDetailOrBuilder getJobExecutionDetailOrBuilder()

Output only. Execution results for all the monitoring objectives.

.google.cloud.aiplatform.v1beta1.ModelMonitoringJobExecutionDetail job_execution_detail = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ModelMonitoringJobExecutionDetailOrBuilder

getModelMonitoringSpec()

public abstract ModelMonitoringSpec getModelMonitoringSpec()

Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.

.google.cloud.aiplatform.v1beta1.ModelMonitoringSpec model_monitoring_spec = 3;

Returns
Type Description
ModelMonitoringSpec

The modelMonitoringSpec.

getModelMonitoringSpecOrBuilder()

public abstract ModelMonitoringSpecOrBuilder getModelMonitoringSpecOrBuilder()

Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.

.google.cloud.aiplatform.v1beta1.ModelMonitoringSpec model_monitoring_spec = 3;

Returns
Type Description
ModelMonitoringSpecOrBuilder

getName()

public abstract String getName()

Output only. Resource name of a ModelMonitoringJob. Format: projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. Resource name of a ModelMonitoringJob. Format: projects/{project_id}/locations/{location_id}/modelMonitors/{model_monitor_id}/modelMonitoringJobs/{model_monitoring_job_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getSchedule()

public abstract String getSchedule()

Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.

string schedule = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The schedule.

getScheduleBytes()

public abstract ByteString getScheduleBytes()

Output only. Schedule resource name. It will only appear when this job is triggered by a schedule.

string schedule = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for schedule.

getScheduleTime()

public abstract Timestamp getScheduleTime()

Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.

.google.protobuf.Timestamp schedule_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The scheduleTime.

getScheduleTimeOrBuilder()

public abstract TimestampOrBuilder getScheduleTimeOrBuilder()

Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.

.google.protobuf.Timestamp schedule_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getState()

public abstract JobState getState()

Output only. The state of the monitoring job.

  • When the job is still creating, the state will be 'JOB_STATE_PENDING'.
  • Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'.
  • Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.

.google.cloud.aiplatform.v1beta1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
JobState

The state.

getStateValue()

public abstract int getStateValue()

Output only. The state of the monitoring job.

  • When the job is still creating, the state will be 'JOB_STATE_PENDING'.
  • Once the job is successfully created, the state will be 'JOB_STATE_RUNNING'.
  • Once the job is finished, the state will be one of 'JOB_STATE_FAILED', 'JOB_STATE_SUCCEEDED', 'JOB_STATE_PARTIALLY_SUCCEEDED'.

.google.cloud.aiplatform.v1beta1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public abstract Timestamp getUpdateTime()

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

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. Timestamp when this ModelMonitoringJob was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasJobExecutionDetail()

public abstract boolean hasJobExecutionDetail()

Output only. Execution results for all the monitoring objectives.

.google.cloud.aiplatform.v1beta1.ModelMonitoringJobExecutionDetail job_execution_detail = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the jobExecutionDetail field is set.

hasModelMonitoringSpec()

public abstract boolean hasModelMonitoringSpec()

Monitoring monitoring job spec. It outlines the specifications for monitoring objectives, notifications, and result exports. If left blank, the default monitoring specifications from the top-level resource 'ModelMonitor' will be applied. If provided, we will use the specification defined here rather than the default one.

.google.cloud.aiplatform.v1beta1.ModelMonitoringSpec model_monitoring_spec = 3;

Returns
Type Description
boolean

Whether the modelMonitoringSpec field is set.

hasScheduleTime()

public abstract boolean hasScheduleTime()

Output only. Timestamp when this ModelMonitoringJob was scheduled. It will only appear when this job is triggered by a schedule.

.google.protobuf.Timestamp schedule_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the scheduleTime field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

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

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.