Fix method doc signatures for multiline required parameters (#374)
* Fix method doc signatures for multiline required parameters.
Existing doc generator failed to recognize parameters as required when parameter descriptions
extended over more than one line. Besides presenting incorrect information, resulting
inconsistencies broke checks for automated sample generation.
* Regen docs
diff --git a/docs/dyn/ml_v1beta1.projects.jobs.html b/docs/dyn/ml_v1beta1.projects.jobs.html
index 0399c35..4980b42 100644
--- a/docs/dyn/ml_v1beta1.projects.jobs.html
+++ b/docs/dyn/ml_v1beta1.projects.jobs.html
@@ -75,23 +75,23 @@
<h1><a href="ml_v1beta1.html">Google Cloud Machine Learning Engine</a> . <a href="ml_v1beta1.projects.html">projects</a> . <a href="ml_v1beta1.projects.jobs.html">jobs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#cancel">cancel(name=None, body, x__xgafv=None)</a></code></p>
+ <code><a href="#cancel">cancel(name, body, x__xgafv=None)</a></code></p>
<p class="firstline">Cancels a running job.</p>
<p class="toc_element">
- <code><a href="#create">create(parent=None, body, x__xgafv=None)</a></code></p>
+ <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a training or a batch prediction job.</p>
<p class="toc_element">
- <code><a href="#get">get(name=None, x__xgafv=None)</a></code></p>
+ <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Describes a job.</p>
<p class="toc_element">
- <code><a href="#list">list(parent=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the jobs in the project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="cancel">cancel(name=None, body, x__xgafv=None)</code>
+ <code class="details" id="cancel">cancel(name, body, x__xgafv=None)</code>
<pre>Cancels a running job.
Args:
@@ -125,7 +125,7 @@
</div>
<div class="method">
- <code class="details" id="create">create(parent=None, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
<pre>Creates a training or a batch prediction job.
Args:
@@ -136,7 +136,11 @@
The object takes the form of:
{ # Represents a training or prediction job.
+ "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
"trainingOutput": { # Represents results of a training job. Output only. # The current training job result.
+ "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
+ # Only set for hyperparameter tuning jobs.
+ "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"trials": [ # Results for individual Hyperparameter trials.
# Only set for hyperparameter tuning jobs.
{ # Represents the result of a single hyperparameter tuning trial from a
@@ -159,11 +163,9 @@
},
},
],
- "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"consumedMLUnits": 3.14, # The amount of ML units consumed by the job.
- "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
- # Only set for hyperparameter tuning jobs.
},
+ "startTime": "A String", # Output only. When the job processing was started.
"trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job.
"workerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
# job's worker nodes.
@@ -311,6 +313,8 @@
# This value can only be used when `scale_tier` is set to `CUSTOM`.If you
# set this value, you must also set `parameter_server_type`.
},
+ "jobId": "A String", # Required. The user-specified id of the job.
+ "state": "A String", # Output only. The detailed state of a job.
"predictionInput": { # Represents input parameters for a prediction job. # Input parameters to create a prediction job.
"modelName": "A String", # Use this field if you want to use the default version for the specified
# model. The string must use the following format:
@@ -338,10 +342,6 @@
# `"projects/<var>[YOUR_PROJECT]</var>/models/<var>YOUR_MODEL/versions/<var>[YOUR_VERSION]</var>"`
"region": "A String", # Required. The Google Compute Engine region to run the prediction job in.
},
- "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
- "jobId": "A String", # Required. The user-specified id of the job.
- "state": "A String", # Output only. The detailed state of a job.
- "startTime": "A String", # Output only. When the job processing was started.
"endTime": "A String", # Output only. When the job processing was completed.
"predictionOutput": { # Represents results of a prediction job. # The current prediction job result.
"outputPath": "A String", # The output Google Cloud Storage location provided at the job creation time.
@@ -361,7 +361,11 @@
An object of the form:
{ # Represents a training or prediction job.
+ "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
"trainingOutput": { # Represents results of a training job. Output only. # The current training job result.
+ "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
+ # Only set for hyperparameter tuning jobs.
+ "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"trials": [ # Results for individual Hyperparameter trials.
# Only set for hyperparameter tuning jobs.
{ # Represents the result of a single hyperparameter tuning trial from a
@@ -384,11 +388,9 @@
},
},
],
- "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"consumedMLUnits": 3.14, # The amount of ML units consumed by the job.
- "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
- # Only set for hyperparameter tuning jobs.
},
+ "startTime": "A String", # Output only. When the job processing was started.
"trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job.
"workerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
# job's worker nodes.
@@ -536,6 +538,8 @@
# This value can only be used when `scale_tier` is set to `CUSTOM`.If you
# set this value, you must also set `parameter_server_type`.
},
+ "jobId": "A String", # Required. The user-specified id of the job.
+ "state": "A String", # Output only. The detailed state of a job.
"predictionInput": { # Represents input parameters for a prediction job. # Input parameters to create a prediction job.
"modelName": "A String", # Use this field if you want to use the default version for the specified
# model. The string must use the following format:
@@ -563,10 +567,6 @@
# `"projects/<var>[YOUR_PROJECT]</var>/models/<var>YOUR_MODEL/versions/<var>[YOUR_VERSION]</var>"`
"region": "A String", # Required. The Google Compute Engine region to run the prediction job in.
},
- "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
- "jobId": "A String", # Required. The user-specified id of the job.
- "state": "A String", # Output only. The detailed state of a job.
- "startTime": "A String", # Output only. When the job processing was started.
"endTime": "A String", # Output only. When the job processing was completed.
"predictionOutput": { # Represents results of a prediction job. # The current prediction job result.
"outputPath": "A String", # The output Google Cloud Storage location provided at the job creation time.
@@ -579,7 +579,7 @@
</div>
<div class="method">
- <code class="details" id="get">get(name=None, x__xgafv=None)</code>
+ <code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Describes a job.
Args:
@@ -595,7 +595,11 @@
An object of the form:
{ # Represents a training or prediction job.
+ "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
"trainingOutput": { # Represents results of a training job. Output only. # The current training job result.
+ "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
+ # Only set for hyperparameter tuning jobs.
+ "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"trials": [ # Results for individual Hyperparameter trials.
# Only set for hyperparameter tuning jobs.
{ # Represents the result of a single hyperparameter tuning trial from a
@@ -618,11 +622,9 @@
},
},
],
- "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"consumedMLUnits": 3.14, # The amount of ML units consumed by the job.
- "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
- # Only set for hyperparameter tuning jobs.
},
+ "startTime": "A String", # Output only. When the job processing was started.
"trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job.
"workerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
# job's worker nodes.
@@ -770,6 +772,8 @@
# This value can only be used when `scale_tier` is set to `CUSTOM`.If you
# set this value, you must also set `parameter_server_type`.
},
+ "jobId": "A String", # Required. The user-specified id of the job.
+ "state": "A String", # Output only. The detailed state of a job.
"predictionInput": { # Represents input parameters for a prediction job. # Input parameters to create a prediction job.
"modelName": "A String", # Use this field if you want to use the default version for the specified
# model. The string must use the following format:
@@ -797,10 +801,6 @@
# `"projects/<var>[YOUR_PROJECT]</var>/models/<var>YOUR_MODEL/versions/<var>[YOUR_VERSION]</var>"`
"region": "A String", # Required. The Google Compute Engine region to run the prediction job in.
},
- "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
- "jobId": "A String", # Required. The user-specified id of the job.
- "state": "A String", # Output only. The detailed state of a job.
- "startTime": "A String", # Output only. When the job processing was started.
"endTime": "A String", # Output only. When the job processing was completed.
"predictionOutput": { # Represents results of a prediction job. # The current prediction job result.
"outputPath": "A String", # The output Google Cloud Storage location provided at the job creation time.
@@ -813,7 +813,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the jobs in the project.
Args:
@@ -843,7 +843,11 @@
# subsequent call.
"jobs": [ # The list of jobs.
{ # Represents a training or prediction job.
+ "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
"trainingOutput": { # Represents results of a training job. Output only. # The current training job result.
+ "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
+ # Only set for hyperparameter tuning jobs.
+ "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"trials": [ # Results for individual Hyperparameter trials.
# Only set for hyperparameter tuning jobs.
{ # Represents the result of a single hyperparameter tuning trial from a
@@ -866,11 +870,9 @@
},
},
],
- "isHyperparameterTuningJob": True or False, # Whether this job is a hyperparameter tuning job.
"consumedMLUnits": 3.14, # The amount of ML units consumed by the job.
- "completedTrialCount": "A String", # The number of hyperparameter tuning trials that completed successfully.
- # Only set for hyperparameter tuning jobs.
},
+ "startTime": "A String", # Output only. When the job processing was started.
"trainingInput": { # Represents input parameters for a training job. # Input parameters to create a training job.
"workerType": "A String", # Optional. Specifies the type of virtual machine to use for your training
# job's worker nodes.
@@ -1018,6 +1020,8 @@
# This value can only be used when `scale_tier` is set to `CUSTOM`.If you
# set this value, you must also set `parameter_server_type`.
},
+ "jobId": "A String", # Required. The user-specified id of the job.
+ "state": "A String", # Output only. The detailed state of a job.
"predictionInput": { # Represents input parameters for a prediction job. # Input parameters to create a prediction job.
"modelName": "A String", # Use this field if you want to use the default version for the specified
# model. The string must use the following format:
@@ -1045,10 +1049,6 @@
# `"projects/<var>[YOUR_PROJECT]</var>/models/<var>YOUR_MODEL/versions/<var>[YOUR_VERSION]</var>"`
"region": "A String", # Required. The Google Compute Engine region to run the prediction job in.
},
- "errorMessage": "A String", # Output only. The details of a failure or a cancellation.
- "jobId": "A String", # Required. The user-specified id of the job.
- "state": "A String", # Output only. The detailed state of a job.
- "startTime": "A String", # Output only. When the job processing was started.
"endTime": "A String", # Output only. When the job processing was completed.
"predictionOutput": { # Represents results of a prediction job. # The current prediction job result.
"outputPath": "A String", # The output Google Cloud Storage location provided at the job creation time.