public interface OnlineEvaluatorOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAgentResource()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The agentResource. |
getAgentResourceBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for agentResource. |
getCloudObservability()
public abstract 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 | |
|---|---|
| Type | Description |
OnlineEvaluator.CloudObservability |
The cloudObservability. |
getCloudObservabilityOrBuilder()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.CloudObservabilityOrBuilder |
|
getConfig()
public abstract OnlineEvaluator.Config getConfig()Required. Configuration for the OnlineEvaluator.
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Config |
The config. |
getConfigOrBuilder()
public abstract OnlineEvaluator.ConfigOrBuilder getConfigOrBuilder()Required. Configuration for the OnlineEvaluator.
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.ConfigOrBuilder |
|
getCreateTime()
public abstract Timestamp getCreateTime()Output only. Timestamp when the OnlineEvaluator was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp when the OnlineEvaluator was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDataSourceCase()
public abstract OnlineEvaluator.DataSourceCase getDataSourceCase()| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.DataSourceCase |
|
getDisplayName()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getMetricSources(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MetricSource |
|
getMetricSourcesCount()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
int |
|
getMetricSourcesList()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
List<MetricSource> |
|
getMetricSourcesOrBuilder(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MetricSourceOrBuilder |
|
getMetricSourcesOrBuilderList()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.MetricSourceOrBuilder> |
|
getName()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getState()
public abstract 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 | |
|---|---|
| Type | Description |
OnlineEvaluator.State |
The state. |
getStateDetails(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.StateDetails |
|
getStateDetailsCount()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
int |
|
getStateDetailsList()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
List<StateDetails> |
|
getStateDetailsOrBuilder(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.StateDetailsOrBuilder |
|
getStateDetailsOrBuilderList()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.OnlineEvaluator.StateDetailsOrBuilder> |
|
getStateValue()
public abstract int getStateValue()Output only. The state of the OnlineEvaluator.
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getUpdateTime()
public abstract Timestamp getUpdateTime()Output only. Timestamp when the OnlineEvaluator was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Timestamp when the OnlineEvaluator was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasCloudObservability()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the cloudObservability field is set. |
hasConfig()
public abstract boolean hasConfig()Required. Configuration for the OnlineEvaluator.
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the config field is set. |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. Timestamp when the OnlineEvaluator was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasUpdateTime()
public abstract boolean hasUpdateTime()Output only. Timestamp when the OnlineEvaluator was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |