GoogleCloudMlV1PredictionInput (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.GoogleCloudMlV1PredictionInput

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudMlV1PredictionInput
extends GenericJson
```
Represents input parameters for a prediction job.
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

GoogleCloudMlV1PredictionInput()

Constructors
Constructor and Description
`GoogleCloudMlV1PredictionInput()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudMlV1PredictionInput`	`clone()`
`Long`	`getBatchSize()` Optional.
`String`	`getDataFormat()` Required.
`List<String>`	`getInputPaths()` Required.
`Long`	`getMaxWorkerCount()` Optional.
`String`	`getModelName()` Use this field if you want to use the default version for the specified model.
`String`	`getOutputDataFormat()` Optional.
`String`	`getOutputPath()` Required.
`String`	`getRegion()` Required.
`String`	`getRuntimeVersion()` Optional.
`String`	`getSignatureName()` Optional.
`String`	`getUri()` Use this field if you want to specify a Google Cloud Storage path for the model to use.
`String`	`getVersionName()` Use this field if you want to specify a version of the model to use.
`GoogleCloudMlV1PredictionInput`	`set(String fieldName, Object value)`
`GoogleCloudMlV1PredictionInput`	`setBatchSize(Long batchSize)` Optional.
`GoogleCloudMlV1PredictionInput`	`setDataFormat(String dataFormat)` Required.
`GoogleCloudMlV1PredictionInput`	`setInputPaths(List<String> inputPaths)` Required.
`GoogleCloudMlV1PredictionInput`	`setMaxWorkerCount(Long maxWorkerCount)` Optional.
`GoogleCloudMlV1PredictionInput`	`setModelName(String modelName)` Use this field if you want to use the default version for the specified model.
`GoogleCloudMlV1PredictionInput`	`setOutputDataFormat(String outputDataFormat)` Optional.
`GoogleCloudMlV1PredictionInput`	`setOutputPath(String outputPath)` Required.
`GoogleCloudMlV1PredictionInput`	`setRegion(String region)` Required.
`GoogleCloudMlV1PredictionInput`	`setRuntimeVersion(String runtimeVersion)` Optional.
`GoogleCloudMlV1PredictionInput`	`setSignatureName(String signatureName)` Optional.
`GoogleCloudMlV1PredictionInput`	`setUri(String uri)` Use this field if you want to specify a Google Cloud Storage path for the model to use.
`GoogleCloudMlV1PredictionInput`	`setVersionName(String versionName)` Use this field if you want to specify a version of the model to use.

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
  - GoogleCloudMlV1PredictionInput
```
public GoogleCloudMlV1PredictionInput()
```
- Method Detail
  - getBatchSize
```
public Long getBatchSize()
```
    Optional. Number of records per batch, defaults to 64. The service will buffer batch_size number of records in memory before invoking one Tensorflow prediction call internally. So take the record size and memory available into consideration when setting this parameter.
    
    Returns:
    
    value or null for none
  - setBatchSize
```
public GoogleCloudMlV1PredictionInput setBatchSize(Long batchSize)
```
    Optional. Number of records per batch, defaults to 64. The service will buffer batch_size number of records in memory before invoking one Tensorflow prediction call internally. So take the record size and memory available into consideration when setting this parameter.
    
    Parameters:
    
    batchSize - batchSize or null for none
  - getDataFormat
```
public String getDataFormat()
```
    Required. The format of the input data files.
    
    Returns:
    
    value or null for none
  - setDataFormat
```
public GoogleCloudMlV1PredictionInput setDataFormat(String dataFormat)
```
    Required. The format of the input data files.
    
    Parameters:
    
    dataFormat - dataFormat or null for none
  - getInputPaths
```
public List<String> getInputPaths()
```
    Required. The Cloud Storage location of the input data files. May contain wildcards.
    
    Returns:
    
    value or null for none
  - setInputPaths
```
public GoogleCloudMlV1PredictionInput setInputPaths(List<String> inputPaths)
```
    Required. The Cloud Storage location of the input data files. May contain wildcards.
    
    Parameters:
    
    inputPaths - inputPaths or null for none
  - getMaxWorkerCount
```
public Long getMaxWorkerCount()
```
    Optional. The maximum number of workers to be used for parallel processing. Defaults to 10 if not specified.
    
    Returns:
    
    value or null for none
  - setMaxWorkerCount
```
public GoogleCloudMlV1PredictionInput setMaxWorkerCount(Long maxWorkerCount)
```
    Optional. The maximum number of workers to be used for parallel processing. Defaults to 10 if not specified.
    
    Parameters:
    
    maxWorkerCount - maxWorkerCount or null for none
  - getModelName
```
public String getModelName()
```
    Use this field if you want to use the default version for the specified model. The string must use the following format: `"projects/YOUR_PROJECT/models/YOUR_MODEL"`
    
    Returns:
    
    value or null for none
  - setModelName
```
public GoogleCloudMlV1PredictionInput setModelName(String modelName)
```
    Use this field if you want to use the default version for the specified model. The string must use the following format: `"projects/YOUR_PROJECT/models/YOUR_MODEL"`
    
    Parameters:
    
    modelName - modelName or null for none
  - getOutputDataFormat
```
public String getOutputDataFormat()
```
    Optional. Format of the output data files, defaults to JSON.
    
    Returns:
    
    value or null for none
  - setOutputDataFormat
```
public GoogleCloudMlV1PredictionInput setOutputDataFormat(String outputDataFormat)
```
    Optional. Format of the output data files, defaults to JSON.
    
    Parameters:
    
    outputDataFormat - outputDataFormat or null for none
  - getOutputPath
```
public String getOutputPath()
```
    Required. The output Google Cloud Storage location.
    
    Returns:
    
    value or null for none
  - setOutputPath
```
public GoogleCloudMlV1PredictionInput setOutputPath(String outputPath)
```
    Required. The output Google Cloud Storage location.
    
    Parameters:
    
    outputPath - outputPath or null for none
  - getRegion
```
public String getRegion()
```
    Required. The Google Compute Engine region to run the prediction job in. See the available regions for AI Platform services.
    
    Returns:
    
    value or null for none
  - setRegion
```
public GoogleCloudMlV1PredictionInput setRegion(String region)
```
    Required. The Google Compute Engine region to run the prediction job in. See the available regions for AI Platform services.
    
    Parameters:
    
    region - region or null for none
  - getRuntimeVersion
```
public String getRuntimeVersion()
```
    Optional. The AI Platform runtime version to use for this batch prediction. If not set, AI Platform will pick the runtime version used during the CreateVersion request for this model version, or choose the latest stable version when model version information is not available such as when the model is specified by uri.
    
    Returns:
    
    value or null for none
  - setRuntimeVersion
```
public GoogleCloudMlV1PredictionInput setRuntimeVersion(String runtimeVersion)
```
    Optional. The AI Platform runtime version to use for this batch prediction. If not set, AI Platform will pick the runtime version used during the CreateVersion request for this model version, or choose the latest stable version when model version information is not available such as when the model is specified by uri.
    
    Parameters:
    
    runtimeVersion - runtimeVersion or null for none
  - getSignatureName
```
public String getSignatureName()
```
    Optional. The name of the signature defined in the SavedModel to use for this job. Please refer to [SavedModel](https://tensorflow.github.io/serving/serving_basic.html) for information about how to use signatures. Defaults to [DEFAULT_SERVING_SIGNATURE_DEF_KEY](https://www.tensorflow.o rg/api_docs/python/tf/saved_model/signature_constants) , which is "serving_default".
    
    Returns:
    
    value or null for none
  - setSignatureName
```
public GoogleCloudMlV1PredictionInput setSignatureName(String signatureName)
```
    Optional. The name of the signature defined in the SavedModel to use for this job. Please refer to [SavedModel](https://tensorflow.github.io/serving/serving_basic.html) for information about how to use signatures. Defaults to [DEFAULT_SERVING_SIGNATURE_DEF_KEY](https://www.tensorflow.o rg/api_docs/python/tf/saved_model/signature_constants) , which is "serving_default".
    
    Parameters:
    
    signatureName - signatureName or null for none
  - getUri
```
public String getUri()
```
    Use this field if you want to specify a Google Cloud Storage path for the model to use.
    
    Returns:
    
    value or null for none
  - setUri
```
public GoogleCloudMlV1PredictionInput setUri(String uri)
```
    Use this field if you want to specify a Google Cloud Storage path for the model to use.
    
    Parameters:
    
    uri - uri or null for none
  - getVersionName
```
public String getVersionName()
```
    Use this field if you want to specify a version of the model to use. The string is formatted the same way as `model_version`, with the addition of the version information: `"projects/YOUR_PROJECT/models/YOUR_MODEL/versions/YOUR_VERSION"`
    
    Returns:
    
    value or null for none
  - setVersionName
```
public GoogleCloudMlV1PredictionInput setVersionName(String versionName)
```
    Use this field if you want to specify a version of the model to use. The string is formatted the same way as `model_version`, with the addition of the version information: `"projects/YOUR_PROJECT/models/YOUR_MODEL/versions/YOUR_VERSION"`
    
    Parameters:
    
    versionName - versionName or null for none
  - set
```
public GoogleCloudMlV1PredictionInput set(String fieldName,
                                          Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public GoogleCloudMlV1PredictionInput clone()
```
    Overrides:
    
    clone in class GenericJson

Class GoogleCloudMlV1PredictionInput

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

GoogleCloudMlV1PredictionInput

Method Detail

getBatchSize

setBatchSize

getDataFormat

setDataFormat

getInputPaths

setInputPaths

getMaxWorkerCount

setMaxWorkerCount

getModelName

setModelName

getOutputDataFormat

setOutputDataFormat

getOutputPath

setOutputPath

getRegion

setRegion

getRuntimeVersion

setRuntimeVersion

getSignatureName

setSignatureName

getUri

setUri

getVersionName

setVersionName

set

clone