Model (BigQuery API v2-rev20251012-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.bigquery.model.Model

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Model
extends com.google.api.client.json.GenericJson
```
Model definition for 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 BigQuery 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

Model()

Constructors
Constructor and Description
`Model()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Model`	`clone()`
`Long`	`getBestTrialId()` The best trial_id across all training runs.
`Long`	`getCreationTime()` Output only.
`Long`	`getDefaultTrialId()` Output only.
`String`	`getDescription()` Optional.
`EncryptionConfiguration`	`getEncryptionConfiguration()` Custom encryption configuration (e.g., Cloud KMS keys).
`String`	`getEtag()` Output only.
`Long`	`getExpirationTime()` Optional.
`List<StandardSqlField>`	`getFeatureColumns()` Output only.
`String`	`getFriendlyName()` Optional.
`HparamSearchSpaces`	`getHparamSearchSpaces()` Output only.
`List<HparamTuningTrial>`	`getHparamTrials()` Output only.
`List<StandardSqlField>`	`getLabelColumns()` Output only.
`Map<String,String>`	`getLabels()` The labels associated with this model.
`Long`	`getLastModifiedTime()` Output only.
`String`	`getLocation()` Output only.
`ModelReference`	`getModelReference()` Required.
`String`	`getModelType()` Output only.
`List<Long>`	`getOptimalTrialIds()` Output only.
`RemoteModelInfo`	`getRemoteModelInfo()` Output only.
`List<TrainingRun>`	`getTrainingRuns()` Information for all training runs in increasing order of start_time.
`List<TransformColumn>`	`getTransformColumns()` Output only.
`Model`	`set(String fieldName, Object value)`
`Model`	`setBestTrialId(Long bestTrialId)` The best trial_id across all training runs.
`Model`	`setCreationTime(Long creationTime)` Output only.
`Model`	`setDefaultTrialId(Long defaultTrialId)` Output only.
`Model`	`setDescription(String description)` Optional.
`Model`	`setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)` Custom encryption configuration (e.g., Cloud KMS keys).
`Model`	`setEtag(String etag)` Output only.
`Model`	`setExpirationTime(Long expirationTime)` Optional.
`Model`	`setFeatureColumns(List<StandardSqlField> featureColumns)` Output only.
`Model`	`setFriendlyName(String friendlyName)` Optional.
`Model`	`setHparamSearchSpaces(HparamSearchSpaces hparamSearchSpaces)` Output only.
`Model`	`setHparamTrials(List<HparamTuningTrial> hparamTrials)` Output only.
`Model`	`setLabelColumns(List<StandardSqlField> labelColumns)` Output only.
`Model`	`setLabels(Map<String,String> labels)` The labels associated with this model.
`Model`	`setLastModifiedTime(Long lastModifiedTime)` Output only.
`Model`	`setLocation(String location)` Output only.
`Model`	`setModelReference(ModelReference modelReference)` Required.
`Model`	`setModelType(String modelType)` Output only.
`Model`	`setOptimalTrialIds(List<Long> optimalTrialIds)` Output only.
`Model`	`setRemoteModelInfo(RemoteModelInfo remoteModelInfo)` Output only.
`Model`	`setTrainingRuns(List<TrainingRun> trainingRuns)` Information for all training runs in increasing order of start_time.
`Model`	`setTransformColumns(List<TransformColumn> transformColumns)` 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
  - Model
```
public Model()
```
- Method Detail
  - getBestTrialId
```
public Long getBestTrialId()
```
    The best trial_id across all training runs.
    
    Returns:
    
    value or null for none
  - setBestTrialId
```
public Model setBestTrialId(Long bestTrialId)
```
    The best trial_id across all training runs.
    
    Parameters:
    
    bestTrialId - bestTrialId or null for none
  - getCreationTime
```
public Long getCreationTime()
```
    Output only. The time when this model was created, in millisecs since the epoch.
    
    Returns:
    
    value or null for none
  - setCreationTime
```
public Model setCreationTime(Long creationTime)
```
    Output only. The time when this model was created, in millisecs since the epoch.
    
    Parameters:
    
    creationTime - creationTime or null for none
  - getDefaultTrialId
```
public Long getDefaultTrialId()
```
    Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery- ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the best trial ID. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery- ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the smallest trial ID among all Pareto optimal trials.
    
    Returns:
    
    value or null for none
  - setDefaultTrialId
```
public Model setDefaultTrialId(Long defaultTrialId)
```
    Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery- ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the best trial ID. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery- ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the smallest trial ID among all Pareto optimal trials.
    
    Parameters:
    
    defaultTrialId - defaultTrialId or null for none
  - getDescription
```
public String getDescription()
```
    Optional. A user-friendly description of this model.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Model setDescription(String description)
```
    Optional. A user-friendly description of this model.
    
    Parameters:
    
    description - description or null for none
  - getEncryptionConfiguration
