com.google.api.services.bigquery.model.MlStatistics Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
* in compliance with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under the License
* is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
* or implied. See the License for the specific language governing permissions and limitations under
* the License.
*/
/*
* This code was generated by https://github.com/googleapis/google-api-java-client-services/
* Modify at your own risk.
*/
package com.google.api.services.bigquery.model;
/**
* Job statistics specific to a BigQuery ML training 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 BigQuery API. For a detailed explanation see:
* https://developers.google.com/api-client-library/java/google-http-java-client/json
*
*
* @author Google, Inc.
*/
@SuppressWarnings("javadoc")
public final class MlStatistics extends com.google.api.client.json.GenericJson {
/**
* Output only. Trials of a [hyperparameter tuning job](https://cloud.google.com/bigquery-
* ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List hparamTrials;
static {
// hack to force ProGuard to consider HparamTuningTrial used, since otherwise it would be stripped out
// see https://github.com/google/google-api-java-client/issues/543
com.google.api.client.util.Data.nullOf(HparamTuningTrial.class);
}
/**
* Results for all completed iterations. Empty for [hyperparameter tuning
* jobs](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-
* tuning-overview).
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.util.List iterationResults;
static {
// hack to force ProGuard to consider IterationResult used, since otherwise it would be stripped out
// see https://github.com/google/google-api-java-client/issues/543
com.google.api.client.util.Data.nullOf(IterationResult.class);
}
/**
* Output only. Maximum number of iterations specified as max_iterations in the 'CREATE MODEL'
* query. The actual number of iterations may be less than this number due to early stop.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key @com.google.api.client.json.JsonString
private java.lang.Long maxIterations;
/**
* Output only. The type of the model that is being trained.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String modelType;
/**
* Output only. Training type of the job.
* The value may be {@code null}.
*/
@com.google.api.client.util.Key
private java.lang.String trainingType;
/**
* Output only. Trials of a [hyperparameter tuning job](https://cloud.google.com/bigquery-
* ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id.
* @return value or {@code null} for none
*/
public java.util.List getHparamTrials() {
return hparamTrials;
}
/**
* Output only. Trials of a [hyperparameter tuning job](https://cloud.google.com/bigquery-
* ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) sorted by trial_id.
* @param hparamTrials hparamTrials or {@code null} for none
*/
public MlStatistics setHparamTrials(java.util.List hparamTrials) {
this.hparamTrials = hparamTrials;
return this;
}
/**
* Results for all completed iterations. Empty for [hyperparameter tuning
* jobs](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-
* tuning-overview).
* @return value or {@code null} for none
*/
public java.util.List getIterationResults() {
return iterationResults;
}
/**
* Results for all completed iterations. Empty for [hyperparameter tuning
* jobs](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-
* tuning-overview).
* @param iterationResults iterationResults or {@code null} for none
*/
public MlStatistics setIterationResults(java.util.List iterationResults) {
this.iterationResults = iterationResults;
return this;
}
/**
* Output only. Maximum number of iterations specified as max_iterations in the 'CREATE MODEL'
* query. The actual number of iterations may be less than this number due to early stop.
* @return value or {@code null} for none
*/
public java.lang.Long getMaxIterations() {
return maxIterations;
}
/**
* Output only. Maximum number of iterations specified as max_iterations in the 'CREATE MODEL'
* query. The actual number of iterations may be less than this number due to early stop.
* @param maxIterations maxIterations or {@code null} for none
*/
public MlStatistics setMaxIterations(java.lang.Long maxIterations) {
this.maxIterations = maxIterations;
return this;
}
/**
* Output only. The type of the model that is being trained.
* @return value or {@code null} for none
*/
public java.lang.String getModelType() {
return modelType;
}
/**
* Output only. The type of the model that is being trained.
* @param modelType modelType or {@code null} for none
*/
public MlStatistics setModelType(java.lang.String modelType) {
this.modelType = modelType;
return this;
}
/**
* Output only. Training type of the job.
* @return value or {@code null} for none
*/
public java.lang.String getTrainingType() {
return trainingType;
}
/**
* Output only. Training type of the job.
* @param trainingType trainingType or {@code null} for none
*/
public MlStatistics setTrainingType(java.lang.String trainingType) {
this.trainingType = trainingType;
return this;
}
@Override
public MlStatistics set(String fieldName, Object value) {
return (MlStatistics) super.set(fieldName, value);
}
@Override
public MlStatistics clone() {
return (MlStatistics) super.clone();
}
}