GoogleCloudMlV1Version (AI Platform Training & Prediction API v1-rev20210212-1.31.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.ml.v1.model.GoogleCloudMlV1Version

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudMlV1Version
extends GenericJson
```
Represents a version of the model. Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions. You can get information about all of the versions of a given model by calling projects.models.versions.list.
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 AI Platform Training & Prediction 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
  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

GoogleCloudMlV1Version()

Constructors
Constructor and Description
`GoogleCloudMlV1Version()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudMlV1Version`	`clone()`
`byte[]`	`decodeEtag()` `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other.
`GoogleCloudMlV1Version`	`encodeEtag(byte[] etag)` `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other.
`GoogleCloudMlV1AcceleratorConfig`	`getAcceleratorConfig()` Optional.
`GoogleCloudMlV1AutoScaling`	`getAutoScaling()` Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic.
`GoogleCloudMlV1ContainerSpec`	`getContainer()` Optional.
`String`	`getCreateTime()` Output only.
`String`	`getDeploymentUri()` The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version.
`String`	`getDescription()` Optional.
`String`	`getErrorMessage()` Output only.
`String`	`getEtag()` `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other.
`GoogleCloudMlV1ExplanationConfig`	`getExplanationConfig()` Optional.
`String`	`getFramework()` Optional.
`Boolean`	`getIsDefault()` Output only.
`Map<String,String>`	`getLabels()` Optional.
`String`	`getLastMigrationModelId()` Output only.
`String`	`getLastMigrationTime()` Output only.
`String`	`getLastUseTime()` Output only.
`String`	`getMachineType()` Optional.
`GoogleCloudMlV1ManualScaling`	`getManualScaling()` Manually select the number of nodes to use for serving the model.
`String`	`getName()` Required.
`List<String>`	`getPackageUris()` Optional.
`String`	`getPredictionClass()` Optional.
`String`	`getPythonVersion()` Required.
`GoogleCloudMlV1RequestLoggingConfig`	`getRequestLoggingConfig()` Optional.
`GoogleCloudMlV1RouteMap`	`getRoutes()` Optional.
`String`	`getRuntimeVersion()` Required.
`String`	`getServiceAccount()` Optional.
`String`	`getState()` Output only.
`GoogleCloudMlV1Version`	`set(String fieldName, Object value)`
`GoogleCloudMlV1Version`	`setAcceleratorConfig(GoogleCloudMlV1AcceleratorConfig acceleratorConfig)` Optional.
`GoogleCloudMlV1Version`	`setAutoScaling(GoogleCloudMlV1AutoScaling autoScaling)` Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic.
`GoogleCloudMlV1Version`	`setContainer(GoogleCloudMlV1ContainerSpec container)` Optional.
`GoogleCloudMlV1Version`	`setCreateTime(String createTime)` Output only.
`GoogleCloudMlV1Version`	`setDeploymentUri(String deploymentUri)` The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version.
`GoogleCloudMlV1Version`	`setDescription(String description)` Optional.
`GoogleCloudMlV1Version`	`setErrorMessage(String errorMessage)` Output only.
`GoogleCloudMlV1Version`	`setEtag(String etag)` `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other.
`GoogleCloudMlV1Version`	`setExplanationConfig(GoogleCloudMlV1ExplanationConfig explanationConfig)` Optional.
`GoogleCloudMlV1Version`	`setFramework(String framework)` Optional.
`GoogleCloudMlV1Version`	`setIsDefault(Boolean isDefault)` Output only.
`GoogleCloudMlV1Version`	`setLabels(Map<String,String> labels)` Optional.
`GoogleCloudMlV1Version`	`setLastMigrationModelId(String lastMigrationModelId)` Output only.
`GoogleCloudMlV1Version`	`setLastMigrationTime(String lastMigrationTime)` Output only.
`GoogleCloudMlV1Version`	`setLastUseTime(String lastUseTime)` Output only.
`GoogleCloudMlV1Version`	`setMachineType(String machineType)` Optional.
`GoogleCloudMlV1Version`	`setManualScaling(GoogleCloudMlV1ManualScaling manualScaling)` Manually select the number of nodes to use for serving the model.
`GoogleCloudMlV1Version`	`setName(String name)` Required.
`GoogleCloudMlV1Version`	`setPackageUris(List<String> packageUris)` Optional.
`GoogleCloudMlV1Version`	`setPredictionClass(String predictionClass)` Optional.
`GoogleCloudMlV1Version`	`setPythonVersion(String pythonVersion)` Required.
`GoogleCloudMlV1Version`	`setRequestLoggingConfig(GoogleCloudMlV1RequestLoggingConfig requestLoggingConfig)` Optional.
`GoogleCloudMlV1Version`	`setRoutes(GoogleCloudMlV1RouteMap routes)` Optional.
`GoogleCloudMlV1Version`	`setRuntimeVersion(String runtimeVersion)` Required.
`GoogleCloudMlV1Version`	`setServiceAccount(String serviceAccount)` Optional.
`GoogleCloudMlV1Version`	`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
  - GoogleCloudMlV1Version
```
public GoogleCloudMlV1Version()
```
- Method Detail
  - getAcceleratorConfig
```
public GoogleCloudMlV1AcceleratorConfig getAcceleratorConfig()
```
    Optional. Accelerator config for using GPUs for online prediction (beta). Only specify this field if you have specified a Compute Engine (N1) machine type in the `machineType` field. Learn more about [using GPUs for online prediction](/ml-engine/docs/machine-types-online- prediction#gpus).
    
    Returns:
    
    value or null for none
  - setAcceleratorConfig
```
public GoogleCloudMlV1Version setAcceleratorConfig(GoogleCloudMlV1AcceleratorConfig acceleratorConfig)
```
    Optional. Accelerator config for using GPUs for online prediction (beta). Only specify this field if you have specified a Compute Engine (N1) machine type in the `machineType` field. Learn more about [using GPUs for online prediction](/ml-engine/docs/machine-types-online- prediction#gpus).
    
    Parameters:
    
    acceleratorConfig - acceleratorConfig or null for none
  - getAutoScaling
```
public GoogleCloudMlV1AutoScaling getAutoScaling()
```
    Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes.
    
    Returns:
    
    value or null for none
  - setAutoScaling
```
public GoogleCloudMlV1Version setAutoScaling(GoogleCloudMlV1AutoScaling autoScaling)
```
    Automatically scale the number of nodes used to serve the model in response to increases and decreases in traffic. Care should be taken to ramp up traffic according to the model's ability to scale or you will start seeing increases in latency and 429 response codes.
    
    Parameters:
    
    autoScaling - autoScaling or null for none
  - getContainer
```
public GoogleCloudMlV1ContainerSpec getContainer()
```
    Optional. Specifies a custom container to use for serving predictions. If you specify this field, then `machineType` is required. If you specify this field, then `deploymentUri` is optional. If you specify this field, then you must not specify `runtimeVersion`, `packageUris`, `framework`, `pythonVersion`, or `predictionClass`.
    
    Returns:
    
    value or null for none
  - setContainer
```
public GoogleCloudMlV1Version setContainer(GoogleCloudMlV1ContainerSpec container)
```
    Optional. Specifies a custom container to use for serving predictions. If you specify this field, then `machineType` is required. If you specify this field, then `deploymentUri` is optional. If you specify this field, then you must not specify `runtimeVersion`, `packageUris`, `framework`, `pythonVersion`, or `predictionClass`.
    
    Parameters:
    
    container - container or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The time the version was created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public GoogleCloudMlV1Version setCreateTime(String createTime)
```
    Output only. The time the version was created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDeploymentUri
```
public String getDeploymentUri()
```
    The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the [guide to deploying models](/ai-platform/prediction/docs/deploying- models) for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn [how to use this field with a custom container](/ai-platform/prediction/docs/custom-container-requirements#artifacts).
    
    Returns:
    
    value or null for none
  - setDeploymentUri
```
public GoogleCloudMlV1Version setDeploymentUri(String deploymentUri)
```
    The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the [guide to deploying models](/ai-platform/prediction/docs/deploying- models) for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn [how to use this field with a custom container](/ai-platform/prediction/docs/custom-container-requirements#artifacts).
    
    Parameters:
    
    deploymentUri - deploymentUri or null for none
  - getDescription
```
public String getDescription()
```
    Optional. The description specified for the version when it was created.
    
    Returns:
    
    value or null for none
  - setDescription
```
public GoogleCloudMlV1Version setDescription(String description)
```
    Optional. The description specified for the version when it was created.
    
    Parameters:
    
    description - description or null for none
  - getErrorMessage
```
public String getErrorMessage()
```
    Output only. The details of a failure or a cancellation.
    
    Returns:
    
    value or null for none
  - setErrorMessage
```
public GoogleCloudMlV1Version setErrorMessage(String errorMessage)
```
    Output only. The details of a failure or a cancellation.
    
    Parameters:
    
    errorMessage - errorMessage or null for none
  - getEtag
```
public String getEtag()
```
    `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetVersion`, and systems are expected to put that etag in the request to `UpdateVersion` to ensure that their change will be applied to the model as intended.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeEtag()
  - decodeEtag
```
public byte[] decodeEtag()
```
    `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetVersion`, and systems are expected to put that etag in the request to `UpdateVersion` to ensure that their change will be applied to the model as intended.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getEtag()
  - setEtag
```
public GoogleCloudMlV1Version setEtag(String etag)
```
    `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetVersion`, and systems are expected to put that etag in the request to `UpdateVersion` to ensure that their change will be applied to the model as intended.
    
    Parameters:
    
    etag - etag or null for none
    
    See Also:
    
    #encodeEtag()
  - encodeEtag
```
public GoogleCloudMlV1Version encodeEtag(byte[] etag)
```
    `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetVersion`, and systems are expected to put that etag in the request to `UpdateVersion` to ensure that their change will be applied to the model as intended.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getExplanationConfig
```
public GoogleCloudMlV1ExplanationConfig getExplanationConfig()
```
    Optional. Configures explainability features on the model's version. Some explanation features require additional metadata to be loaded as part of the model payload.
    
    Returns:
    
    value or null for none
  - setExplanationConfig
```
public GoogleCloudMlV1Version setExplanationConfig(GoogleCloudMlV1ExplanationConfig explanationConfig)
```
    Optional. Configures explainability features on the model's version. Some explanation features require additional metadata to be loaded as part of the model payload.
    
    Parameters:
    
    explanationConfig - explanationConfig or null for none
  - getFramework
```
public String getFramework()
```
    Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. Do **not** specify a framework if you're deploying a [custom prediction routine](/ai- platform/prediction/docs/custom-prediction-routines) or if you're using a [custom container ](/ai-platform/prediction/docs/use-custom-container).
    
    Returns:
    
    value or null for none
  - setFramework
```
public GoogleCloudMlV1Version setFramework(String framework)
```
    Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. Do **not** specify a framework if you're deploying a [custom prediction routine](/ai- platform/prediction/docs/custom-prediction-routines) or if you're using a [custom container ](/ai-platform/prediction/docs/use-custom-container).
    
    Parameters:
    
    framework - framework or null for none
  - getIsDefault
```
public Boolean getIsDefault()
```
    Output only. If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault.
    
    Returns:
    
    value or null for none
  - setIsDefault
```
public GoogleCloudMlV1Version setIsDefault(Boolean isDefault)
```
    Output only. If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault.
    
    Parameters:
    
    isDefault - isDefault or null for none
  - getLabels
```
public Map<String,String> getLabels()
```
    Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels.
    
    Returns:
    
    value or null for none
  - setLabels
```
public GoogleCloudMlV1Version setLabels(Map<String,String> labels)
```
    Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels.
    
    Parameters:
    
    labels - labels or null for none
  - getLastMigrationModelId
```
public String getLastMigrationModelId()
```
    Output only. The [AI Platform (Unified) `Model`](https://cloud.google.com/ai-platform- unified/docs/reference/rest/v1beta1/projects.locations.models) ID for the last [model migration](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform- unified).
    
    Returns:
    
    value or null for none
  - setLastMigrationModelId
```
public GoogleCloudMlV1Version setLastMigrationModelId(String lastMigrationModelId)
```
    Output only. The [AI Platform (Unified) `Model`](https://cloud.google.com/ai-platform- unified/docs/reference/rest/v1beta1/projects.locations.models) ID for the last [model migration](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform- unified).
    
    Parameters:
    
    lastMigrationModelId - lastMigrationModelId or null for none
  - getLastMigrationTime
```
public String getLastMigrationTime()
```
    Output only. The last time this version was successfully [migrated to AI Platform (Unified)](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform- unified).
    
    Returns:
    
    value or null for none
  - setLastMigrationTime
```
public GoogleCloudMlV1Version setLastMigrationTime(String lastMigrationTime)
```
    Output only. The last time this version was successfully [migrated to AI Platform (Unified)](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform- unified).
    
    Parameters:
    
    lastMigrationTime - lastMigrationTime or null for none
  - getLastUseTime
```
public String getLastUseTime()
```
    Output only. The time the version was last used for prediction.
    
    Returns:
    
    value or null for none
  - setLastUseTime
```
public GoogleCloudMlV1Version setLastUseTime(String lastUseTime)
```
    Output only. The time the version was last used for prediction.
    
    Parameters:
    
    lastUseTime - lastUseTime or null for none
  - getMachineType
```
public String getMachineType()
```
    Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read [Choosing a machine type for online prediction](/ai-platform/prediction/docs/machine-types-online-prediction). If this field is not specified and you are using a [regional endpoint](/ai-platform/prediction/docs /regional-endpoints), then the machine type defaults to `n1-standard-2`. If this field is not specified and you are using the global endpoint (`ml.googleapis.com`), then the machine type defaults to `mls1-c1-m2`.
    
    Returns:
    
    value or null for none
  - setMachineType
```
public GoogleCloudMlV1Version setMachineType(String machineType)
```
    Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read [Choosing a machine type for online prediction](/ai-platform/prediction/docs/machine-types-online-prediction). If this field is not specified and you are using a [regional endpoint](/ai-platform/prediction/docs /regional-endpoints), then the machine type defaults to `n1-standard-2`. If this field is not specified and you are using the global endpoint (`ml.googleapis.com`), then the machine type defaults to `mls1-c1-m2`.
    
    Parameters:
    
    machineType - machineType or null for none
  - getManualScaling
```
public GoogleCloudMlV1ManualScaling getManualScaling()
```
    Manually select the number of nodes to use for serving the model. You should generally use `auto_scaling` with an appropriate `min_nodes` instead, but this option is available if you want more predictable billing. Beware that latency and error rates will increase if the traffic exceeds that capability of the system to serve it based on the selected number of nodes.
    
    Returns:
    
    value or null for none
  - setManualScaling
```
public GoogleCloudMlV1Version setManualScaling(GoogleCloudMlV1ManualScaling manualScaling)
```
    Manually select the number of nodes to use for serving the model. You should generally use `auto_scaling` with an appropriate `min_nodes` instead, but this option is available if you want more predictable billing. Beware that latency and error rates will increase if the traffic exceeds that capability of the system to serve it based on the selected number of nodes.
    
    Parameters:
    
    manualScaling - manualScaling or null for none
  - getName
```
public String getName()
```
    Required. The name specified for the version when it was created. The version name must be unique within the model it is created in.
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudMlV1Version setName(String name)
```
    Required. The name specified for the version when it was created. The version name must be unique within the model it is created in.
    
    Parameters:
    
    name - name or null for none
  - getPackageUris
```
public List<String> getPackageUris()
```
    Optional. Cloud Storage paths (`gs://…`) of packages for [custom prediction routines](/ml- engine/docs/tensorflow/custom-prediction-routines) or [scikit-learn pipelines with custom code ](/ml-engine/docs/scikit/exporting-for-prediction#custom-pipeline-code). For a custom prediction routine, one of these packages must contain your Predictor class (see [`predictionClass`](#Version.FIELDS.prediction_class)). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected [runtime version](/ml-engine/docs/tensorflow/runtime-version-list). If you specify this field, you must also set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater.
    
    Returns:
    
    value or null for none
  - setPackageUris
```
public GoogleCloudMlV1Version setPackageUris(List<String> packageUris)
```
    Optional. Cloud Storage paths (`gs://…`) of packages for [custom prediction routines](/ml- engine/docs/tensorflow/custom-prediction-routines) or [scikit-learn pipelines with custom code ](/ml-engine/docs/scikit/exporting-for-prediction#custom-pipeline-code). For a custom prediction routine, one of these packages must contain your Predictor class (see [`predictionClass`](#Version.FIELDS.prediction_class)). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected [runtime version](/ml-engine/docs/tensorflow/runtime-version-list). If you specify this field, you must also set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater.
    
    Parameters:
    
    packageUris - packageUris or null for none
  - getPredictionClass
```
public String getPredictionClass()
```
    Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml- engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online- prediction). The following code sample provides the Predictor interface: class Predictor(object): Interface for constructing custom predictors. def predict(self, instances, **kwargs): Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. raise NotImplementedError() @classmethod def from_path(cls, model_dir): Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom- prediction-routines).
    
    Returns:
    
    value or null for none
  - setPredictionClass
```
public GoogleCloudMlV1Version setPredictionClass(String predictionClass)
```
    Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml- engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online- prediction). The following code sample provides the Predictor interface: class Predictor(object): Interface for constructing custom predictors. def predict(self, instances, **kwargs): Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. raise NotImplementedError() @classmethod def from_path(cls, model_dir): Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom- prediction-routines).
    
    Parameters:
    
    predictionClass - predictionClass or null for none
  - getPythonVersion
```
public String getPythonVersion()
```
    Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list).
    
    Returns:
    
    value or null for none
  - setPythonVersion
```
public GoogleCloudMlV1Version setPythonVersion(String pythonVersion)
```
    Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list).
    
    Parameters:
    
    pythonVersion - pythonVersion or null for none
  - getRequestLoggingConfig
```
public GoogleCloudMlV1RequestLoggingConfig getRequestLoggingConfig()
```
    Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version.
    
    Returns:
    
    value or null for none
  - setRequestLoggingConfig
```
public GoogleCloudMlV1Version setRequestLoggingConfig(GoogleCloudMlV1RequestLoggingConfig requestLoggingConfig)
```
    Optional. *Only* specify this field in a projects.models.versions.patch request. Specifying it in a projects.models.versions.create request has no effect. Configures the request-response pair logging on predictions from this Version.
    
    Parameters:
    
    requestLoggingConfig - requestLoggingConfig or null for none
  - getRoutes
```
public GoogleCloudMlV1RouteMap getRoutes()
```
    Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values.
    
    Returns:
    
    value or null for none
  - setRoutes
```
public GoogleCloudMlV1Version setRoutes(GoogleCloudMlV1RouteMap routes)
```
    Optional. Specifies paths on a custom container's HTTP server where AI Platform Prediction sends certain requests. If you specify this field, then you must also specify the `container` field. If you specify the `container` field and do not specify this field, it defaults to the following: ```json { "predict": "/v1/models/MODEL/versions/VERSION:predict", "health": "/v1/models/MODEL/versions/VERSION" } ``` See RouteMap for more details about these default values.
    
    Parameters:
    
    routes - routes or null for none
  - getRuntimeVersion
```
public String getRuntimeVersion()
```
    Required. The AI Platform runtime version to use for this deployment. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning).
    
    Returns:
    
    value or null for none
  - setRuntimeVersion
```
public GoogleCloudMlV1Version setRuntimeVersion(String runtimeVersion)
```
    Required. The AI Platform runtime version to use for this deployment. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning).
    
    Parameters:
    
    runtimeVersion - runtimeVersion or null for none
  - getServiceAccount
```
public String getServiceAccount()
```
    Optional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the `containerSpec` or the `predictionClass` field. Learn more about [using a custom service account](/ai-platform/prediction/docs/custom-service- account).
    
    Returns:
    
    value or null for none
  - setServiceAccount
```
public GoogleCloudMlV1Version setServiceAccount(String serviceAccount)
```
    Optional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the `containerSpec` or the `predictionClass` field. Learn more about [using a custom service account](/ai-platform/prediction/docs/custom-service- account).
    
    Parameters:
    
    serviceAccount - serviceAccount or null for none
  - getState
```
public String getState()
```
    Output only. The state of a version.
    
    Returns:
    
    value or null for none
  - setState
```
public GoogleCloudMlV1Version setState(String state)
```
    Output only. The state of a version.
    
    Parameters:
    
    state - state or null for none
  - set
```
public GoogleCloudMlV1Version set(String fieldName,
                                  Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public GoogleCloudMlV1Version clone()
```
    Overrides:
    
    clone in class GenericJson

Class GoogleCloudMlV1Version

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

GoogleCloudMlV1Version

Method Detail

getAcceleratorConfig

setAcceleratorConfig

getAutoScaling

setAutoScaling

getContainer

setContainer

getCreateTime

setCreateTime

getDeploymentUri

setDeploymentUri

getDescription

setDescription

getErrorMessage

setErrorMessage

getEtag

decodeEtag

setEtag

encodeEtag

getExplanationConfig

setExplanationConfig

getFramework

setFramework

getIsDefault

setIsDefault

getLabels

setLabels

getLastMigrationModelId

setLastMigrationModelId

getLastMigrationTime

setLastMigrationTime

getLastUseTime

setLastUseTime

getMachineType

setMachineType

getManualScaling

setManualScaling

getName

setName

getPackageUris

setPackageUris

getPredictionClass

setPredictionClass

getPythonVersion

setPythonVersion

getRequestLoggingConfig

setRequestLoggingConfig

getRoutes

setRoutes

getRuntimeVersion

setRuntimeVersion

getServiceAccount

setServiceAccount

getState

setState

set

clone