com.google.cloud.aiplatform.v1beta1

Interface ModelMonitoringJobOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ModelMonitoringJob, ModelMonitoringJob.Builder

public interface ModelMonitoringJobOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDisplayName() The display name of the ModelMonitoringJob.
com.google.protobuf.ByteString	getDisplayNameBytes() The display name of the ModelMonitoringJob.
ModelMonitoringJobExecutionDetail	getJobExecutionDetail() Output only.
ModelMonitoringJobExecutionDetailOrBuilder	getJobExecutionDetailOrBuilder() Output only.
ModelMonitoringSpec	getModelMonitoringSpec() Monitoring monitoring job spec.
ModelMonitoringSpecOrBuilder	getModelMonitoringSpecOrBuilder() Monitoring monitoring job spec.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
String	getSchedule() Output only.
com.google.protobuf.ByteString	getScheduleBytes() Output only.
com.google.protobuf.Timestamp	getScheduleTime() Output only.
com.google.protobuf.TimestampOrBuilder	getScheduleTimeOrBuilder() Output only.
JobState	getState() Output only.
int	getStateValue() Output only.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasCreateTime() Output only.
boolean	hasJobExecutionDetail() Output only.
boolean	hasModelMonitoringSpec() Monitoring monitoring job spec.
boolean	hasScheduleTime() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

com.google.protobuf.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:

The bytes for displayName.

hasModelMonitoringSpec

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:

Whether the modelMonitoringSpec field is set.

getModelMonitoringSpec

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:

The modelMonitoringSpec.

getModelMonitoringSpecOrBuilder

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;

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp when this ModelMonitoringJob was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp when this ModelMonitoringJob was created.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp when this ModelMonitoringJob was created.
 

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

hasUpdateTime

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:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.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:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

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

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

getStateValue

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:

The enum numeric value on the wire for state.

getState

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:

The state.

getSchedule

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:

The schedule.

getScheduleBytes

com.google.protobuf.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:

The bytes for schedule.

hasJobExecutionDetail

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:

Whether the jobExecutionDetail field is set.

getJobExecutionDetail

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:

The jobExecutionDetail.

getJobExecutionDetailOrBuilder

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];

hasScheduleTime

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:

Whether the scheduleTime field is set.

getScheduleTime

com.google.protobuf.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:

The scheduleTime.

getScheduleTimeOrBuilder

com.google.protobuf.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];