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

Class GoogleCloudDiscoveryengineV1CustomTuningModel

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.GoogleCloudDiscoveryengineV1CustomTuningModel

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Metadata that describes a custom tuned model.

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
GoogleCloudDiscoveryengineV1CustomTuningModel()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1CustomTuningModel	clone()
String	getCreateTime() Deprecated: Timestamp the Model was created at.
String	getDisplayName() The display name of the model.
String	getErrorMessage() Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.
Map<String,Double>	getMetrics() The metrics of the trained model.
String	getModelState() The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
Long	getModelVersion() The version of the model.
String	getName() Required.
String	getTrainingStartTime() Timestamp the model training was initiated.
GoogleCloudDiscoveryengineV1CustomTuningModel	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1CustomTuningModel	setCreateTime(String createTime) Deprecated: Timestamp the Model was created at.
GoogleCloudDiscoveryengineV1CustomTuningModel	setDisplayName(String displayName) The display name of the model.
GoogleCloudDiscoveryengineV1CustomTuningModel	setErrorMessage(String errorMessage) Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.
GoogleCloudDiscoveryengineV1CustomTuningModel	setMetrics(Map<String,Double> metrics) The metrics of the trained model.
GoogleCloudDiscoveryengineV1CustomTuningModel	setModelState(String modelState) The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
GoogleCloudDiscoveryengineV1CustomTuningModel	setModelVersion(Long modelVersion) The version of the model.
GoogleCloudDiscoveryengineV1CustomTuningModel	setName(String name) Required.
GoogleCloudDiscoveryengineV1CustomTuningModel	setTrainingStartTime(String trainingStartTime) Timestamp the model training was initiated.

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

GoogleCloudDiscoveryengineV1CustomTuningModel

public GoogleCloudDiscoveryengineV1CustomTuningModel()

Method Detail

getCreateTime

public String getCreateTime()

Deprecated: Timestamp the Model was created at.

Returns:

value or null for none

setCreateTime

public GoogleCloudDiscoveryengineV1CustomTuningModel setCreateTime(String createTime)

Deprecated: Timestamp the Model was created at.

Parameters:

createTime - createTime or null for none

getDisplayName

public String getDisplayName()

The display name of the model.

Returns:

value or null for none

setDisplayName

public GoogleCloudDiscoveryengineV1CustomTuningModel setDisplayName(String displayName)

The display name of the model.

Parameters:

displayName - displayName or null for none

getErrorMessage

public String getErrorMessage()

Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.

Returns:

value or null for none

setErrorMessage

public GoogleCloudDiscoveryengineV1CustomTuningModel setErrorMessage(String errorMessage)

Currently this is only populated if the model state is `INPUT_VALIDATION_FAILED`.

Parameters:

errorMessage - errorMessage or null for none

getMetrics

public Map<String,Double> getMetrics()

The metrics of the trained model.

Returns:

value or null for none

setMetrics

public GoogleCloudDiscoveryengineV1CustomTuningModel setMetrics(Map<String,Double> metrics)

The metrics of the trained model.

Parameters:

metrics - metrics or null for none

getModelState

public String getModelState()

The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).

Returns:

value or null for none

setModelState

public GoogleCloudDiscoveryengineV1CustomTuningModel setModelState(String modelState)

The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).

Parameters:

modelState - modelState or null for none

getModelVersion

public Long getModelVersion()

The version of the model.

Returns:

value or null for none

setModelVersion

public GoogleCloudDiscoveryengineV1CustomTuningModel setModelVersion(Long modelVersion)

The version of the model.

Parameters:

modelVersion - modelVersion or null for none

getName

public String getName()

Required. The fully qualified resource name of the model. Format: `projects/{project}/locations /{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_ model}`. Model must be an alpha-numerical string with limit of 40 characters.

Returns:

value or null for none

setName

public GoogleCloudDiscoveryengineV1CustomTuningModel setName(String name)

Required. The fully qualified resource name of the model. Format: `projects/{project}/locations /{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_ model}`. Model must be an alpha-numerical string with limit of 40 characters.

Parameters:

name - name or null for none

getTrainingStartTime

public String getTrainingStartTime()

Timestamp the model training was initiated.

Returns:

value or null for none

setTrainingStartTime

public GoogleCloudDiscoveryengineV1CustomTuningModel setTrainingStartTime(String trainingStartTime)

Timestamp the model training was initiated.

Parameters:

trainingStartTime - trainingStartTime or null for none

set

public GoogleCloudDiscoveryengineV1CustomTuningModel set(String fieldName,
                                                         Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1CustomTuningModel clone()

Overrides:

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