Package com.google.cloud.aiplatform.v1beta1

Class FeatureMonitorJob

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1beta1.FeatureMonitorJob
All Implemented Interfaces:
FeatureMonitorJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class FeatureMonitorJob extends com.google.protobuf.GeneratedMessage implements FeatureMonitorJobOrBuilder
 Vertex AI Feature Monitor Job.
Protobuf type google.cloud.aiplatform.v1beta1.FeatureMonitorJob
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • FINAL_STATUS_FIELD_NUMBER

      public static final int FINAL_STATUS_FIELD_NUMBER
      See Also:

    • JOB_SUMMARY_FIELD_NUMBER

      public static final int JOB_SUMMARY_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • DRIFT_BASE_FEATURE_MONITOR_JOB_ID_FIELD_NUMBER

      public static final int DRIFT_BASE_FEATURE_MONITOR_JOB_ID_FIELD_NUMBER
      See Also:

    • DRIFT_BASE_SNAPSHOT_TIME_FIELD_NUMBER

      public static final int DRIFT_BASE_SNAPSHOT_TIME_FIELD_NUMBER
      See Also:

    • FEATURE_SELECTION_CONFIG_FIELD_NUMBER

      public static final int FEATURE_SELECTION_CONFIG_FIELD_NUMBER
      See Also:

    • TRIGGER_TYPE_FIELD_NUMBER

      public static final int TRIGGER_TYPE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getName

      public String getName()
       Identifier. Name of the FeatureMonitorJob. Format:
 `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getName in interface FeatureMonitorJobOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifier. Name of the FeatureMonitorJob. Format:
 `projects/{project}/locations/{location}/featureGroups/{feature_group}/featureMonitors/{feature_monitor}/featureMonitorJobs/{feature_monitor_job}`.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Specified by:
      getNameBytes in interface FeatureMonitorJobOrBuilder
      Returns:
      The bytes for name.

    • hasCreateTime

      public boolean hasCreateTime()
       Output only. Timestamp when this FeatureMonitorJob was created. Creation of
 a FeatureMonitorJob means that the job is pending / waiting for sufficient
 resources but may not have started running yet.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasCreateTime in interface FeatureMonitorJobOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp when this FeatureMonitorJob was created. Creation of
 a FeatureMonitorJob means that the job is pending / waiting for sufficient
 resources but may not have started running yet.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTime in interface FeatureMonitorJobOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp when this FeatureMonitorJob was created. Creation of
 a FeatureMonitorJob means that the job is pending / waiting for sufficient
 resources but may not have started running yet.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getCreateTimeOrBuilder in interface FeatureMonitorJobOrBuilder

    • hasFinalStatus

      public boolean hasFinalStatus()
       Output only. Final status of the FeatureMonitorJob.
      .google.rpc.Status final_status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasFinalStatus in interface FeatureMonitorJobOrBuilder
      Returns:
      Whether the finalStatus field is set.

    • getFinalStatus

      public Status getFinalStatus()
       Output only. Final status of the FeatureMonitorJob.
      .google.rpc.Status final_status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFinalStatus in interface FeatureMonitorJobOrBuilder
      Returns:
      The finalStatus.

    • getFinalStatusOrBuilder

      public StatusOrBuilder getFinalStatusOrBuilder()
       Output only. Final status of the FeatureMonitorJob.
      .google.rpc.Status final_status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFinalStatusOrBuilder in interface FeatureMonitorJobOrBuilder

    • hasJobSummary

      public boolean hasJobSummary()
       Output only. Summary from the FeatureMonitorJob.
      .google.cloud.aiplatform.v1beta1.FeatureMonitorJob.JobSummary job_summary = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasJobSummary in interface FeatureMonitorJobOrBuilder
      Returns:
      Whether the jobSummary field is set.

    • getJobSummary

      public FeatureMonitorJob.JobSummary getJobSummary()
       Output only. Summary from the FeatureMonitorJob.
      .google.cloud.aiplatform.v1beta1.FeatureMonitorJob.JobSummary job_summary = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getJobSummary in interface FeatureMonitorJobOrBuilder
      Returns:
      The jobSummary.

    • getJobSummaryOrBuilder

      public FeatureMonitorJob.JobSummaryOrBuilder getJobSummaryOrBuilder()
       Output only. Summary from the FeatureMonitorJob.
      .google.cloud.aiplatform.v1beta1.FeatureMonitorJob.JobSummary job_summary = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getJobSummaryOrBuilder in interface FeatureMonitorJobOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: FeatureMonitorJobOrBuilder
       Optional. The labels with user-defined metadata to organize your
 FeatureMonitorJob.

 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 on and examples of labels.
 No more than 64 user labels can be associated with one
 FeatureMonitor(System labels are excluded)." System reserved label keys
 are prefixed with "aiplatform.googleapis.com/" and are immutable.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface FeatureMonitorJobOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Optional. The labels with user-defined metadata to organize your
 FeatureMonitorJob.

 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 on and examples of labels.
 No more than 64 user labels can be associated with one
 FeatureMonitor(System labels are excluded)." System reserved label keys
 are prefixed with "aiplatform.googleapis.com/" and are immutable.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface FeatureMonitorJobOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface FeatureMonitorJobOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. The labels with user-defined metadata to organize your
 FeatureMonitorJob.

 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 on and examples of labels.
 No more than 64 user labels can be associated with one
 FeatureMonitor(System labels are excluded)." System reserved label keys
 are prefixed with "aiplatform.googleapis.com/" and are immutable.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface FeatureMonitorJobOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. The labels with user-defined metadata to organize your
 FeatureMonitorJob.

 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 on and examples of labels.
 No more than 64 user labels can be associated with one
 FeatureMonitor(System labels are excluded)." System reserved label keys
 are prefixed with "aiplatform.googleapis.com/" and are immutable.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface FeatureMonitorJobOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. The labels with user-defined metadata to organize your
 FeatureMonitorJob.

 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 on and examples of labels.
 No more than 64 user labels can be associated with one
 FeatureMonitor(System labels are excluded)." System reserved label keys
 are prefixed with "aiplatform.googleapis.com/" and are immutable.
      map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface FeatureMonitorJobOrBuilder

    • getDescription

      public String getDescription()
       Optional. Description of the FeatureMonitor.
      string description = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescription in interface FeatureMonitorJobOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Optional. Description of the FeatureMonitor.
      string description = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getDescriptionBytes in interface FeatureMonitorJobOrBuilder
      Returns:
      The bytes for description.

    • getDriftBaseFeatureMonitorJobId

      public long getDriftBaseFeatureMonitorJobId()
       Output only. FeatureMonitorJob ID comparing to which the drift is
 calculated.
      int64 drift_base_feature_monitor_job_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDriftBaseFeatureMonitorJobId in interface FeatureMonitorJobOrBuilder
      Returns:
      The driftBaseFeatureMonitorJobId.

    • hasDriftBaseSnapshotTime

      public boolean hasDriftBaseSnapshotTime()
       Output only. Data snapshot time comparing to which the drift is calculated.
      .google.protobuf.Timestamp drift_base_snapshot_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasDriftBaseSnapshotTime in interface FeatureMonitorJobOrBuilder
      Returns:
      Whether the driftBaseSnapshotTime field is set.

    • getDriftBaseSnapshotTime

      public com.google.protobuf.Timestamp getDriftBaseSnapshotTime()
       Output only. Data snapshot time comparing to which the drift is calculated.
      .google.protobuf.Timestamp drift_base_snapshot_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDriftBaseSnapshotTime in interface FeatureMonitorJobOrBuilder
      Returns:
      The driftBaseSnapshotTime.

    • getDriftBaseSnapshotTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getDriftBaseSnapshotTimeOrBuilder()
       Output only. Data snapshot time comparing to which the drift is calculated.
      .google.protobuf.Timestamp drift_base_snapshot_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getDriftBaseSnapshotTimeOrBuilder in interface FeatureMonitorJobOrBuilder

    • hasFeatureSelectionConfig

      public boolean hasFeatureSelectionConfig()
       Output only. Feature selection config used when creating FeatureMonitorJob.
      .google.cloud.aiplatform.v1beta1.FeatureSelectionConfig feature_selection_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasFeatureSelectionConfig in interface FeatureMonitorJobOrBuilder
      Returns:
      Whether the featureSelectionConfig field is set.

    • getFeatureSelectionConfig

      public FeatureSelectionConfig getFeatureSelectionConfig()
       Output only. Feature selection config used when creating FeatureMonitorJob.
      .google.cloud.aiplatform.v1beta1.FeatureSelectionConfig feature_selection_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFeatureSelectionConfig in interface FeatureMonitorJobOrBuilder
      Returns:
      The featureSelectionConfig.

    • getFeatureSelectionConfigOrBuilder

      public FeatureSelectionConfigOrBuilder getFeatureSelectionConfigOrBuilder()
       Output only. Feature selection config used when creating FeatureMonitorJob.
      .google.cloud.aiplatform.v1beta1.FeatureSelectionConfig feature_selection_config = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getFeatureSelectionConfigOrBuilder in interface FeatureMonitorJobOrBuilder

    • getTriggerTypeValue

      public int getTriggerTypeValue()
       Output only. Trigger type of the Feature Monitor Job.
      .google.cloud.aiplatform.v1beta1.FeatureMonitorJob.FeatureMonitorJobTrigger trigger_type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTriggerTypeValue in interface FeatureMonitorJobOrBuilder
      Returns:
      The enum numeric value on the wire for triggerType.

    • getTriggerType

      public FeatureMonitorJob.FeatureMonitorJobTrigger getTriggerType()
       Output only. Trigger type of the Feature Monitor Job.
      .google.cloud.aiplatform.v1beta1.FeatureMonitorJob.FeatureMonitorJobTrigger trigger_type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getTriggerType in interface FeatureMonitorJobOrBuilder
      Returns:
      The triggerType.

    • 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 FeatureMonitorJob parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FeatureMonitorJob.Builder newBuilder()

    • newBuilder

      public static FeatureMonitorJob.Builder newBuilder(FeatureMonitorJob prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FeatureMonitorJob getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FeatureMonitorJob> 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 FeatureMonitorJob getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder