public static final class OnlineEvaluator.Builder extends GeneratedMessage.Builder<OnlineEvaluator.Builder> implements OnlineEvaluatorOrBuilderAn OnlineEvaluator contains the configuration for an Online Evaluation.
Protobuf type google.cloud.aiplatform.v1beta1.OnlineEvaluator
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > OnlineEvaluator.BuilderImplements
OnlineEvaluatorOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllMetricSources(Iterable<? extends MetricSource> values)
public OnlineEvaluator.Builder addAllMetricSources(Iterable<? extends MetricSource> values)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 |
values |
Iterable<? extends com.google.cloud.aiplatform.v1beta1.MetricSource> |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
addAllStateDetails(Iterable<? extends OnlineEvaluator.StateDetails> values)
public OnlineEvaluator.Builder addAllStateDetails(Iterable<? extends OnlineEvaluator.StateDetails> values)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 |
values |
Iterable<? extends com.google.cloud.aiplatform.v1beta1.OnlineEvaluator.StateDetails> |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
addMetricSources(MetricSource value)
public OnlineEvaluator.Builder addMetricSources(MetricSource value)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 |
value |
MetricSource |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
addMetricSources(MetricSource.Builder builderForValue)
public OnlineEvaluator.Builder addMetricSources(MetricSource.Builder builderForValue)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 |
builderForValue |
MetricSource.Builder |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
addMetricSources(int index, MetricSource value)
public OnlineEvaluator.Builder addMetricSources(int index, MetricSource value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
MetricSource |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
addMetricSources(int index, MetricSource.Builder builderForValue)
public OnlineEvaluator.Builder addMetricSources(int index, MetricSource.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
MetricSource.Builder |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
addMetricSourcesBuilder()
public MetricSource.Builder addMetricSourcesBuilder()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 |
MetricSource.Builder |
|
addMetricSourcesBuilder(int index)
public MetricSource.Builder addMetricSourcesBuilder(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.Builder |
|
addStateDetails(OnlineEvaluator.StateDetails value)
public OnlineEvaluator.Builder addStateDetails(OnlineEvaluator.StateDetails value)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 |
value |
OnlineEvaluator.StateDetails |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
addStateDetails(OnlineEvaluator.StateDetails.Builder builderForValue)
public OnlineEvaluator.Builder addStateDetails(OnlineEvaluator.StateDetails.Builder builderForValue)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 |
builderForValue |
OnlineEvaluator.StateDetails.Builder |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
addStateDetails(int index, OnlineEvaluator.StateDetails value)
public OnlineEvaluator.Builder addStateDetails(int index, OnlineEvaluator.StateDetails value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
OnlineEvaluator.StateDetails |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
addStateDetails(int index, OnlineEvaluator.StateDetails.Builder builderForValue)
public OnlineEvaluator.Builder addStateDetails(int index, OnlineEvaluator.StateDetails.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
OnlineEvaluator.StateDetails.Builder |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
addStateDetailsBuilder()
public OnlineEvaluator.StateDetails.Builder addStateDetailsBuilder()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 |
OnlineEvaluator.StateDetails.Builder |
|
addStateDetailsBuilder(int index)
public OnlineEvaluator.StateDetails.Builder addStateDetailsBuilder(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.Builder |
|
build()
public OnlineEvaluator build()| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator |
|
buildPartial()
public OnlineEvaluator buildPartial()| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator |
|
clear()
public OnlineEvaluator.Builder clear()| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
clearAgentResource()
public OnlineEvaluator.Builder clearAgentResource()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 |
OnlineEvaluator.Builder |
This builder for chaining. |
clearCloudObservability()
public OnlineEvaluator.Builder clearCloudObservability()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.Builder |
|
clearConfig()
public OnlineEvaluator.Builder clearConfig()Required. Configuration for the OnlineEvaluator.
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
clearCreateTime()
public OnlineEvaluator.Builder clearCreateTime()Output only. Timestamp when the OnlineEvaluator was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
clearDataSource()
public OnlineEvaluator.Builder clearDataSource()| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
clearDisplayName()
public OnlineEvaluator.Builder clearDisplayName() 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 |
OnlineEvaluator.Builder |
This builder for chaining. |
clearMetricSources()
public OnlineEvaluator.Builder clearMetricSources()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 |
OnlineEvaluator.Builder |
|
clearName()
public OnlineEvaluator.Builder clearName()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 |
OnlineEvaluator.Builder |
This builder for chaining. |
clearState()
public OnlineEvaluator.Builder clearState()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.Builder |
This builder for chaining. |
clearStateDetails()
public OnlineEvaluator.Builder clearStateDetails()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 |
OnlineEvaluator.Builder |
|
clearUpdateTime()
public OnlineEvaluator.Builder clearUpdateTime()Output only. Timestamp when the OnlineEvaluator was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
String |
The agentResource. |
getAgentResourceBytes()
public 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 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. |
getCloudObservabilityBuilder()
public OnlineEvaluator.CloudObservability.Builder getCloudObservabilityBuilder()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.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.CloudObservabilityOrBuilder |
|
getConfig()
public 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. |
getConfigBuilder()
public OnlineEvaluator.Config.Builder getConfigBuilder()Required. Configuration for the OnlineEvaluator.
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Config.Builder |
|
getConfigOrBuilder()
public 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 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. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Timestamp when the OnlineEvaluator was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
public 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 OnlineEvaluator.DataSourceCase getDataSourceCase()| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.DataSourceCase |
|
getDefaultInstanceForType()
public OnlineEvaluator getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public 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 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 |
|
getMetricSourcesBuilder(int index)
public MetricSource.Builder getMetricSourcesBuilder(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.Builder |
|
getMetricSourcesBuilderList()
public List<MetricSource.Builder> getMetricSourcesBuilderList()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<Builder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
int |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<MetricSource> |
|
getMetricSourcesOrBuilder(int index)
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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
MetricSourceOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.MetricSourceOrBuilder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public 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 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 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 |
|
getStateDetailsBuilder(int index)
public OnlineEvaluator.StateDetails.Builder getStateDetailsBuilder(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.Builder |
|
getStateDetailsBuilderList()
public List<OnlineEvaluator.StateDetails.Builder> getStateDetailsBuilderList()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<Builder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
int |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<StateDetails> |
|
getStateDetailsOrBuilder(int index)
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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.StateDetailsOrBuilder |
|
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];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.OnlineEvaluator.StateDetailsOrBuilder> |
|
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];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getUpdateTime()
public 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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. Timestamp when the OnlineEvaluator was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getUpdateTimeOrBuilder()
public 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCloudObservability(OnlineEvaluator.CloudObservability value)
public OnlineEvaluator.Builder mergeCloudObservability(OnlineEvaluator.CloudObservability value)Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging).
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.CloudObservability cloud_observability = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
OnlineEvaluator.CloudObservability |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
mergeConfig(OnlineEvaluator.Config value)
public OnlineEvaluator.Builder mergeConfig(OnlineEvaluator.Config value)Required. Configuration for the OnlineEvaluator.
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
OnlineEvaluator.Config |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
mergeCreateTime(Timestamp value)
public OnlineEvaluator.Builder mergeCreateTime(Timestamp value)Output only. Timestamp when the OnlineEvaluator was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
mergeFrom(OnlineEvaluator other)
public OnlineEvaluator.Builder mergeFrom(OnlineEvaluator other)| Parameter | |
|---|---|
| Name | Description |
other |
OnlineEvaluator |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public OnlineEvaluator.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public OnlineEvaluator.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
mergeUpdateTime(Timestamp value)
public OnlineEvaluator.Builder mergeUpdateTime(Timestamp value)Output only. Timestamp when the OnlineEvaluator was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
removeMetricSources(int index)
public OnlineEvaluator.Builder removeMetricSources(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 |
OnlineEvaluator.Builder |
|
removeStateDetails(int index)
public OnlineEvaluator.Builder removeStateDetails(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.Builder |
|
setAgentResource(String value)
public OnlineEvaluator.Builder setAgentResource(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe agentResource to set. |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
This builder for chaining. |
setAgentResourceBytes(ByteString value)
public OnlineEvaluator.Builder setAgentResourceBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for agentResource to set. |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
This builder for chaining. |
setCloudObservability(OnlineEvaluator.CloudObservability value)
public OnlineEvaluator.Builder setCloudObservability(OnlineEvaluator.CloudObservability value)Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging).
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.CloudObservability cloud_observability = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
OnlineEvaluator.CloudObservability |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
setCloudObservability(OnlineEvaluator.CloudObservability.Builder builderForValue)
public OnlineEvaluator.Builder setCloudObservability(OnlineEvaluator.CloudObservability.Builder builderForValue)Data source for the OnlineEvaluator, based on GCP Observability stack (Cloud Trace & Cloud Logging).
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.CloudObservability cloud_observability = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
OnlineEvaluator.CloudObservability.Builder |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
setConfig(OnlineEvaluator.Config value)
public OnlineEvaluator.Builder setConfig(OnlineEvaluator.Config value)Required. Configuration for the OnlineEvaluator.
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
OnlineEvaluator.Config |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
setConfig(OnlineEvaluator.Config.Builder builderForValue)
public OnlineEvaluator.Builder setConfig(OnlineEvaluator.Config.Builder builderForValue)Required. Configuration for the OnlineEvaluator.
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
OnlineEvaluator.Config.Builder |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
setCreateTime(Timestamp value)
public OnlineEvaluator.Builder setCreateTime(Timestamp value)Output only. Timestamp when the OnlineEvaluator was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public OnlineEvaluator.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Timestamp when the OnlineEvaluator was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
setDisplayName(String value)
public OnlineEvaluator.Builder setDisplayName(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public OnlineEvaluator.Builder setDisplayNameBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
This builder for chaining. |
setMetricSources(int index, MetricSource value)
public OnlineEvaluator.Builder setMetricSources(int index, MetricSource value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
MetricSource |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
setMetricSources(int index, MetricSource.Builder builderForValue)
public OnlineEvaluator.Builder setMetricSources(int index, MetricSource.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
MetricSource.Builder |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
setName(String value)
public OnlineEvaluator.Builder setName(String value)Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public OnlineEvaluator.Builder setNameBytes(ByteString value)Identifier. The resource name of the OnlineEvaluator. Format: projects/{project}/locations/{location}/onlineEvaluators/{id}.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
This builder for chaining. |
setState(OnlineEvaluator.State value)
public OnlineEvaluator.Builder setState(OnlineEvaluator.State value)Output only. The state of the OnlineEvaluator.
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
OnlineEvaluator.StateThe state to set. |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
This builder for chaining. |
setStateDetails(int index, OnlineEvaluator.StateDetails value)
public OnlineEvaluator.Builder setStateDetails(int index, OnlineEvaluator.StateDetails value)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
OnlineEvaluator.StateDetails |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
setStateDetails(int index, OnlineEvaluator.StateDetails.Builder builderForValue)
public OnlineEvaluator.Builder setStateDetails(int index, OnlineEvaluator.StateDetails.Builder builderForValue)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];
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
OnlineEvaluator.StateDetails.Builder |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
setStateValue(int value)
public OnlineEvaluator.Builder setStateValue(int value)Output only. The state of the OnlineEvaluator.
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for state to set. |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
This builder for chaining. |
setUpdateTime(Timestamp value)
public OnlineEvaluator.Builder setUpdateTime(Timestamp value)Output only. Timestamp when the OnlineEvaluator was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public OnlineEvaluator.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Timestamp when the OnlineEvaluator was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
OnlineEvaluator.Builder |
|