```
public EncryptionConfiguration getEncryptionConfiguration()
```
    Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model.
    
    Returns:
    
    value or null for none
  - setEncryptionConfiguration
```
public Model setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
```
    Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model.
    
    Parameters:
    
    encryptionConfiguration - encryptionConfiguration or null for none
  - getEtag
```
public String getEtag()
```
    Output only. A hash of this resource.
    
    Returns:
    
    value or null for none
  - setEtag
```
public Model setEtag(String etag)
```
    Output only. A hash of this resource.
    
    Parameters:
    
    etag - etag or null for none
  - getExpirationTime
```
public Long getExpirationTime()
```
    Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.
    
    Returns:
    
    value or null for none
  - setExpirationTime
```
public Model setExpirationTime(Long expirationTime)
```
    Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.
    
    Parameters:
    
    expirationTime - expirationTime or null for none
  - getFeatureColumns
```
public List<StandardSqlField> getFeatureColumns()
```
    Output only. Input feature columns for the model inference. If the model is trained with TRANSFORM clause, these are the input of the TRANSFORM clause.
    
    Returns:
    
    value or null for none
  - setFeatureColumns
```
public Model setFeatureColumns(List<StandardSqlField> featureColumns)
```
    Output only. Input feature columns for the model inference. If the model is trained with TRANSFORM clause, these are the input of the TRANSFORM clause.
    
    Parameters:
    
    featureColumns - featureColumns or null for none
  - getFriendlyName
```
public String getFriendlyName()
```
    Optional. A descriptive name for this model.
    
    Returns:
    
    value or null for none
  - setFriendlyName
```
public Model setFriendlyName(String friendlyName)
```
    Optional. A descriptive name for this model.
    
    Parameters:
    
    friendlyName - friendlyName or null for none
  - getHparamSearchSpaces
```
public HparamSearchSpaces getHparamSearchSpaces()
```
    Output only. All hyperparameter search spaces in this model.
    
    Returns:
    
    value or null for none
  - setHparamSearchSpaces
```
public Model setHparamSearchSpaces(HparamSearchSpaces hparamSearchSpaces)
```
    Output only. All hyperparameter search spaces in this model.
    
    Parameters:
    
    hparamSearchSpaces - hparamSearchSpaces or null for none
  - getHparamTrials
