com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1alphaEvaluation

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1alphaEvaluation

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1alphaEvaluation
extends com.google.api.client.json.GenericJson

An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1alphaEvaluation()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1alphaEvaluation	clone()
String	getCreateTime() Output only.
String	getEndTime() Output only.
GoogleRpcStatus	getError() Output only.
List<GoogleRpcStatus>	getErrorSamples() Output only.
GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec	getEvaluationSpec() Required.
String	getName() Identifier.
GoogleCloudDiscoveryengineV1alphaQualityMetrics	getQualityMetrics() Output only.
String	getState() Output only.
GoogleCloudDiscoveryengineV1alphaEvaluation	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1alphaEvaluation	setCreateTime(String createTime) Output only.
GoogleCloudDiscoveryengineV1alphaEvaluation	setEndTime(String endTime) Output only.
GoogleCloudDiscoveryengineV1alphaEvaluation	setError(GoogleRpcStatus error) Output only.
GoogleCloudDiscoveryengineV1alphaEvaluation	setErrorSamples(List<GoogleRpcStatus> errorSamples) Output only.
GoogleCloudDiscoveryengineV1alphaEvaluation	setEvaluationSpec(GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec evaluationSpec) Required.
GoogleCloudDiscoveryengineV1alphaEvaluation	setName(String name) Identifier.
GoogleCloudDiscoveryengineV1alphaEvaluation	setQualityMetrics(GoogleCloudDiscoveryengineV1alphaQualityMetrics qualityMetrics) Output only.
GoogleCloudDiscoveryengineV1alphaEvaluation	setState(String state) Output only.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1alphaEvaluation

public GoogleCloudDiscoveryengineV1alphaEvaluation()

Method Detail

getCreateTime

public String getCreateTime()

Output only. Timestamp the Evaluation was created at.

Returns:

value or null for none

setCreateTime

public GoogleCloudDiscoveryengineV1alphaEvaluation setCreateTime(String createTime)

Output only. Timestamp the Evaluation was created at.

Parameters:

createTime - createTime or null for none

getEndTime

public String getEndTime()

Output only. Timestamp the Evaluation was completed at.

Returns:

value or null for none

setEndTime

public GoogleCloudDiscoveryengineV1alphaEvaluation setEndTime(String endTime)

Output only. Timestamp the Evaluation was completed at.

Parameters:

endTime - endTime or null for none

getError

public GoogleRpcStatus getError()

Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.

Returns:

value or null for none

setError

public GoogleCloudDiscoveryengineV1alphaEvaluation setError(GoogleRpcStatus error)

Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.

Parameters:

error - error or null for none

getErrorSamples

public List<GoogleRpcStatus> getErrorSamples()

Output only. A sample of errors encountered while processing the request.

Returns:

value or null for none

setErrorSamples

public GoogleCloudDiscoveryengineV1alphaEvaluation setErrorSamples(List<GoogleRpcStatus> errorSamples)

Output only. A sample of errors encountered while processing the request.

Parameters:

errorSamples - errorSamples or null for none

getEvaluationSpec

public GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec getEvaluationSpec()

Required. The specification of the evaluation.

Returns:

value or null for none

setEvaluationSpec

public GoogleCloudDiscoveryengineV1alphaEvaluation setEvaluationSpec(GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec evaluationSpec)

Required. The specification of the evaluation.

Parameters:

evaluationSpec - evaluationSpec or null for none

getName

public String getName()

Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Returns:

value or null for none

setName

public GoogleCloudDiscoveryengineV1alphaEvaluation setName(String name)

Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Parameters:

name - name or null for none

getQualityMetrics

public GoogleCloudDiscoveryengineV1alphaQualityMetrics getQualityMetrics()

Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.

Returns:

value or null for none

setQualityMetrics

public GoogleCloudDiscoveryengineV1alphaEvaluation setQualityMetrics(GoogleCloudDiscoveryengineV1alphaQualityMetrics qualityMetrics)

Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.

Parameters:

qualityMetrics - qualityMetrics or null for none

getState

public String getState()

Output only. The state of the evaluation.

Returns:

value or null for none

setState

public GoogleCloudDiscoveryengineV1alphaEvaluation setState(String state)

Output only. The state of the evaluation.

Parameters:

state - state or null for none

set

public GoogleCloudDiscoveryengineV1alphaEvaluation set(String fieldName,
                                                       Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1alphaEvaluation clone()

Overrides:

clone in class com.google.api.client.json.GenericJson