Package com.google.cloud.aiplatform.v1beta1

Class ModelMonitoringJob

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1beta1.ModelMonitoringJob
All Implemented Interfaces:
ModelMonitoringJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class ModelMonitoringJob extends com.google.protobuf.GeneratedMessage implements ModelMonitoringJobOrBuilder
 Represents a model monitoring job that analyze dataset using different
 monitoring algorithm.
Protobuf type google.cloud.aiplatform.v1beta1.ModelMonitoringJob
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • MODEL_MONITORING_SPEC_FIELD_NUMBER

      public static final int MODEL_MONITORING_SPEC_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • SCHEDULE_FIELD_NUMBER

      public static final int SCHEDULE_FIELD_NUMBER
      See Also:

    • JOB_EXECUTION_DETAIL_FIELD_NUMBER

      public static final int JOB_EXECUTION_DETAIL_FIELD_NUMBER
      See Also:

    • SCHEDULE_TIME_FIELD_NUMBER

      public static final int SCHEDULE_TIME_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getName in interface ModelMonitoringJobOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface ModelMonitoringJobOrBuilder
      Returns:
      The bytes for name.

    • 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;
      Specified by:
      getDisplayName in interface ModelMonitoringJobOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public 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;
      Specified by:
      getDisplayNameBytes in interface ModelMonitoringJobOrBuilder
      Returns:
      The bytes for displayName.

    • 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;
      Specified by:
      hasModelMonitoringSpec in interface ModelMonitoringJobOrBuilder
      Returns:
      Whether the modelMonitoringSpec field is set.

    • 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;
      Specified by:
      getModelMonitoringSpec in interface ModelMonitoringJobOrBuilder
      Returns:
      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;
      Specified by:
      getModelMonitoringSpecOrBuilder in interface ModelMonitoringJobOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp when this ModelMonitoringJob was created.
      .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface ModelMonitoringJobOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public 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];
      Specified by:
      getCreateTime in interface ModelMonitoringJobOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public 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];
      Specified by:
      getCreateTimeOrBuilder in interface ModelMonitoringJobOrBuilder

    • 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];
      Specified by:
      hasUpdateTime in interface ModelMonitoringJobOrBuilder
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      public 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];
      Specified by:
      getUpdateTime in interface ModelMonitoringJobOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public 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];
      Specified by:
      getUpdateTimeOrBuilder in interface ModelMonitoringJobOrBuilder

    • 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];
      Specified by:
      getStateValue in interface ModelMonitoringJobOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • 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];
      Specified by:
      getState in interface ModelMonitoringJobOrBuilder
      Returns:
      The state.

    • 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) = { ... }
      Specified by:
      getSchedule in interface ModelMonitoringJobOrBuilder
      Returns:
      The schedule.

    • getScheduleBytes

      public 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) = { ... }
      Specified by:
      getScheduleBytes in interface ModelMonitoringJobOrBuilder
      Returns:
      The bytes for schedule.

    • 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];
      Specified by:
      hasJobExecutionDetail in interface ModelMonitoringJobOrBuilder
      Returns:
      Whether the jobExecutionDetail field is set.

    • 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];
      Specified by:
      getJobExecutionDetail in interface ModelMonitoringJobOrBuilder
      Returns:
      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];
      Specified by:
      getJobExecutionDetailOrBuilder in interface ModelMonitoringJobOrBuilder

    • 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];
      Specified by:
      hasScheduleTime in interface ModelMonitoringJobOrBuilder
      Returns:
      Whether the scheduleTime field is set.

    • getScheduleTime

      public 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];
      Specified by:
      getScheduleTime in interface ModelMonitoringJobOrBuilder
      Returns:
      The scheduleTime.

    • getScheduleTimeOrBuilder

      public 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];
      Specified by:
      getScheduleTimeOrBuilder in interface ModelMonitoringJobOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ModelMonitoringJob parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ModelMonitoringJob parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ModelMonitoringJob parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ModelMonitoringJob parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ModelMonitoringJob parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ModelMonitoringJob parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ModelMonitoringJob parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ModelMonitoringJob parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ModelMonitoringJob parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ModelMonitoringJob parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ModelMonitoringJob parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ModelMonitoringJob parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ModelMonitoringJob.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ModelMonitoringJob.Builder newBuilder()

    • newBuilder

      public static ModelMonitoringJob.Builder newBuilder(ModelMonitoringJob prototype)

    • toBuilder

      public ModelMonitoringJob.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ModelMonitoringJob.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ModelMonitoringJob getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ModelMonitoringJob> parser()

    • getParserForType

      public com.google.protobuf.Parser<ModelMonitoringJob> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ModelMonitoringJob getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder