Class ModelMonitoringJob (3.47.0)

public final class ModelMonitoringJob extends GeneratedMessageV3 implements ModelMonitoringJobOrBuilder

Represents a model monitoring job that analyze dataset using different monitoring algorithm.

Protobuf type google.cloud.aiplatform.v1beta1.ModelMonitoringJob

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

JOB_EXECUTION_DETAIL_FIELD_NUMBER

public static final int JOB_EXECUTION_DETAIL_FIELD_NUMBER
Field Value
Type Description
int

MODEL_MONITORING_SPEC_FIELD_NUMBER

public static final int MODEL_MONITORING_SPEC_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_FIELD_NUMBER

public static final int SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_TIME_FIELD_NUMBER

public static final int SCHEDULE_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ModelMonitoringJob getDefaultInstance()
Returns
Type Description
ModelMonitoringJob

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ModelMonitoringJob.Builder newBuilder()
Returns
Type Description
ModelMonitoringJob.Builder

newBuilder(ModelMonitoringJob prototype)

public static ModelMonitoringJob.Builder newBuilder(ModelMonitoringJob prototype)
Parameter
Name Description
prototype ModelMonitoringJob
Returns
Type Description
ModelMonitoringJob.Builder

parseDelimitedFrom(InputStream input)

public static ModelMonitoringJob parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelMonitoringJob
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelMonitoringJob
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ModelMonitoringJob parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ModelMonitoringJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelMonitoringJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ModelMonitoringJob parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ModelMonitoringJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelMonitoringJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ModelMonitoringJob parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ModelMonitoringJob
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelMonitoringJob
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ModelMonitoringJob parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ModelMonitoringJob
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelMonitoringJob
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ModelMonitoringJob parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ModelMonitoringJob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ModelMonitoringJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ModelMonitoringJob
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ModelMonitoringJob> parser()
Returns
Type Description
Parser<ModelMonitoringJob>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public 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 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

getDefaultInstanceForType()

public ModelMonitoringJob getDefaultInstanceForType()
Returns
Type Description
ModelMonitoringJob

getDisplayName()

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

getParserForType()

public Parser<ModelMonitoringJob> getParserForType()
Returns
Type Description
Parser<ModelMonitoringJob>
Overrides

getSchedule()

public 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 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 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 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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ModelMonitoringJob.Builder newBuilderForType()
Returns
Type Description
ModelMonitoringJob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ModelMonitoringJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ModelMonitoringJob.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ModelMonitoringJob.Builder toBuilder()
Returns
Type Description
ModelMonitoringJob.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException