Class FeatureMonitorJob (3.55.0)

public final class FeatureMonitorJob extends GeneratedMessageV3 implements FeatureMonitorJobOrBuilder

Vertex AI Feature Monitor Job.

Protobuf type google.cloud.aiplatform.v1beta1.FeatureMonitorJob

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DRIFT_BASE_FEATURE_MONITOR_JOB_ID_FIELD_NUMBER

public static final int DRIFT_BASE_FEATURE_MONITOR_JOB_ID_FIELD_NUMBER
Field Value
Type Description
int

DRIFT_BASE_SNAPSHOT_TIME_FIELD_NUMBER

public static final int DRIFT_BASE_SNAPSHOT_TIME_FIELD_NUMBER
Field Value
Type Description
int

FEATURE_SELECTION_CONFIG_FIELD_NUMBER

public static final int FEATURE_SELECTION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

FINAL_STATUS_FIELD_NUMBER

public static final int FINAL_STATUS_FIELD_NUMBER
Field Value
Type Description
int

JOB_SUMMARY_FIELD_NUMBER

public static final int JOB_SUMMARY_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

TRIGGER_TYPE_FIELD_NUMBER

public static final int TRIGGER_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FeatureMonitorJob getDefaultInstance()
Returns
Type Description
FeatureMonitorJob

getDescriptor()

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

newBuilder()

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

newBuilder(FeatureMonitorJob prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

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

Parameter
Name Description
key String
Returns
Type Description
boolean

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public FeatureMonitorJob getDefaultInstanceForType()
Returns
Type Description
FeatureMonitorJob

getDescription()

public String getDescription()

Optional. Description of the FeatureMonitor.

string description = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the FeatureMonitor.

string description = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

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

Returns
Type Description
long

The driftBaseFeatureMonitorJobId.

getDriftBaseSnapshotTime()

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

Returns
Type Description
Timestamp

The driftBaseSnapshotTime.

getDriftBaseSnapshotTimeOrBuilder()

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

Returns
Type Description
TimestampOrBuilder

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

Returns
Type Description
FeatureSelectionConfig

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

Returns
Type Description
FeatureSelectionConfigOrBuilder

getFinalStatus()

public Status getFinalStatus()

Output only. Final status of the FeatureMonitorJob.

.google.rpc.Status final_status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
com.google.rpc.Status

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

Returns
Type Description
com.google.rpc.StatusOrBuilder

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

Returns
Type Description
FeatureMonitorJob.JobSummary

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

Returns
Type Description
FeatureMonitorJob.JobSummaryOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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

Returns
Type Description
int

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

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

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

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

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

Parameter
Name Description
key String
Returns
Type Description
String

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

Returns
Type Description
String

The name.

getNameBytes()

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

Returns
Type Description
FeatureMonitorJob.FeatureMonitorJobTrigger

The triggerType.

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

Returns
Type Description
int

The enum numeric value on the wire for triggerType.

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

Returns
Type Description
boolean

Whether the createTime field is set.

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

Returns
Type Description
boolean

Whether the driftBaseSnapshotTime field is set.

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

Returns
Type Description
boolean

Whether the featureSelectionConfig field is set.

hasFinalStatus()

public boolean hasFinalStatus()

Output only. Final status of the FeatureMonitorJob.

.google.rpc.Status final_status = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the finalStatus field is set.

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

Returns
Type Description
boolean

Whether the jobSummary field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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