Class: Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb

Overview

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.

Defined Under Namespace

Modules: MonitoringScheduleState Classes: LabelsEntry, LatestMonitoringPipelineMetadata

Instance Attribute Summary collapse

Instance Attribute Details

#analysis_instance_schema_uri ⇒ ::String

Returns 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, 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.

Returns:

  • (::String) —

    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, 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.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#bigquery_tables ⇒ ::Array<::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringBigQueryTable> (readonly)

Returns 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.

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this ModelDeploymentMonitoringJob was created.

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#display_name ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#enable_monitoring_pipeline_logs ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#encryption_spec ⇒ ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns 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.

Returns:

  • (::Google::Cloud::AIPlatform::V1::EncryptionSpec) —

    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.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#endpoint ⇒ ::String

Returns Required. Endpoint resource name. Format: projects/{project}/locations/{location}/endpoints/{endpoint}.

Returns:

  • (::String) —

    Required. Endpoint resource name. Format: projects/{project}/locations/{location}/endpoints/{endpoint}



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#error ⇒ ::Google::Rpc::Status (readonly)

Returns Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

Returns:

  • (::Google::Rpc::Status) —

    Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    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.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#latest_monitoring_pipeline_metadata ⇒ ::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob::LatestMonitoringPipelineMetadata (readonly)

Returns Output only. Latest triggered monitoring pipeline metadata.

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#log_ttl ⇒ ::Google::Protobuf::Duration

Returns 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.

Returns:

  • (::Google::Protobuf::Duration) —

    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.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#logging_sampling_strategy ⇒ ::Google::Cloud::AIPlatform::V1::SamplingStrategy

Returns Required. Sample Strategy for logging.

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#model_deployment_monitoring_objective_configs ⇒ ::Array<::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringObjectiveConfig>

Returns Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately.

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#model_deployment_monitoring_schedule_config ⇒ ::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringScheduleConfig

Returns Required. Schedule config for running the monitoring job.

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#model_monitoring_alert_config ⇒ ::Google::Cloud::AIPlatform::V1::ModelMonitoringAlertConfig

Returns Alert config for model monitoring.

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#name ⇒ ::String (readonly)

Returns Output only. Resource name of a ModelDeploymentMonitoringJob.

Returns:

  • (::String) —

    Output only. Resource name of a ModelDeploymentMonitoringJob.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#next_schedule_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round.

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#predict_instance_schema_uri ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#sample_predict_instance ⇒ ::Google::Protobuf::Value

Returns Sample Predict instance, same format as PredictRequest.instances, this can be set as a replacement of ModelDeploymentMonitoringJob.predict_instance_schema_uri. If not set, we will generate predict schema from collected predict requests.

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#satisfies_pzi ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#schedule_state ⇒ ::Google::Cloud::AIPlatform::V1::ModelDeploymentMonitoringJob::MonitoringScheduleState (readonly)

Returns Output only. Schedule state when the monitoring job is in Running state.

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#state ⇒ ::Google::Cloud::AIPlatform::V1::JobState (readonly)

Returns 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'.

Returns:

  • (::Google::Cloud::AIPlatform::V1::JobState) —

    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'.



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#stats_anomalies_base_directory ⇒ ::Google::Cloud::AIPlatform::V1::GcsDestination

Returns Stats anomalies base folder path.

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently.

Returns:



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'proto_docs/google/cloud/aiplatform/v1/model_deployment_monitoring_job.rb', line 150

class ModelDeploymentMonitoringJob
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # All metadata of most recent monitoring pipelines.
  # @!attribute [rw] run_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The time that most recent monitoring pipelines that is related to this
  #     run.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the most recent monitoring pipeline.
  class LatestMonitoringPipelineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The state to Specify the monitoring pipeline.
  module MonitoringScheduleState
    # Unspecified state.
    MONITORING_SCHEDULE_STATE_UNSPECIFIED = 0

    # The pipeline is picked up and wait to run.
    PENDING = 1

    # The pipeline is offline and will be scheduled for next run.
    OFFLINE = 2

    # The pipeline is running.
    RUNNING = 3
  end
end