Model (BigQuery API v2 (Rev. 459) 1.25.0)

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.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()`
`java.lang.Long`	`getCreationTime()` Output only.
`java.lang.String`	`getDescription()` Optional.
`EncryptionConfiguration`	`getEncryptionConfiguration()` Custom encryption configuration (e.g., Cloud KMS keys).
`java.lang.String`	`getEtag()` Output only.
`java.lang.Long`	`getExpirationTime()` Optional.
`java.util.List<StandardSqlField>`	`getFeatureColumns()` Output only.
`java.lang.String`	`getFriendlyName()` Optional.
`java.util.List<StandardSqlField>`	`getLabelColumns()` Output only.
`java.util.Map<java.lang.String,java.lang.String>`	`getLabels()` The labels associated with this model.
`java.lang.Long`	`getLastModifiedTime()` Output only.
`java.lang.String`	`getLocation()` Output only.
`ModelReference`	`getModelReference()` Required.
`java.lang.String`	`getModelType()` Output only.
`java.util.List<TrainingRun>`	`getTrainingRuns()` Output only.
`Model`	`set(java.lang.String fieldName, java.lang.Object value)`
`Model`	`setCreationTime(java.lang.Long creationTime)` Output only.
`Model`	`setDescription(java.lang.String description)` Optional.
`Model`	`setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)` Custom encryption configuration (e.g., Cloud KMS keys).
`Model`	`setEtag(java.lang.String etag)` Output only.
`Model`	`setExpirationTime(java.lang.Long expirationTime)` Optional.
`Model`	`setFeatureColumns(java.util.List<StandardSqlField> featureColumns)` Output only.
`Model`	`setFriendlyName(java.lang.String friendlyName)` Optional.
`Model`	`setLabelColumns(java.util.List<StandardSqlField> labelColumns)` Output only.
`Model`	`setLabels(java.util.Map<java.lang.String,java.lang.String> labels)` The labels associated with this model.
`Model`	`setLastModifiedTime(java.lang.Long lastModifiedTime)` Output only.
`Model`	`setLocation(java.lang.String location)` Output only.
`Model`	`setModelReference(ModelReference modelReference)` Required.
`Model`	`setModelType(java.lang.String modelType)` Output only.
`Model`	`setTrainingRuns(java.util.List<TrainingRun> trainingRuns)` 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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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
  - getCreationTime
```
public java.lang.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(java.lang.Long creationTime)
```
    Output only. The time when this model was created, in millisecs since the epoch.
    
    Parameters:
    
    creationTime - creationTime or null for none
  - getDescription
```
public java.lang.String getDescription()
```
    Optional. A user-friendly description of this model.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Model setDescription(java.lang.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 java.lang.String getEtag()
```
    Output only. A hash of this resource.
    
    Returns:
    
    value or null for none
  - setEtag
```
public Model setEtag(java.lang.String etag)
```
    Output only. A hash of this resource.
    
    Parameters:
    
    etag - etag or null for none
  - getExpirationTime
```
public java.lang.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(java.lang.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 java.util.List<StandardSqlField> getFeatureColumns()
```
    Output only. Input feature columns that were used to train this model.
    
    Returns:
    
    value or null for none
  - setFeatureColumns
```
public Model setFeatureColumns(java.util.List<StandardSqlField> featureColumns)
```
    Output only. Input feature columns that were used to train this model.
    
    Parameters:
    
    featureColumns - featureColumns or null for none
  - getFriendlyName
```
public java.lang.String getFriendlyName()
```
    Optional. A descriptive name for this model.
    
    Returns:
    
    value or null for none
  - setFriendlyName
```
public Model setFriendlyName(java.lang.String friendlyName)
```
    Optional. A descriptive name for this model.
    
    Parameters:
    
    friendlyName - friendlyName or null for none
  - getLabelColumns
```
public java.util.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(java.util.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 java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getModelType()
```
    Output only. Type of the model resource.
    
    Returns:
    
    value or null for none
  - setModelType
```
public Model setModelType(java.lang.String modelType)
```
    Output only. Type of the model resource.
    
    Parameters:
    
    modelType - modelType or null for none
  - getTrainingRuns
```
public java.util.List<TrainingRun> getTrainingRuns()
```
    Output only. Information for all training runs in increasing order of start_time.
    
    Returns:
    
    value or null for none
  - setTrainingRuns
```
public Model setTrainingRuns(java.util.List<TrainingRun> trainingRuns)
```
    Output only. Information for all training runs in increasing order of start_time.
    
    Parameters:
    
    trainingRuns - trainingRuns or null for none
  - set
```
public Model set(java.lang.String fieldName,
                 java.lang.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

BigQuery API v2 (revision 459)

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

getCreationTime

setCreationTime

getDescription

setDescription

getEncryptionConfiguration

setEncryptionConfiguration

getEtag

setEtag

getExpirationTime

setExpirationTime

getFeatureColumns

setFeatureColumns

getFriendlyName

setFriendlyName

getLabelColumns

setLabelColumns

getLabels

setLabels

getLastModifiedTime

setLastModifiedTime

getLocation

setLocation

getModelReference

setModelReference

getModelType

setModelType

getTrainingRuns

setTrainingRuns

set

clone