Package com.google.cloud.aiplatform.v1beta1

Interface OnlineEvaluatorOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
OnlineEvaluator, OnlineEvaluator.Builder
@Generated public interface OnlineEvaluatorOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasCloudObservability

      boolean hasCloudObservability()
       Data source for the OnlineEvaluator, based on GCP Observability stack
 (Cloud Trace & Cloud Logging).
      .google.cloud.aiplatform.v1beta1.OnlineEvaluator.CloudObservability cloud_observability = 4;
      Returns:
      Whether the cloudObservability field is set.

    • getCloudObservability

      OnlineEvaluator.CloudObservability getCloudObservability()
       Data source for the OnlineEvaluator, based on GCP Observability stack
 (Cloud Trace & Cloud Logging).
      .google.cloud.aiplatform.v1beta1.OnlineEvaluator.CloudObservability cloud_observability = 4;
      Returns:
      The cloudObservability.

    • getCloudObservabilityOrBuilder

      OnlineEvaluator.CloudObservabilityOrBuilder getCloudObservabilityOrBuilder()
       Data source for the OnlineEvaluator, based on GCP Observability stack
 (Cloud Trace & Cloud Logging).
      .google.cloud.aiplatform.v1beta1.OnlineEvaluator.CloudObservability cloud_observability = 4;

    • getName

      String getName()
       Identifier. The resource name of the OnlineEvaluator.
 Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Identifier. The resource name of the OnlineEvaluator.
 Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
      string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
      Returns:
      The bytes for name.

    • getAgentResource

      String getAgentResource()
       Required. Immutable. The name of the agent that the OnlineEvaluator
 evaluates periodically. This value is used to filter the traces with a
 matching cloud.resource_id and link the evaluation results with relevant
 dashboards/UIs.

 This field is immutable. Once set, it cannot be changed.
      string agent_resource = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The agentResource.

    • getAgentResourceBytes

      com.google.protobuf.ByteString getAgentResourceBytes()
       Required. Immutable. The name of the agent that the OnlineEvaluator
 evaluates periodically. This value is used to filter the traces with a
 matching cloud.resource_id and link the evaluation results with relevant
 dashboards/UIs.

 This field is immutable. Once set, it cannot be changed.
      string agent_resource = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The bytes for agentResource.

    • getMetricSourcesList

      List<MetricSource> getMetricSourcesList()
       Required. A list of metric sources to be used for evaluating samples.
 At least one MetricSource must be provided.
 Right now, only predefined metrics and registered metrics are supported.

 Every registered metric must have `display_name` (or `title`) and
 `score_range` defined. Otherwise, the evaluations will fail.

 The maximum number of `metric_sources` is 25.
      repeated .google.cloud.aiplatform.v1beta1.MetricSource metric_sources = 3 [(.google.api.field_behavior) = REQUIRED];

    • getMetricSources

      MetricSource getMetricSources(int index)
       Required. A list of metric sources to be used for evaluating samples.
 At least one MetricSource must be provided.
 Right now, only predefined metrics and registered metrics are supported.

 Every registered metric must have `display_name` (or `title`) and
 `score_range` defined. Otherwise, the evaluations will fail.

 The maximum number of `metric_sources` is 25.
      repeated .google.cloud.aiplatform.v1beta1.MetricSource metric_sources = 3 [(.google.api.field_behavior) = REQUIRED];

    • getMetricSourcesCount

      int getMetricSourcesCount()
       Required. A list of metric sources to be used for evaluating samples.
 At least one MetricSource must be provided.
 Right now, only predefined metrics and registered metrics are supported.

 Every registered metric must have `display_name` (or `title`) and
 `score_range` defined. Otherwise, the evaluations will fail.

 The maximum number of `metric_sources` is 25.
      repeated .google.cloud.aiplatform.v1beta1.MetricSource metric_sources = 3 [(.google.api.field_behavior) = REQUIRED];

    • getMetricSourcesOrBuilderList

      List<? extends MetricSourceOrBuilder> getMetricSourcesOrBuilderList()
       Required. A list of metric sources to be used for evaluating samples.
 At least one MetricSource must be provided.
 Right now, only predefined metrics and registered metrics are supported.

 Every registered metric must have `display_name` (or `title`) and
 `score_range` defined. Otherwise, the evaluations will fail.

 The maximum number of `metric_sources` is 25.
      repeated .google.cloud.aiplatform.v1beta1.MetricSource metric_sources = 3 [(.google.api.field_behavior) = REQUIRED];

    • getMetricSourcesOrBuilder

      MetricSourceOrBuilder getMetricSourcesOrBuilder(int index)
       Required. A list of metric sources to be used for evaluating samples.
 At least one MetricSource must be provided.
 Right now, only predefined metrics and registered metrics are supported.

 Every registered metric must have `display_name` (or `title`) and
 `score_range` defined. Otherwise, the evaluations will fail.

 The maximum number of `metric_sources` is 25.
      repeated .google.cloud.aiplatform.v1beta1.MetricSource metric_sources = 3 [(.google.api.field_behavior) = REQUIRED];

    • hasConfig

      boolean hasConfig()
       Required. Configuration for the OnlineEvaluator.
      .google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      Whether the config field is set.

    • getConfig

      OnlineEvaluator.Config getConfig()
       Required. Configuration for the OnlineEvaluator.
      .google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The config.

    • getConfigOrBuilder

      OnlineEvaluator.ConfigOrBuilder getConfigOrBuilder()
       Required. Configuration for the OnlineEvaluator.
      .google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];

    • getStateValue

      int getStateValue()
       Output only. The state of the OnlineEvaluator.
      .google.cloud.aiplatform.v1beta1.OnlineEvaluator.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The enum numeric value on the wire for state.

    • getState

      OnlineEvaluator.State getState()
       Output only. The state of the OnlineEvaluator.
      .google.cloud.aiplatform.v1beta1.OnlineEvaluator.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The state.

    • getStateDetailsList

      List<OnlineEvaluator.StateDetails> getStateDetailsList()
       Output only. Contains additional information about the state of the
 OnlineEvaluator. This is used to provide more details in the event of a
 failure.
      repeated .google.cloud.aiplatform.v1beta1.OnlineEvaluator.StateDetails state_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getStateDetails

      OnlineEvaluator.StateDetails getStateDetails(int index)
       Output only. Contains additional information about the state of the
 OnlineEvaluator. This is used to provide more details in the event of a
 failure.
      repeated .google.cloud.aiplatform.v1beta1.OnlineEvaluator.StateDetails state_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getStateDetailsCount

      int getStateDetailsCount()
       Output only. Contains additional information about the state of the
 OnlineEvaluator. This is used to provide more details in the event of a
 failure.
      repeated .google.cloud.aiplatform.v1beta1.OnlineEvaluator.StateDetails state_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getStateDetailsOrBuilderList

      List<? extends OnlineEvaluator.StateDetailsOrBuilder> getStateDetailsOrBuilderList()
       Output only. Contains additional information about the state of the
 OnlineEvaluator. This is used to provide more details in the event of a
 failure.
      repeated .google.cloud.aiplatform.v1beta1.OnlineEvaluator.StateDetails state_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getStateDetailsOrBuilder

      OnlineEvaluator.StateDetailsOrBuilder getStateDetailsOrBuilder(int index)
       Output only. Contains additional information about the state of the
 OnlineEvaluator. This is used to provide more details in the event of a
 failure.
      repeated .google.cloud.aiplatform.v1beta1.OnlineEvaluator.StateDetails state_details = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasCreateTime

      boolean hasCreateTime()
       Output only. Timestamp when the OnlineEvaluator was created.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. Timestamp when the OnlineEvaluator was created.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. Timestamp when the OnlineEvaluator was created.
      .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. Timestamp when the OnlineEvaluator was last updated.
      .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. Timestamp when the OnlineEvaluator was last updated.
      .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. Timestamp when the OnlineEvaluator was last updated.
      .google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getDisplayName

      String getDisplayName()
       Optional. Human-readable name for the `OnlineEvaluator`.

 The name doesn't have to be unique.

 The name can consist of any UTF-8 characters. The maximum length is `63`
 characters. If the display name exceeds max characters, an
 `INVALID_ARGUMENT` error is returned.
      string display_name = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Optional. Human-readable name for the `OnlineEvaluator`.

 The name doesn't have to be unique.

 The name can consist of any UTF-8 characters. The maximum length is `63`
 characters. If the display name exceeds max characters, an
 `INVALID_ARGUMENT` error is returned.
      string display_name = 9 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for displayName.

    • getDataSourceCase

      OnlineEvaluator.DataSourceCase getDataSourceCase()