Class GeneratorEvaluation (4.87.0)

public final class GeneratorEvaluation extends GeneratedMessageV3 implements GeneratorEvaluationOrBuilder

Represents evaluation result of a generator.

Protobuf type google.cloud.dialogflow.v2.GeneratorEvaluation

Static Fields

COMPLETE_TIME_FIELD_NUMBER

public static final int COMPLETE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EVALUATION_STATUS_FIELD_NUMBER

public static final int EVALUATION_STATUS_FIELD_NUMBER
Field Value
Type Description
int

GENERATOR_EVALUATION_CONFIG_FIELD_NUMBER

public static final int GENERATOR_EVALUATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

INITIAL_GENERATOR_FIELD_NUMBER

public static final int INITIAL_GENERATOR_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int

SUMMARIZATION_METRICS_FIELD_NUMBER

public static final int SUMMARIZATION_METRICS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GeneratorEvaluation getDefaultInstance()
Returns
Type Description
GeneratorEvaluation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static GeneratorEvaluation.Builder newBuilder()
Returns
Type Description
GeneratorEvaluation.Builder

newBuilder(GeneratorEvaluation prototype)

public static GeneratorEvaluation.Builder newBuilder(GeneratorEvaluation prototype)
Parameter
Name Description
prototype GeneratorEvaluation
Returns
Type Description
GeneratorEvaluation.Builder

parseDelimitedFrom(InputStream input)

public static GeneratorEvaluation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GeneratorEvaluation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GeneratorEvaluation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GeneratorEvaluation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GeneratorEvaluation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GeneratorEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GeneratorEvaluation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GeneratorEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GeneratorEvaluation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GeneratorEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GeneratorEvaluation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GeneratorEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GeneratorEvaluation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GeneratorEvaluation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GeneratorEvaluation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GeneratorEvaluation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GeneratorEvaluation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GeneratorEvaluation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GeneratorEvaluation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GeneratorEvaluation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GeneratorEvaluation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GeneratorEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GeneratorEvaluation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GeneratorEvaluation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GeneratorEvaluation> parser()
Returns
Type Description
Parser<GeneratorEvaluation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCompleteTime()

public Timestamp getCompleteTime()

Output only. Completion time of this generator evaluation.

.google.protobuf.Timestamp complete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The completeTime.

getCompleteTimeOrBuilder()

public TimestampOrBuilder getCompleteTimeOrBuilder()

Output only. Completion time of this generator evaluation.

.google.protobuf.Timestamp complete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Creation time of this generator evaluation.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation time of this generator evaluation.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public GeneratorEvaluation getDefaultInstanceForType()
Returns
Type Description
GeneratorEvaluation

getDisplayName()

public String getDisplayName()

Optional. The display name of the generator evaluation. At most 64 bytes long.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. The display name of the generator evaluation. At most 64 bytes long.

string display_name = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getEvaluationStatus()

public EvaluationStatus getEvaluationStatus()

Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.

.google.cloud.dialogflow.v2.EvaluationStatus evaluation_status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationStatus

The evaluationStatus.

getEvaluationStatusOrBuilder()

public EvaluationStatusOrBuilder getEvaluationStatusOrBuilder()

Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.

.google.cloud.dialogflow.v2.EvaluationStatus evaluation_status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
EvaluationStatusOrBuilder

getGeneratorEvaluationConfig()

public GeneratorEvaluationConfig getGeneratorEvaluationConfig()

Required. The configuration of the evaluation task.

.google.cloud.dialogflow.v2.GeneratorEvaluationConfig generator_evaluation_config = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GeneratorEvaluationConfig

The generatorEvaluationConfig.

getGeneratorEvaluationConfigOrBuilder()

public GeneratorEvaluationConfigOrBuilder getGeneratorEvaluationConfigOrBuilder()

Required. The configuration of the evaluation task.

.google.cloud.dialogflow.v2.GeneratorEvaluationConfig generator_evaluation_config = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GeneratorEvaluationConfigOrBuilder

getInitialGenerator()

public Generator getInitialGenerator()

Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation.

.google.cloud.dialogflow.v2.Generator initial_generator = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Generator

The initialGenerator.

getInitialGeneratorOrBuilder()

public GeneratorOrBuilder getInitialGeneratorOrBuilder()

Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation.

.google.cloud.dialogflow.v2.Generator initial_generator = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
GeneratorOrBuilder

getMetricsCase()

public GeneratorEvaluation.MetricsCase getMetricsCase()
Returns
Type Description
GeneratorEvaluation.MetricsCase

getName()

public String getName()

Output only. Identifier. The resource name of the evaluation. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>/ evaluations/<Evaluation ID>

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Identifier. The resource name of the evaluation. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>/ evaluations/<Evaluation ID>

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<GeneratorEvaluation> getParserForType()
Returns
Type Description
Parser<GeneratorEvaluation>
Overrides

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status

optional bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status

optional bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSummarizationMetrics()

public SummarizationEvaluationMetrics getSummarizationMetrics()

Output only. Only available when the summarization generator is provided.

.google.cloud.dialogflow.v2.SummarizationEvaluationMetrics summarization_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SummarizationEvaluationMetrics

The summarizationMetrics.

getSummarizationMetricsOrBuilder()

public SummarizationEvaluationMetricsOrBuilder getSummarizationMetricsOrBuilder()

Output only. Only available when the summarization generator is provided.

.google.cloud.dialogflow.v2.SummarizationEvaluationMetrics summarization_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SummarizationEvaluationMetricsOrBuilder

hasCompleteTime()

public boolean hasCompleteTime()

Output only. Completion time of this generator evaluation.

.google.protobuf.Timestamp complete_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the completeTime field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Creation time of this generator evaluation.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasEvaluationStatus()

public boolean hasEvaluationStatus()

Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message.

.google.cloud.dialogflow.v2.EvaluationStatus evaluation_status = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the evaluationStatus field is set.

hasGeneratorEvaluationConfig()

public boolean hasGeneratorEvaluationConfig()

Required. The configuration of the evaluation task.

.google.cloud.dialogflow.v2.GeneratorEvaluationConfig generator_evaluation_config = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the generatorEvaluationConfig field is set.

hasInitialGenerator()

public boolean hasInitialGenerator()

Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation.

.google.cloud.dialogflow.v2.Generator initial_generator = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the initialGenerator field is set.

hasSatisfiesPzi()

public boolean hasSatisfiesPzi()

Output only. A read only boolean field reflecting Zone Isolation status of the model. The field is an aggregated value of ZI status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status

optional bool satisfies_pzi = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

public boolean hasSatisfiesPzs()

Output only. A read only boolean field reflecting Zone Separation status of the model. The field is an aggregated value of ZS status of its underlying dependencies. See more details in go/zicy-resource-placement#resource-status

optional bool satisfies_pzs = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

hasSummarizationMetrics()

public boolean hasSummarizationMetrics()

Output only. Only available when the summarization generator is provided.

.google.cloud.dialogflow.v2.SummarizationEvaluationMetrics summarization_metrics = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the summarizationMetrics field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GeneratorEvaluation.Builder newBuilderForType()
Returns
Type Description
GeneratorEvaluation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GeneratorEvaluation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GeneratorEvaluation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GeneratorEvaluation.Builder toBuilder()
Returns
Type Description
GeneratorEvaluation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException