public final class ModelDeploymentMonitoringJob extends com.google.protobuf.GeneratedMessageV3 implements ModelDeploymentMonitoringJobOrBuilder
Represents a job that runs periodically to monitor the deployed models in an endpoint. It will analyze the logged training & prediction data to detect any abnormal behaviors.Protobuf type
google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob| Modifier and Type | Class and Description |
|---|---|
static class |
ModelDeploymentMonitoringJob.Builder
Represents a job that runs periodically to monitor the deployed models in an
endpoint.
|
static class |
ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata
All metadata of most recent monitoring pipelines.
|
static interface |
ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadataOrBuilder |
static class |
ModelDeploymentMonitoringJob.MonitoringScheduleState
The state to Specify the monitoring pipeline.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
The labels with user-defined metadata to organize your
ModelDeploymentMonitoringJob.
|
boolean |
equals(Object obj) |
String |
getAnalysisInstanceSchemaUri()
YAML schema file uri describing the format of a single instance that you
want Tensorflow Data Validation (TFDV) to analyze.
|
com.google.protobuf.ByteString |
getAnalysisInstanceSchemaUriBytes()
YAML schema file uri describing the format of a single instance that you
want Tensorflow Data Validation (TFDV) to analyze.
|
ModelDeploymentMonitoringBigQueryTable |
getBigqueryTables(int index)
Output only.
|
int |
getBigqueryTablesCount()
Output only.
|
List<ModelDeploymentMonitoringBigQueryTable> |
getBigqueryTablesList()
Output only.
|
ModelDeploymentMonitoringBigQueryTableOrBuilder |
getBigqueryTablesOrBuilder(int index)
Output only.
|
List<? extends ModelDeploymentMonitoringBigQueryTableOrBuilder> |
getBigqueryTablesOrBuilderList()
Output only.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static ModelDeploymentMonitoringJob |
getDefaultInstance() |
ModelDeploymentMonitoringJob |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
boolean |
getEnableMonitoringPipelineLogs()
If true, the scheduled monitoring pipeline logs are sent to
Google Cloud Logging, including pipeline status and anomalies detected.
|
EncryptionSpec |
getEncryptionSpec()
Customer-managed encryption key spec for a ModelDeploymentMonitoringJob.
|
EncryptionSpecOrBuilder |
getEncryptionSpecOrBuilder()
Customer-managed encryption key spec for a ModelDeploymentMonitoringJob.
|
String |
getEndpoint()
Required.
|
com.google.protobuf.ByteString |
getEndpointBytes()
Required.
|
com.google.rpc.Status |
getError()
Output only.
|
com.google.rpc.StatusOrBuilder |
getErrorOrBuilder()
Output only.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
The labels with user-defined metadata to organize your
ModelDeploymentMonitoringJob.
|
Map<String,String> |
getLabelsMap()
The labels with user-defined metadata to organize your
ModelDeploymentMonitoringJob.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
The labels with user-defined metadata to organize your
ModelDeploymentMonitoringJob.
|
String |
getLabelsOrThrow(String key)
The labels with user-defined metadata to organize your
ModelDeploymentMonitoringJob.
|
ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata |
getLatestMonitoringPipelineMetadata()
Output only.
|
ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadataOrBuilder |
getLatestMonitoringPipelineMetadataOrBuilder()
Output only.
|
SamplingStrategy |
getLoggingSamplingStrategy()
Required.
|
SamplingStrategyOrBuilder |
getLoggingSamplingStrategyOrBuilder()
Required.
|
com.google.protobuf.Duration |
getLogTtl()
The TTL of BigQuery tables in user projects which stores logs.
|
com.google.protobuf.DurationOrBuilder |
getLogTtlOrBuilder()
The TTL of BigQuery tables in user projects which stores logs.
|
ModelDeploymentMonitoringObjectiveConfig |
getModelDeploymentMonitoringObjectiveConfigs(int index)
Required.
|
int |
getModelDeploymentMonitoringObjectiveConfigsCount()
Required.
|
List<ModelDeploymentMonitoringObjectiveConfig> |
getModelDeploymentMonitoringObjectiveConfigsList()
Required.
|
ModelDeploymentMonitoringObjectiveConfigOrBuilder |
getModelDeploymentMonitoringObjectiveConfigsOrBuilder(int index)
Required.
|
List<? extends ModelDeploymentMonitoringObjectiveConfigOrBuilder> |
getModelDeploymentMonitoringObjectiveConfigsOrBuilderList()
Required.
|
ModelDeploymentMonitoringScheduleConfig |
getModelDeploymentMonitoringScheduleConfig()
Required.
|
ModelDeploymentMonitoringScheduleConfigOrBuilder |
getModelDeploymentMonitoringScheduleConfigOrBuilder()
Required.
|
ModelMonitoringAlertConfig |
getModelMonitoringAlertConfig()
Alert config for model monitoring.
|
ModelMonitoringAlertConfigOrBuilder |
getModelMonitoringAlertConfigOrBuilder()
Alert config for model monitoring.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
com.google.protobuf.Timestamp |
getNextScheduleTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getNextScheduleTimeOrBuilder()
Output only.
|
com.google.protobuf.Parser<ModelDeploymentMonitoringJob> |
getParserForType() |
String |
getPredictInstanceSchemaUri()
YAML schema file uri describing the format of a single instance,
which are given to format this Endpoint's prediction (and explanation).
|
com.google.protobuf.ByteString |
getPredictInstanceSchemaUriBytes()
YAML schema file uri describing the format of a single instance,
which are given to format this Endpoint's prediction (and explanation).
|
com.google.protobuf.Value |
getSamplePredictInstance()
Sample Predict instance, same format as
[PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances],
this can be set as a replacement of
[ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.predict_instance_schema_uri].
|
com.google.protobuf.ValueOrBuilder |
getSamplePredictInstanceOrBuilder()
Sample Predict instance, same format as
[PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances],
this can be set as a replacement of
[ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.predict_instance_schema_uri].
|
ModelDeploymentMonitoringJob.MonitoringScheduleState |
getScheduleState()
Output only.
|
int |
getScheduleStateValue()
Output only.
|
int |
getSerializedSize() |
JobState |
getState()
Output only.
|
int |
getStateValue()
Output only.
|
GcsDestination |
getStatsAnomaliesBaseDirectory()
Stats anomalies base folder path.
|
GcsDestinationOrBuilder |
getStatsAnomaliesBaseDirectoryOrBuilder()
Stats anomalies base folder path.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasEncryptionSpec()
Customer-managed encryption key spec for a ModelDeploymentMonitoringJob.
|
boolean |
hasError()
Output only.
|
int |
hashCode() |
boolean |
hasLatestMonitoringPipelineMetadata()
Output only.
|
boolean |
hasLoggingSamplingStrategy()
Required.
|
boolean |
hasLogTtl()
The TTL of BigQuery tables in user projects which stores logs.
|
boolean |
hasModelDeploymentMonitoringScheduleConfig()
Required.
|
boolean |
hasModelMonitoringAlertConfig()
Alert config for model monitoring.
|
boolean |
hasNextScheduleTime()
Output only.
|
boolean |
hasSamplePredictInstance()
Sample Predict instance, same format as
[PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances],
this can be set as a replacement of
[ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.predict_instance_schema_uri].
|
boolean |
hasStatsAnomaliesBaseDirectory()
Stats anomalies base folder path.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static ModelDeploymentMonitoringJob.Builder |
newBuilder() |
static ModelDeploymentMonitoringJob.Builder |
newBuilder(ModelDeploymentMonitoringJob prototype) |
ModelDeploymentMonitoringJob.Builder |
newBuilderForType() |
protected ModelDeploymentMonitoringJob.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ModelDeploymentMonitoringJob |
parseDelimitedFrom(InputStream input) |
static ModelDeploymentMonitoringJob |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ModelDeploymentMonitoringJob |
parseFrom(byte[] data) |
static ModelDeploymentMonitoringJob |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ModelDeploymentMonitoringJob |
parseFrom(ByteBuffer data) |
static ModelDeploymentMonitoringJob |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ModelDeploymentMonitoringJob |
parseFrom(com.google.protobuf.ByteString data) |
static ModelDeploymentMonitoringJob |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ModelDeploymentMonitoringJob |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ModelDeploymentMonitoringJob |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ModelDeploymentMonitoringJob |
parseFrom(InputStream input) |
static ModelDeploymentMonitoringJob |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ModelDeploymentMonitoringJob> |
parser() |
ModelDeploymentMonitoringJob.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int ENDPOINT_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int SCHEDULE_STATE_FIELD_NUMBER
public static final int LATEST_MONITORING_PIPELINE_METADATA_FIELD_NUMBER
public static final int MODEL_DEPLOYMENT_MONITORING_OBJECTIVE_CONFIGS_FIELD_NUMBER
public static final int MODEL_DEPLOYMENT_MONITORING_SCHEDULE_CONFIG_FIELD_NUMBER
public static final int LOGGING_SAMPLING_STRATEGY_FIELD_NUMBER
public static final int MODEL_MONITORING_ALERT_CONFIG_FIELD_NUMBER
public static final int PREDICT_INSTANCE_SCHEMA_URI_FIELD_NUMBER
public static final int SAMPLE_PREDICT_INSTANCE_FIELD_NUMBER
public static final int ANALYSIS_INSTANCE_SCHEMA_URI_FIELD_NUMBER
public static final int BIGQUERY_TABLES_FIELD_NUMBER
public static final int LOG_TTL_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int NEXT_SCHEDULE_TIME_FIELD_NUMBER
public static final int STATS_ANOMALIES_BASE_DIRECTORY_FIELD_NUMBER
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
public static final int ENABLE_MONITORING_PIPELINE_LOGS_FIELD_NUMBER
public static final int ERROR_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Output only. Resource name of a ModelDeploymentMonitoringJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getName in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Output only. Resource name of a ModelDeploymentMonitoringJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getNameBytes in interface ModelDeploymentMonitoringJobOrBuilderpublic String getDisplayName()
Required. The user-defined name of the ModelDeploymentMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a ModelDeploymentMonitoringJob.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayName in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Required. The user-defined name of the ModelDeploymentMonitoringJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. Display name of a ModelDeploymentMonitoringJob.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayNameBytes in interface ModelDeploymentMonitoringJobOrBuilderpublic String getEndpoint()
Required. Endpoint resource name.
Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
string endpoint = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getEndpoint in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.ByteString getEndpointBytes()
Required. Endpoint resource name.
Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
string endpoint = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getEndpointBytes in interface ModelDeploymentMonitoringJobOrBuilderpublic int getStateValue()
Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'.
.google.cloud.aiplatform.v1beta1.JobState state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface ModelDeploymentMonitoringJobOrBuilderpublic JobState getState()
Output only. The detailed state of the monitoring job. When the job is still creating, the state will be 'PENDING'. Once the job is successfully created, the state will be 'RUNNING'. Pause the job, the state will be 'PAUSED'. Resume the job, the state will return to 'RUNNING'.
.google.cloud.aiplatform.v1beta1.JobState state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface ModelDeploymentMonitoringJobOrBuilderpublic int getScheduleStateValue()
Output only. Schedule state when the monitoring job is in Running state.
.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.MonitoringScheduleState schedule_state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getScheduleStateValue in interface ModelDeploymentMonitoringJobOrBuilderpublic ModelDeploymentMonitoringJob.MonitoringScheduleState getScheduleState()
Output only. Schedule state when the monitoring job is in Running state.
.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.MonitoringScheduleState schedule_state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getScheduleState in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean hasLatestMonitoringPipelineMetadata()
Output only. Latest triggered monitoring pipeline metadata.
.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasLatestMonitoringPipelineMetadata in interface ModelDeploymentMonitoringJobOrBuilderpublic ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata getLatestMonitoringPipelineMetadata()
Output only. Latest triggered monitoring pipeline metadata.
.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLatestMonitoringPipelineMetadata in interface ModelDeploymentMonitoringJobOrBuilderpublic ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadataOrBuilder getLatestMonitoringPipelineMetadataOrBuilder()
Output only. Latest triggered monitoring pipeline metadata.
.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.LatestMonitoringPipelineMetadata latest_monitoring_pipeline_metadata = 25 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLatestMonitoringPipelineMetadataOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic List<ModelDeploymentMonitoringObjectiveConfig> getModelDeploymentMonitoringObjectiveConfigsList()
Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately.
repeated .google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(.google.api.field_behavior) = REQUIRED];
getModelDeploymentMonitoringObjectiveConfigsList in interface ModelDeploymentMonitoringJobOrBuilderpublic List<? extends ModelDeploymentMonitoringObjectiveConfigOrBuilder> getModelDeploymentMonitoringObjectiveConfigsOrBuilderList()
Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately.
repeated .google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(.google.api.field_behavior) = REQUIRED];
getModelDeploymentMonitoringObjectiveConfigsOrBuilderList in interface ModelDeploymentMonitoringJobOrBuilderpublic int getModelDeploymentMonitoringObjectiveConfigsCount()
Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately.
repeated .google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(.google.api.field_behavior) = REQUIRED];
getModelDeploymentMonitoringObjectiveConfigsCount in interface ModelDeploymentMonitoringJobOrBuilderpublic ModelDeploymentMonitoringObjectiveConfig getModelDeploymentMonitoringObjectiveConfigs(int index)
Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately.
repeated .google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(.google.api.field_behavior) = REQUIRED];
getModelDeploymentMonitoringObjectiveConfigs in interface ModelDeploymentMonitoringJobOrBuilderpublic ModelDeploymentMonitoringObjectiveConfigOrBuilder getModelDeploymentMonitoringObjectiveConfigsOrBuilder(int index)
Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately.
repeated .google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringObjectiveConfig model_deployment_monitoring_objective_configs = 6 [(.google.api.field_behavior) = REQUIRED];
getModelDeploymentMonitoringObjectiveConfigsOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean hasModelDeploymentMonitoringScheduleConfig()
Required. Schedule config for running the monitoring job.
.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringScheduleConfig model_deployment_monitoring_schedule_config = 7 [(.google.api.field_behavior) = REQUIRED];
hasModelDeploymentMonitoringScheduleConfig in interface ModelDeploymentMonitoringJobOrBuilderpublic ModelDeploymentMonitoringScheduleConfig getModelDeploymentMonitoringScheduleConfig()
Required. Schedule config for running the monitoring job.
.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringScheduleConfig model_deployment_monitoring_schedule_config = 7 [(.google.api.field_behavior) = REQUIRED];
getModelDeploymentMonitoringScheduleConfig in interface ModelDeploymentMonitoringJobOrBuilderpublic ModelDeploymentMonitoringScheduleConfigOrBuilder getModelDeploymentMonitoringScheduleConfigOrBuilder()
Required. Schedule config for running the monitoring job.
.google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringScheduleConfig model_deployment_monitoring_schedule_config = 7 [(.google.api.field_behavior) = REQUIRED];
getModelDeploymentMonitoringScheduleConfigOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean hasLoggingSamplingStrategy()
Required. Sample Strategy for logging.
.google.cloud.aiplatform.v1beta1.SamplingStrategy logging_sampling_strategy = 8 [(.google.api.field_behavior) = REQUIRED];
hasLoggingSamplingStrategy in interface ModelDeploymentMonitoringJobOrBuilderpublic SamplingStrategy getLoggingSamplingStrategy()
Required. Sample Strategy for logging.
.google.cloud.aiplatform.v1beta1.SamplingStrategy logging_sampling_strategy = 8 [(.google.api.field_behavior) = REQUIRED];
getLoggingSamplingStrategy in interface ModelDeploymentMonitoringJobOrBuilderpublic SamplingStrategyOrBuilder getLoggingSamplingStrategyOrBuilder()
Required. Sample Strategy for logging.
.google.cloud.aiplatform.v1beta1.SamplingStrategy logging_sampling_strategy = 8 [(.google.api.field_behavior) = REQUIRED];
getLoggingSamplingStrategyOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean hasModelMonitoringAlertConfig()
Alert config for model monitoring.
.google.cloud.aiplatform.v1beta1.ModelMonitoringAlertConfig model_monitoring_alert_config = 15;
hasModelMonitoringAlertConfig in interface ModelDeploymentMonitoringJobOrBuilderpublic ModelMonitoringAlertConfig getModelMonitoringAlertConfig()
Alert config for model monitoring.
.google.cloud.aiplatform.v1beta1.ModelMonitoringAlertConfig model_monitoring_alert_config = 15;
getModelMonitoringAlertConfig in interface ModelDeploymentMonitoringJobOrBuilderpublic ModelMonitoringAlertConfigOrBuilder getModelMonitoringAlertConfigOrBuilder()
Alert config for model monitoring.
.google.cloud.aiplatform.v1beta1.ModelMonitoringAlertConfig model_monitoring_alert_config = 15;
getModelMonitoringAlertConfigOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic String getPredictInstanceSchemaUri()
YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests.
string predict_instance_schema_uri = 9;getPredictInstanceSchemaUri in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.ByteString getPredictInstanceSchemaUriBytes()
YAML schema file uri describing the format of a single instance, which are given to format this Endpoint's prediction (and explanation). If not set, we will generate predict schema from collected predict requests.
string predict_instance_schema_uri = 9;getPredictInstanceSchemaUriBytes in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean hasSamplePredictInstance()
Sample Predict instance, same format as [PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances], this can be set as a replacement of [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.predict_instance_schema_uri]. If not set, we will generate predict schema from collected predict requests.
.google.protobuf.Value sample_predict_instance = 19;hasSamplePredictInstance in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.Value getSamplePredictInstance()
Sample Predict instance, same format as [PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances], this can be set as a replacement of [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.predict_instance_schema_uri]. If not set, we will generate predict schema from collected predict requests.
.google.protobuf.Value sample_predict_instance = 19;getSamplePredictInstance in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.ValueOrBuilder getSamplePredictInstanceOrBuilder()
Sample Predict instance, same format as [PredictRequest.instances][google.cloud.aiplatform.v1beta1.PredictRequest.instances], this can be set as a replacement of [ModelDeploymentMonitoringJob.predict_instance_schema_uri][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.predict_instance_schema_uri]. If not set, we will generate predict schema from collected predict requests.
.google.protobuf.Value sample_predict_instance = 19;getSamplePredictInstanceOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic String getAnalysisInstanceSchemaUri()
YAML schema file uri describing the format of a single instance that you want Tensorflow Data Validation (TFDV) to analyze. If this field is empty, all the feature data types are inferred from [predict_instance_schema_uri][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.predict_instance_schema_uri], meaning that TFDV will use the data in the exact format(data type) as prediction request/response. If there are any data type differences between predict instance and TFDV instance, this field can be used to override the schema. For models trained with Vertex AI, this field must be set as all the fields in predict instance formatted as string.
string analysis_instance_schema_uri = 16;getAnalysisInstanceSchemaUri in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.ByteString getAnalysisInstanceSchemaUriBytes()
YAML schema file uri describing the format of a single instance that you want Tensorflow Data Validation (TFDV) to analyze. If this field is empty, all the feature data types are inferred from [predict_instance_schema_uri][google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringJob.predict_instance_schema_uri], meaning that TFDV will use the data in the exact format(data type) as prediction request/response. If there are any data type differences between predict instance and TFDV instance, this field can be used to override the schema. For models trained with Vertex AI, this field must be set as all the fields in predict instance formatted as string.
string analysis_instance_schema_uri = 16;getAnalysisInstanceSchemaUriBytes in interface ModelDeploymentMonitoringJobOrBuilderpublic List<ModelDeploymentMonitoringBigQueryTable> getBigqueryTablesList()
Output only. The created bigquery tables for the job under customer project. Customer could do their own query & analysis. There could be 4 log tables in maximum: 1. Training data logging predict request/response 2. Serving data logging predict request/response
repeated .google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getBigqueryTablesList in interface ModelDeploymentMonitoringJobOrBuilderpublic List<? extends ModelDeploymentMonitoringBigQueryTableOrBuilder> getBigqueryTablesOrBuilderList()
Output only. The created bigquery tables for the job under customer project. Customer could do their own query & analysis. There could be 4 log tables in maximum: 1. Training data logging predict request/response 2. Serving data logging predict request/response
repeated .google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getBigqueryTablesOrBuilderList in interface ModelDeploymentMonitoringJobOrBuilderpublic int getBigqueryTablesCount()
Output only. The created bigquery tables for the job under customer project. Customer could do their own query & analysis. There could be 4 log tables in maximum: 1. Training data logging predict request/response 2. Serving data logging predict request/response
repeated .google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getBigqueryTablesCount in interface ModelDeploymentMonitoringJobOrBuilderpublic ModelDeploymentMonitoringBigQueryTable getBigqueryTables(int index)
Output only. The created bigquery tables for the job under customer project. Customer could do their own query & analysis. There could be 4 log tables in maximum: 1. Training data logging predict request/response 2. Serving data logging predict request/response
repeated .google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getBigqueryTables in interface ModelDeploymentMonitoringJobOrBuilderpublic ModelDeploymentMonitoringBigQueryTableOrBuilder getBigqueryTablesOrBuilder(int index)
Output only. The created bigquery tables for the job under customer project. Customer could do their own query & analysis. There could be 4 log tables in maximum: 1. Training data logging predict request/response 2. Serving data logging predict request/response
repeated .google.cloud.aiplatform.v1beta1.ModelDeploymentMonitoringBigQueryTable bigquery_tables = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
getBigqueryTablesOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean hasLogTtl()
The TTL of BigQuery tables in user projects which stores logs.
A day is the basic unit of the TTL and we take the ceil of TTL/86400(a
day). e.g. { second: 3600} indicates ttl = 1 day.
.google.protobuf.Duration log_ttl = 17;hasLogTtl in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.Duration getLogTtl()
The TTL of BigQuery tables in user projects which stores logs.
A day is the basic unit of the TTL and we take the ceil of TTL/86400(a
day). e.g. { second: 3600} indicates ttl = 1 day.
.google.protobuf.Duration log_ttl = 17;getLogTtl in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.DurationOrBuilder getLogTtlOrBuilder()
The TTL of BigQuery tables in user projects which stores logs.
A day is the basic unit of the TTL and we take the ceil of TTL/86400(a
day). e.g. { second: 3600} indicates ttl = 1 day.
.google.protobuf.Duration log_ttl = 17;getLogTtlOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic int getLabelsCount()
ModelDeploymentMonitoringJobOrBuilderThe labels with user-defined metadata to organize your ModelDeploymentMonitoringJob. 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 and examples of labels.
map<string, string> labels = 11;getLabelsCount in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean containsLabels(String key)
The labels with user-defined metadata to organize your ModelDeploymentMonitoringJob. 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 and examples of labels.
map<string, string> labels = 11;containsLabels in interface ModelDeploymentMonitoringJobOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface ModelDeploymentMonitoringJobOrBuilderpublic Map<String,String> getLabelsMap()
The labels with user-defined metadata to organize your ModelDeploymentMonitoringJob. 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 and examples of labels.
map<string, string> labels = 11;getLabelsMap in interface ModelDeploymentMonitoringJobOrBuilderpublic String getLabelsOrDefault(String key, String defaultValue)
The labels with user-defined metadata to organize your ModelDeploymentMonitoringJob. 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 and examples of labels.
map<string, string> labels = 11;getLabelsOrDefault in interface ModelDeploymentMonitoringJobOrBuilderpublic String getLabelsOrThrow(String key)
The labels with user-defined metadata to organize your ModelDeploymentMonitoringJob. 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 and examples of labels.
map<string, string> labels = 11;getLabelsOrThrow in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean hasCreateTime()
Output only. Timestamp when this ModelDeploymentMonitoringJob was created.
.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. Timestamp when this ModelDeploymentMonitoringJob was created.
.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when this ModelDeploymentMonitoringJob was created.
.google.protobuf.Timestamp create_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean hasUpdateTime()
Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently.
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently.
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently.
.google.protobuf.Timestamp update_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean hasNextScheduleTime()
Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round.
.google.protobuf.Timestamp next_schedule_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasNextScheduleTime in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.Timestamp getNextScheduleTime()
Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round.
.google.protobuf.Timestamp next_schedule_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNextScheduleTime in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.protobuf.TimestampOrBuilder getNextScheduleTimeOrBuilder()
Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round.
.google.protobuf.Timestamp next_schedule_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getNextScheduleTimeOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean hasStatsAnomaliesBaseDirectory()
Stats anomalies base folder path.
.google.cloud.aiplatform.v1beta1.GcsDestination stats_anomalies_base_directory = 20;
hasStatsAnomaliesBaseDirectory in interface ModelDeploymentMonitoringJobOrBuilderpublic GcsDestination getStatsAnomaliesBaseDirectory()
Stats anomalies base folder path.
.google.cloud.aiplatform.v1beta1.GcsDestination stats_anomalies_base_directory = 20;
getStatsAnomaliesBaseDirectory in interface ModelDeploymentMonitoringJobOrBuilderpublic GcsDestinationOrBuilder getStatsAnomaliesBaseDirectoryOrBuilder()
Stats anomalies base folder path.
.google.cloud.aiplatform.v1beta1.GcsDestination stats_anomalies_base_directory = 20;
getStatsAnomaliesBaseDirectoryOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean hasEncryptionSpec()
Customer-managed encryption key spec for a ModelDeploymentMonitoringJob. If set, this ModelDeploymentMonitoringJob and all sub-resources of this ModelDeploymentMonitoringJob will be secured by this key.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 21;hasEncryptionSpec in interface ModelDeploymentMonitoringJobOrBuilderpublic EncryptionSpec getEncryptionSpec()
Customer-managed encryption key spec for a ModelDeploymentMonitoringJob. If set, this ModelDeploymentMonitoringJob and all sub-resources of this ModelDeploymentMonitoringJob will be secured by this key.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 21;getEncryptionSpec in interface ModelDeploymentMonitoringJobOrBuilderpublic EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
Customer-managed encryption key spec for a ModelDeploymentMonitoringJob. If set, this ModelDeploymentMonitoringJob and all sub-resources of this ModelDeploymentMonitoringJob will be secured by this key.
.google.cloud.aiplatform.v1beta1.EncryptionSpec encryption_spec = 21;getEncryptionSpecOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean getEnableMonitoringPipelineLogs()
If true, the scheduled monitoring pipeline logs are sent to Google Cloud Logging, including pipeline status and anomalies detected. Please note the logs incur cost, which are subject to [Cloud Logging pricing](https://cloud.google.com/logging#pricing).
bool enable_monitoring_pipeline_logs = 22;getEnableMonitoringPipelineLogs in interface ModelDeploymentMonitoringJobOrBuilderpublic boolean hasError()
Output only. Only populated when the job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
.google.rpc.Status error = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];hasError in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.rpc.Status getError()
Output only. Only populated when the job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
.google.rpc.Status error = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];getError in interface ModelDeploymentMonitoringJobOrBuilderpublic com.google.rpc.StatusOrBuilder getErrorOrBuilder()
Output only. Only populated when the job's state is `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.
.google.rpc.Status error = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];getErrorOrBuilder in interface ModelDeploymentMonitoringJobOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ModelDeploymentMonitoringJob parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ModelDeploymentMonitoringJob parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ModelDeploymentMonitoringJob parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ModelDeploymentMonitoringJob parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ModelDeploymentMonitoringJob parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ModelDeploymentMonitoringJob parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ModelDeploymentMonitoringJob parseFrom(InputStream input) throws IOException
IOExceptionpublic static ModelDeploymentMonitoringJob parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ModelDeploymentMonitoringJob parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ModelDeploymentMonitoringJob parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ModelDeploymentMonitoringJob parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ModelDeploymentMonitoringJob parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ModelDeploymentMonitoringJob.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ModelDeploymentMonitoringJob.Builder newBuilder()
public static ModelDeploymentMonitoringJob.Builder newBuilder(ModelDeploymentMonitoringJob prototype)
public ModelDeploymentMonitoringJob.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ModelDeploymentMonitoringJob.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ModelDeploymentMonitoringJob getDefaultInstance()
public static com.google.protobuf.Parser<ModelDeploymentMonitoringJob> parser()
public com.google.protobuf.Parser<ModelDeploymentMonitoringJob> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ModelDeploymentMonitoringJob getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.