Class Evaluation.Builder (0.141.0)

public static final class Evaluation.Builder extends GeneratedMessageV3.Builder<Evaluation.Builder> implements EvaluationOrBuilder

Describes an evaluation between a machine learning model's predictions and ground truth labels. Created when an EvaluationJob runs successfully.

Protobuf type google.cloud.datalabeling.v1beta1.Evaluation

Implements

EvaluationOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Evaluation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Evaluation.Builder
Overrides

build()

public Evaluation build()
Returns
TypeDescription
Evaluation

buildPartial()

public Evaluation buildPartial()
Returns
TypeDescription
Evaluation

clear()

public Evaluation.Builder clear()
Returns
TypeDescription
Evaluation.Builder
Overrides

clearAnnotationType()

public Evaluation.Builder clearAnnotationType()

Output only. Type of task that the model version being evaluated performs, as defined in the

evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 6;

Returns
TypeDescription
Evaluation.Builder

This builder for chaining.

clearConfig()

public Evaluation.Builder clearConfig()

Output only. Options used in the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;

Returns
TypeDescription
Evaluation.Builder

clearCreateTime()

public Evaluation.Builder clearCreateTime()

Output only. Timestamp for when this evaluation was created.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
Evaluation.Builder

clearEvaluatedItemCount()

public Evaluation.Builder clearEvaluatedItemCount()

Output only. The number of items in the ground truth dataset that were used for this evaluation. Only populated when the evaulation is for certain AnnotationTypes.

int64 evaluated_item_count = 7;

Returns
TypeDescription
Evaluation.Builder

This builder for chaining.

clearEvaluationJobRunTime()

public Evaluation.Builder clearEvaluationJobRunTime()

Output only. Timestamp for when the evaluation job that created this evaluation ran.

.google.protobuf.Timestamp evaluation_job_run_time = 3;

Returns
TypeDescription
Evaluation.Builder

clearEvaluationMetrics()

public Evaluation.Builder clearEvaluationMetrics()

Output only. Metrics comparing predictions to ground truth labels.

.google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;

Returns
TypeDescription
Evaluation.Builder

clearField(Descriptors.FieldDescriptor field)

public Evaluation.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Evaluation.Builder
Overrides

clearName()

public Evaluation.Builder clearName()

Output only. Resource name of an evaluation. The name has the following format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id</var>}'

string name = 1;

Returns
TypeDescription
Evaluation.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Evaluation.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Evaluation.Builder
Overrides

clone()

public Evaluation.Builder clone()
Returns
TypeDescription
Evaluation.Builder
Overrides

getAnnotationType()

public AnnotationType getAnnotationType()

Output only. Type of task that the model version being evaluated performs, as defined in the

evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 6;

Returns
TypeDescription
AnnotationType

The annotationType.

getAnnotationTypeValue()

public int getAnnotationTypeValue()

Output only. Type of task that the model version being evaluated performs, as defined in the

evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for annotationType.

getConfig()

public EvaluationConfig getConfig()

Output only. Options used in the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;

Returns
TypeDescription
EvaluationConfig

The config.

getConfigBuilder()

public EvaluationConfig.Builder getConfigBuilder()

Output only. Options used in the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;

Returns
TypeDescription
EvaluationConfig.Builder

getConfigOrBuilder()

public EvaluationConfigOrBuilder getConfigOrBuilder()

Output only. Options used in the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;

Returns
TypeDescription
EvaluationConfigOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp for when this evaluation was created.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp for when this evaluation was created.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp for when this evaluation was created.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Evaluation getDefaultInstanceForType()
Returns
TypeDescription
Evaluation

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEvaluatedItemCount()

public long getEvaluatedItemCount()

Output only. The number of items in the ground truth dataset that were used for this evaluation. Only populated when the evaulation is for certain AnnotationTypes.

int64 evaluated_item_count = 7;

Returns
TypeDescription
long

The evaluatedItemCount.

getEvaluationJobRunTime()

public Timestamp getEvaluationJobRunTime()