```
public List<HparamTuningTrial> getHparamTrials()
```
    Output only. Trials of a [hyperparameter tuning](https://cloud.google.com/bigquery- ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id.
    
    Returns:
    
    value or null for none
  - setHparamTrials
```
public Model setHparamTrials(List<HparamTuningTrial> hparamTrials)
```
    Output only. Trials of a [hyperparameter tuning](https://cloud.google.com/bigquery- ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id.
    
    Parameters:
    
    hparamTrials - hparamTrials or null for none
  - getLabelColumns
```
public List<StandardSqlField> getLabelColumns()
```
    Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.
    
    Returns:
    
    value or null for none
  - setLabelColumns
```
public Model setLabelColumns(List<StandardSqlField> labelColumns)
```
    Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.
    
    Parameters:
    
    labelColumns - labelColumns or null for none
  - getLabels
```
public Map<String,String> getLabels()
```
    The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Model setLabels(Map<String,String> labels)
```
    The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
    
    Parameters:
    
    labels - labels or null for none
  - getLastModifiedTime
```
public Long getLastModifiedTime()
```
    Output only. The time when this model was last modified, in millisecs since the epoch.
    
    Returns:
    
    value or null for none
  - setLastModifiedTime
```
public Model setLastModifiedTime(Long lastModifiedTime)
```
    Output only. The time when this model was last modified, in millisecs since the epoch.
    
    Parameters:
    
    lastModifiedTime - lastModifiedTime or null for none
  - getLocation
```
public String getLocation()
```
    Output only. The geographic location where the model resides. This value is inherited from the dataset.
    
    Returns:
    
    value or null for none
  - setLocation
```
public Model setLocation(String location)
```
    Output only. The geographic location where the model resides. This value is inherited from the dataset.
    
    Parameters:
    
    location - location or null for none
  - getModelReference
```
public ModelReference getModelReference()
```
    Required. Unique identifier for this model.
    
    Returns:
    
    value or null for none
  - setModelReference
```
public Model setModelReference(ModelReference modelReference)
```
    Required. Unique identifier for this model.
    
    Parameters:
    
    modelReference - modelReference or null for none
  - getModelType
```
public String getModelType()
```
    Output only. Type of the model resource.
    
    Returns:
    
    value or null for none
  - setModelType
```
public Model setModelType(String modelType)
```
    Output only. Type of the model resource.
    
    Parameters:
    
    modelType - modelType or null for none
  - getOptimalTrialIds
```
public List<Long> getOptimalTrialIds()
```
    Output only. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery- ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it only contains the best trial. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery- ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it contains all Pareto optimal trials sorted by trial_id.
    
    Returns:
    
    value or null for none
  - setOptimalTrialIds
```
public Model setOptimalTrialIds(List<Long> optimalTrialIds)
```
    Output only. For single-objective [hyperparameter tuning](https://cloud.google.com/bigquery- ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it only contains the best trial. For multi-objective [hyperparameter tuning](https://cloud.google.com/bigquery- ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it contains all Pareto optimal trials sorted by trial_id.
    
    Parameters:
    
    optimalTrialIds - optimalTrialIds or null for none
  - getRemoteModelInfo
```
public RemoteModelInfo getRemoteModelInfo()
```
    Output only. Remote model info
    
    Returns:
    
    value or null for none
  - setRemoteModelInfo
```
public Model setRemoteModelInfo(RemoteModelInfo remoteModelInfo)
```
    Output only. Remote model info
    
    Parameters:
    
    remoteModelInfo - remoteModelInfo or null for none
  - getTrainingRuns
```
public List<TrainingRun> getTrainingRuns()
```
    Information for all training runs in increasing order of start_time.
    
    Returns:
    
    value or null for none
  - setTrainingRuns
```
public Model setTrainingRuns(List<TrainingRun> trainingRuns)
```
    Information for all training runs in increasing order of start_time.
    
    Parameters:
    
    trainingRuns - trainingRuns or null for none
  - getTransformColumns
```
public List<TransformColumn> getTransformColumns()
```
    Output only. This field will be populated if a TRANSFORM clause was used to train a model. TRANSFORM clause (if used) takes feature_columns as input and outputs transform_columns. transform_columns then are used to train the model.
    
    Returns:
    
    value or null for none
  - setTransformColumns
```
public Model setTransformColumns(List<TransformColumn> transformColumns)
```
    Output only. This field will be populated if a TRANSFORM clause was used to train a model. TRANSFORM clause (if used) takes feature_columns as input and outputs transform_columns. transform_columns then are used to train the model.
    
    Parameters:
    
    transformColumns - transformColumns or null for none
  - set
```
public Model set(String fieldName,
                 Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Model clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Model

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Model

Method Detail

getBestTrialId

setBestTrialId

getCreationTime

setCreationTime

getDefaultTrialId

setDefaultTrialId

getDescription

setDescription

getEncryptionConfiguration

setEncryptionConfiguration

getEtag

setEtag

getExpirationTime

setExpirationTime

getFeatureColumns

setFeatureColumns

getFriendlyName

setFriendlyName

getHparamSearchSpaces

setHparamSearchSpaces

getHparamTrials

setHparamTrials

getLabelColumns

setLabelColumns

getLabels

setLabels

getLastModifiedTime

setLastModifiedTime

getLocation

setLocation

getModelReference

setModelReference

getModelType

setModelType

getOptimalTrialIds

setOptimalTrialIds

getRemoteModelInfo

setRemoteModelInfo

getTrainingRuns

setTrainingRuns

getTransformColumns

setTransformColumns

set

clone