com.google.api.services.ml.v1.model

Class GoogleCloudMlV1Job

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudMlV1Job
extends GenericJson

Represents a training or 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
GoogleCloudMlV1Job()

Method Summary

Modifier and Type	Method and Description
GoogleCloudMlV1Job	clone()
byte[]	decodeEtag() `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other.
GoogleCloudMlV1Job	encodeEtag(byte[] etag) `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other.
String	getCreateTime() Output only.
String	getEndTime() Output only.
String	getErrorMessage() Output only.
String	getEtag() `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other.
String	getJobId() Required.
Map<String,String>	getLabels() Optional.
GoogleCloudMlV1PredictionInput	getPredictionInput() Input parameters to create a prediction job.
GoogleCloudMlV1PredictionOutput	getPredictionOutput() The current prediction job result.
String	getStartTime() Output only.
String	getState() Output only.
GoogleCloudMlV1TrainingInput	getTrainingInput() Input parameters to create a training job.
GoogleCloudMlV1TrainingOutput	getTrainingOutput() The current training job result.
GoogleCloudMlV1Job	set(String fieldName, Object value)
GoogleCloudMlV1Job	setCreateTime(String createTime) Output only.
GoogleCloudMlV1Job	setEndTime(String endTime) Output only.
GoogleCloudMlV1Job	setErrorMessage(String errorMessage) Output only.
GoogleCloudMlV1Job	setEtag(String etag) `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other.
GoogleCloudMlV1Job	setJobId(String jobId) Required.
GoogleCloudMlV1Job	setLabels(Map<String,String> labels) Optional.
GoogleCloudMlV1Job	setPredictionInput(GoogleCloudMlV1PredictionInput predictionInput) Input parameters to create a prediction job.
GoogleCloudMlV1Job	setPredictionOutput(GoogleCloudMlV1PredictionOutput predictionOutput) The current prediction job result.
GoogleCloudMlV1Job	setStartTime(String startTime) Output only.
GoogleCloudMlV1Job	setState(String state) Output only.
GoogleCloudMlV1Job	setTrainingInput(GoogleCloudMlV1TrainingInput trainingInput) Input parameters to create a training job.
GoogleCloudMlV1Job	setTrainingOutput(GoogleCloudMlV1TrainingOutput trainingOutput) The current training job result.

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

GoogleCloudMlV1Job

public GoogleCloudMlV1Job()

Method Detail

getCreateTime

public String getCreateTime()

Output only. When the job was created.

Returns:

value or null for none

setCreateTime

public GoogleCloudMlV1Job setCreateTime(String createTime)

Output only. When the job was created.

Parameters:

createTime - createTime or null for none

getEndTime

public String getEndTime()

Output only. When the job processing was completed.

Returns:

value or null for none

setEndTime

public GoogleCloudMlV1Job setEndTime(String endTime)

Output only. When the job processing was completed.

Parameters:

endTime - endTime 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 GoogleCloudMlV1Job 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 job from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform job updates in order to avoid race conditions: An `etag` is returned in the response to `GetJob`, and systems are expected to put that etag in the request to `UpdateJob` to ensure that their change will be applied to the same version of the job.

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 job from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform job updates in order to avoid race conditions: An `etag` is returned in the response to `GetJob`, and systems are expected to put that etag in the request to `UpdateJob` to ensure that their change will be applied to the same version of the job.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getEtag()

setEtag

public GoogleCloudMlV1Job setEtag(String etag)

`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform job updates in order to avoid race conditions: An `etag` is returned in the response to `GetJob`, and systems are expected to put that etag in the request to `UpdateJob` to ensure that their change will be applied to the same version of the job.

Parameters:

etag - etag or null for none

See Also:

#encodeEtag()

encodeEtag

public GoogleCloudMlV1Job encodeEtag(byte[] etag)

`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform job updates in order to avoid race conditions: An `etag` is returned in the response to `GetJob`, and systems are expected to put that etag in the request to `UpdateJob` to ensure that their change will be applied to the same version of the job.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

getJobId

public String getJobId()

Required. The user-specified id of the job.

Returns:

value or null for none

setJobId

public GoogleCloudMlV1Job setJobId(String jobId)

Required. The user-specified id of the job.

Parameters:

jobId - jobId or null for none

getLabels

public Map<String,String> getLabels()

Optional. One or more labels that you can add, to organize your jobs. 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 GoogleCloudMlV1Job setLabels(Map<String,String> labels)

Optional. One or more labels that you can add, to organize your jobs. 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

getPredictionInput

public GoogleCloudMlV1PredictionInput getPredictionInput()

Input parameters to create a prediction job.

Returns:

value or null for none

setPredictionInput

public GoogleCloudMlV1Job setPredictionInput(GoogleCloudMlV1PredictionInput predictionInput)

Input parameters to create a prediction job.

Parameters:

predictionInput - predictionInput or null for none

getPredictionOutput

public GoogleCloudMlV1PredictionOutput getPredictionOutput()

The current prediction job result.

Returns:

value or null for none

setPredictionOutput

public GoogleCloudMlV1Job setPredictionOutput(GoogleCloudMlV1PredictionOutput predictionOutput)

The current prediction job result.

Parameters:

predictionOutput - predictionOutput or null for none

getStartTime

public String getStartTime()

Output only. When the job processing was started.

Returns:

value or null for none

setStartTime

public GoogleCloudMlV1Job setStartTime(String startTime)

Output only. When the job processing was started.

Parameters:

startTime - startTime or null for none

getState

public String getState()

Output only. The detailed state of a job.

Returns:

value or null for none

setState

public GoogleCloudMlV1Job setState(String state)

Output only. The detailed state of a job.

Parameters:

state - state or null for none

getTrainingInput

public GoogleCloudMlV1TrainingInput getTrainingInput()

Input parameters to create a training job.

Returns:

value or null for none

setTrainingInput

public GoogleCloudMlV1Job setTrainingInput(GoogleCloudMlV1TrainingInput trainingInput)

Input parameters to create a training job.

Parameters:

trainingInput - trainingInput or null for none

getTrainingOutput

public GoogleCloudMlV1TrainingOutput getTrainingOutput()

The current training job result.

Returns:

value or null for none

setTrainingOutput

public GoogleCloudMlV1Job setTrainingOutput(GoogleCloudMlV1TrainingOutput trainingOutput)

The current training job result.

Parameters:

trainingOutput - trainingOutput or null for none

set

public GoogleCloudMlV1Job set(String fieldName,
                              Object value)

Overrides:

set in class GenericJson

clone

public GoogleCloudMlV1Job clone()

Overrides:

clone in class GenericJson