Interface FeatureMonitorJobOrBuilder (3.56.0) 

public interface FeatureMonitorJobOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

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

getCreateTime()

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

getDescription()

public abstract String getDescription()

Optional. Description of the FeatureMonitor.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

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

getTriggerType()

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