Package com.google.cloud.aiplatform.v1beta1

Class OnlineEvaluator

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1beta1.OnlineEvaluator
All Implemented Interfaces:
OnlineEvaluatorOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class OnlineEvaluator extends com.google.protobuf.GeneratedMessage implements OnlineEvaluatorOrBuilder
 An OnlineEvaluator contains the configuration for an Online Evaluation.
Protobuf type google.cloud.aiplatform.v1beta1.OnlineEvaluator
See Also:

  • Field Details

    • CLOUD_OBSERVABILITY_FIELD_NUMBER

      public static final int CLOUD_OBSERVABILITY_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • AGENT_RESOURCE_FIELD_NUMBER

      public static final int AGENT_RESOURCE_FIELD_NUMBER
      See Also:

    • METRIC_SOURCES_FIELD_NUMBER

      public static final int METRIC_SOURCES_FIELD_NUMBER
      See Also:

    • CONFIG_FIELD_NUMBER

      public static final int CONFIG_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • STATE_DETAILS_FIELD_NUMBER

      public static final int STATE_DETAILS_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • UPDATE_TIME_FIELD_NUMBER

      public static final int UPDATE_TIME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getDataSourceCase

      public OnlineEvaluator.DataSourceCase getDataSourceCase()
      Specified by:
      getDataSourceCase in interface OnlineEvaluatorOrBuilder

    • hasCloudObservability

      public 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;
      Specified by:
      hasCloudObservability in interface OnlineEvaluatorOrBuilder
      Returns:
      Whether the cloudObservability field is set.

    • getCloudObservability

      public 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;
      Specified by:
      getCloudObservability in interface OnlineEvaluatorOrBuilder
      Returns:
      The cloudObservability.

    • getCloudObservabilityOrBuilder

      public 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;
      Specified by:
      getCloudObservabilityOrBuilder in interface OnlineEvaluatorOrBuilder

    • getName

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

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface OnlineEvaluatorOrBuilder
      Returns:
      The bytes for name.

    • getAgentResource

      public 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];
      Specified by:
      getAgentResource in interface OnlineEvaluatorOrBuilder
      Returns:
      The agentResource.

    • getAgentResourceBytes

      public 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];
      Specified by:
      getAgentResourceBytes in interface OnlineEvaluatorOrBuilder
      Returns:
      The bytes for agentResource.

    • getMetricSourcesList

      public 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];
      Specified by:
      getMetricSourcesList in interface OnlineEvaluatorOrBuilder

    • getMetricSourcesOrBuilderList

      public 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];
      Specified by:
      getMetricSourcesOrBuilderList in interface OnlineEvaluatorOrBuilder

    • getMetricSourcesCount

      public 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];
      Specified by:
      getMetricSourcesCount in interface OnlineEvaluatorOrBuilder

    • getMetricSources

      public 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];
      Specified by:
      getMetricSources in interface OnlineEvaluatorOrBuilder

    • getMetricSourcesOrBuilder

      public 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];
      Specified by:
      getMetricSourcesOrBuilder in interface OnlineEvaluatorOrBuilder

    • hasConfig

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

    • getConfig

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

    • getConfigOrBuilder

      public OnlineEvaluator.ConfigOrBuilder getConfigOrBuilder()
       Required. Configuration for the OnlineEvaluator.
      .google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getConfigOrBuilder in interface OnlineEvaluatorOrBuilder

    • getStateValue

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

    • getState

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

    • getStateDetailsList

      public 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];
      Specified by:
      getStateDetailsList in interface OnlineEvaluatorOrBuilder

    • getStateDetailsOrBuilderList

      public 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];
      Specified by:
      getStateDetailsOrBuilderList in interface OnlineEvaluatorOrBuilder

    • getStateDetailsCount

      public 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];
      Specified by:
      getStateDetailsCount in interface OnlineEvaluatorOrBuilder

    • getStateDetails

      public 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];
      Specified by:
      getStateDetails in interface OnlineEvaluatorOrBuilder

    • getStateDetailsOrBuilder

      public 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];
      Specified by:
      getStateDetailsOrBuilder in interface OnlineEvaluatorOrBuilder

    • hasCreateTime

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

    • getCreateTime

      public 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];
      Specified by:
      getCreateTime in interface OnlineEvaluatorOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public 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];
      Specified by:
      getCreateTimeOrBuilder in interface OnlineEvaluatorOrBuilder

    • hasUpdateTime

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

    • getUpdateTime

      public 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];
      Specified by:
      getUpdateTime in interface OnlineEvaluatorOrBuilder
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      public 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];
      Specified by:
      getUpdateTimeOrBuilder in interface OnlineEvaluatorOrBuilder

    • getDisplayName

      public 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];
      Specified by:
      getDisplayName in interface OnlineEvaluatorOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public 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];
      Specified by:
      getDisplayNameBytes in interface OnlineEvaluatorOrBuilder
      Returns:
      The bytes for displayName.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static OnlineEvaluator parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OnlineEvaluator parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OnlineEvaluator parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OnlineEvaluator parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OnlineEvaluator parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OnlineEvaluator parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OnlineEvaluator parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OnlineEvaluator parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OnlineEvaluator parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OnlineEvaluator parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OnlineEvaluator parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OnlineEvaluator parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public OnlineEvaluator.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static OnlineEvaluator.Builder newBuilder()

    • newBuilder

      public static OnlineEvaluator.Builder newBuilder(OnlineEvaluator prototype)

    • toBuilder

      public OnlineEvaluator.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected OnlineEvaluator.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static OnlineEvaluator getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<OnlineEvaluator> parser()

    • getParserForType

      public com.google.protobuf.Parser<OnlineEvaluator> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public OnlineEvaluator getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder