public final class OnlineEvaluator extends GeneratedMessage implements OnlineEvaluatorOrBuilder
An OnlineEvaluator contains the configuration for an Online Evaluation.
Protobuf type google.cloud.aiplatform.v1beta1.OnlineEvaluator
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
public static final int AGENT_RESOURCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CLOUD_OBSERVABILITY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int METRIC_SOURCES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int STATE_DETAILS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static OnlineEvaluator getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static OnlineEvaluator.Builder newBuilder()
public static OnlineEvaluator.Builder newBuilder(OnlineEvaluator prototype)
public static OnlineEvaluator parseDelimitedFrom(InputStream input)
public static OnlineEvaluator parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static OnlineEvaluator parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static OnlineEvaluator parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static OnlineEvaluator parseFrom(ByteString data)
public static OnlineEvaluator parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static OnlineEvaluator parseFrom(CodedInputStream input)
public static OnlineEvaluator parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static OnlineEvaluator parseFrom(InputStream input)
public static OnlineEvaluator parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static OnlineEvaluator parseFrom(ByteBuffer data)
public static OnlineEvaluator parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<OnlineEvaluator> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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.
|
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.
|
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;
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;
public OnlineEvaluator.Config getConfig()
Required. Configuration for the OnlineEvaluator.
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];
public OnlineEvaluator.ConfigOrBuilder getConfigOrBuilder()
Required. Configuration for the OnlineEvaluator.
.google.cloud.aiplatform.v1beta1.OnlineEvaluator.Config config = 5 [(.google.api.field_behavior) = REQUIRED];
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.
|
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp when the OnlineEvaluator was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public OnlineEvaluator.DataSourceCase getDataSourceCase()
public OnlineEvaluator getDefaultInstanceForType()
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.
|
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.
|
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
|
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 |
|
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];
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
|
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> |
|
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.
|
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.
|
public Parser<OnlineEvaluator> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
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
|
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 |
|
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];
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
|
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> |
|
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.
|
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.
|
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp when the OnlineEvaluator was last updated.
.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
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.
|
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.
|
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.
|
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public OnlineEvaluator.Builder newBuilderForType()
protected OnlineEvaluator.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
public OnlineEvaluator.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