Output only. Timestamp for when the evaluation job that created this evaluation ran.

.google.protobuf.Timestamp evaluation_job_run_time = 3;

Returns
TypeDescription
Timestamp

The evaluationJobRunTime.

getEvaluationJobRunTimeBuilder()

public Timestamp.Builder getEvaluationJobRunTimeBuilder()

Output only. Timestamp for when the evaluation job that created this evaluation ran.

.google.protobuf.Timestamp evaluation_job_run_time = 3;

Returns
TypeDescription
Builder

getEvaluationJobRunTimeOrBuilder()

public TimestampOrBuilder getEvaluationJobRunTimeOrBuilder()

Output only. Timestamp for when the evaluation job that created this evaluation ran.

.google.protobuf.Timestamp evaluation_job_run_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getEvaluationMetrics()

public EvaluationMetrics getEvaluationMetrics()

Output only. Metrics comparing predictions to ground truth labels.

.google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;

Returns
TypeDescription
EvaluationMetrics

The evaluationMetrics.

getEvaluationMetricsBuilder()

public EvaluationMetrics.Builder getEvaluationMetricsBuilder()

Output only. Metrics comparing predictions to ground truth labels.

.google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;

Returns
TypeDescription
EvaluationMetrics.Builder

getEvaluationMetricsOrBuilder()

public EvaluationMetricsOrBuilder getEvaluationMetricsOrBuilder()

Output only. Metrics comparing predictions to ground truth labels.

.google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;

Returns
TypeDescription
EvaluationMetricsOrBuilder

getName()

public String getName()

Output only. Resource name of an evaluation. The name has the following format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id</var>}'

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Resource name of an evaluation. The name has the following format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id</var>}'

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

hasConfig()

public boolean hasConfig()

Output only. Options used in the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;

Returns
TypeDescription
boolean

Whether the config field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp for when this evaluation was created.

.google.protobuf.Timestamp create_time = 4;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasEvaluationJobRunTime()

public boolean hasEvaluationJobRunTime()

Output only. Timestamp for when the evaluation job that created this evaluation ran.

.google.protobuf.Timestamp evaluation_job_run_time = 3;

Returns
TypeDescription
boolean

Whether the evaluationJobRunTime field is set.

hasEvaluationMetrics()

public boolean hasEvaluationMetrics()

Output only. Metrics comparing predictions to ground truth labels.

.google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;

Returns
TypeDescription
boolean

Whether the evaluationMetrics field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeConfig(EvaluationConfig value)

public Evaluation.Builder mergeConfig(EvaluationConfig value)

Output only. Options used in the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;

Parameter
NameDescription
valueEvaluationConfig
Returns
TypeDescription
Evaluation.Builder

mergeCreateTime(Timestamp value)

public Evaluation.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp for when this evaluation was created.

.google.protobuf.Timestamp create_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Evaluation.Builder

mergeEvaluationJobRunTime(Timestamp value)

public Evaluation.Builder mergeEvaluationJobRunTime(Timestamp value)

Output only. Timestamp for when the evaluation job that created this evaluation ran.

.google.protobuf.Timestamp evaluation_job_run_time = 3;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Evaluation.Builder

mergeEvaluationMetrics(EvaluationMetrics value)

public Evaluation.Builder mergeEvaluationMetrics(EvaluationMetrics value)

Output only. Metrics comparing predictions to ground truth labels.

.google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;

Parameter
NameDescription
valueEvaluationMetrics
Returns
TypeDescription
Evaluation.Builder

mergeFrom(Evaluation other)

public Evaluation.Builder mergeFrom(Evaluation other)
Parameter
NameDescription
otherEvaluation
Returns
TypeDescription
Evaluation.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Evaluation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Evaluation.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Evaluation.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Evaluation.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Evaluation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Evaluation.Builder
Overrides

setAnnotationType(AnnotationType value)

public Evaluation.Builder setAnnotationType(AnnotationType value)

Output only. Type of task that the model version being evaluated performs, as defined in the

evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 6;

Parameter
NameDescription
valueAnnotationType

The annotationType to set.

Returns
TypeDescription
Evaluation.Builder

This builder for chaining.

setAnnotationTypeValue(int value)

public Evaluation.Builder setAnnotationTypeValue(int value)

Output only. Type of task that the model version being evaluated performs, as defined in the

evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.AnnotationType annotation_type = 6;

Parameter
NameDescription
valueint

The enum numeric value on the wire for annotationType to set.

Returns
TypeDescription
Evaluation.Builder

This builder for chaining.

setConfig(EvaluationConfig value)

public Evaluation.Builder setConfig(EvaluationConfig value)

Output only. Options used in the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;

Parameter
NameDescription
valueEvaluationConfig
Returns
TypeDescription
Evaluation.Builder

setConfig(EvaluationConfig.Builder builderForValue)

public Evaluation.Builder setConfig(EvaluationConfig.Builder builderForValue)

Output only. Options used in the evaluation job that created this evaluation.

.google.cloud.datalabeling.v1beta1.EvaluationConfig config = 2;

Parameter
NameDescription
builderForValueEvaluationConfig.Builder
Returns
TypeDescription
Evaluation.Builder

setCreateTime(Timestamp value)

public Evaluation.Builder setCreateTime(Timestamp value)

Output only. Timestamp for when this evaluation was created.

.google.protobuf.Timestamp create_time = 4;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Evaluation.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Evaluation.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp for when this evaluation was created.

.google.protobuf.Timestamp create_time = 4;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Evaluation.Builder

setEvaluatedItemCount(long value)

public Evaluation.Builder setEvaluatedItemCount(long value)

Output only. The number of items in the ground truth dataset that were used for this evaluation. Only populated when the evaulation is for certain AnnotationTypes.

int64 evaluated_item_count = 7;

Parameter
NameDescription
valuelong

The evaluatedItemCount to set.

Returns
TypeDescription
Evaluation.Builder

This builder for chaining.

setEvaluationJobRunTime(Timestamp value)

public Evaluation.Builder setEvaluationJobRunTime(Timestamp value)

Output only. Timestamp for when the evaluation job that created this evaluation ran.

.google.protobuf.Timestamp evaluation_job_run_time = 3;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
Evaluation.Builder

setEvaluationJobRunTime(Timestamp.Builder builderForValue)

public Evaluation.Builder setEvaluationJobRunTime(Timestamp.Builder builderForValue)

Output only. Timestamp for when the evaluation job that created this evaluation ran.

.google.protobuf.Timestamp evaluation_job_run_time = 3;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Evaluation.Builder

setEvaluationMetrics(EvaluationMetrics value)

public Evaluation.Builder setEvaluationMetrics(EvaluationMetrics value)

Output only. Metrics comparing predictions to ground truth labels.

.google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;

Parameter
NameDescription
valueEvaluationMetrics
Returns
TypeDescription
Evaluation.Builder

setEvaluationMetrics(EvaluationMetrics.Builder builderForValue)

public Evaluation.Builder setEvaluationMetrics(EvaluationMetrics.Builder builderForValue)

Output only. Metrics comparing predictions to ground truth labels.

.google.cloud.datalabeling.v1beta1.EvaluationMetrics evaluation_metrics = 5;

Parameter
NameDescription
builderForValueEvaluationMetrics.Builder
Returns
TypeDescription
Evaluation.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Evaluation.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Evaluation.Builder
Overrides

setName(String value)

public Evaluation.Builder setName(String value)

Output only. Resource name of an evaluation. The name has the following format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id</var>}'

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Evaluation.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Evaluation.Builder setNameBytes(ByteString value)

Output only. Resource name of an evaluation. The name has the following format:

"projects/<var>{project_id}</var>/datasets/<var>{dataset_id}</var>/evaluations/<var>{evaluation_id</var>}'

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Evaluation.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Evaluation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Evaluation.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Evaluation.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Evaluation.Builder
Overrides