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_v1.projects.models.html b/docs/dyn/ml_v1.projects.models.html
index 1ddb867..5ace172 100644
--- a/docs/dyn/ml_v1.projects.models.html
+++ b/docs/dyn/ml_v1.projects.models.html
@@ -80,23 +80,23 @@
<p class="firstline">Returns the versions Resource.</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 model which will later contain one or more versions.</p>
<p class="toc_element">
- <code><a href="#delete">delete(name=None, x__xgafv=None)</a></code></p>
+ <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a model.</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">Gets information about a model, including its name, the description (if</p>
<p class="toc_element">
- <code><a href="#list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
+ <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the models in a 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="create">create(parent=None, body, x__xgafv=None)</code>
+ <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
<pre>Creates a model which will later contain one or more versions.
You must add at least one version before you can request predictions from
@@ -136,9 +136,7 @@
# 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](/ml-engine/reference/rest/v1/projects.models.versions/list).
- "name": "A String", # Required.The name specified for the version when it was created.
- #
- # The version name must be unique within the model it is created in.
+ "description": "A String", # Optional. The description specified for the version when it was created.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
"manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
@@ -169,14 +167,16 @@
#
# You can change the default version by calling
# [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).
- "description": "A String", # Optional. The description specified for the version when it was created.
+ "name": "A String", # Required.The name specified for the version when it was created.
+ #
+ # The version name must be unique within the model it is created in.
},
- "description": "A String", # Optional. The description specified for the model when it was created.
- "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
- # Default is false.
"name": "A String", # Required. The name specified for the model when it was created.
#
# The model name must be unique within the project it is created in.
+ "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
+ # Default is false.
+ "description": "A String", # Optional. The description specified for the model when it was created.
}
x__xgafv: string, V1 error format.
@@ -213,9 +213,7 @@
# 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](/ml-engine/reference/rest/v1/projects.models.versions/list).
- "name": "A String", # Required.The name specified for the version when it was created.
- #
- # The version name must be unique within the model it is created in.
+ "description": "A String", # Optional. The description specified for the version when it was created.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
"manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
@@ -246,19 +244,21 @@
#
# You can change the default version by calling
# [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).
- "description": "A String", # Optional. The description specified for the version when it was created.
+ "name": "A String", # Required.The name specified for the version when it was created.
+ #
+ # The version name must be unique within the model it is created in.
},
- "description": "A String", # Optional. The description specified for the model when it was created.
- "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
- # Default is false.
"name": "A String", # Required. The name specified for the model when it was created.
#
# The model name must be unique within the project it is created in.
+ "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
+ # Default is false.
+ "description": "A String", # Optional. The description specified for the model when it was created.
}</pre>
</div>
<div class="method">
- <code class="details" id="delete">delete(name=None, x__xgafv=None)</code>
+ <code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a model.
You can only delete a model if there are no versions in it. You can delete
@@ -279,15 +279,6 @@
{ # This resource represents a long-running operation that is the result of a
# network API call.
- "metadata": { # Service-specific metadata associated with the operation. It typically
- # contains progress information and common metadata such as create time.
- # Some services might not provide such metadata. Any method that returns a
- # long-running operation should document the metadata type, if any.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "done": True or False, # If the value is `false`, it means the operation is still in progress.
- # If true, the operation is completed, and either `error` or `response` is
- # available.
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
@@ -298,6 +289,15 @@
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
+ "metadata": { # Service-specific metadata associated with the operation. It typically
+ # contains progress information and common metadata such as create time.
+ # Some services might not provide such metadata. Any method that returns a
+ # long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "done": True or False, # If the value is `false`, it means the operation is still in progress.
+ # If true, the operation is completed, and either `error` or `response` is
+ # available.
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should have the format of `operations/some/unique/name`.
@@ -368,7 +368,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>Gets information about a model, including its name, the description (if
set), and the default version (if at least one version of the model has
been deployed).
@@ -411,9 +411,7 @@
# 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](/ml-engine/reference/rest/v1/projects.models.versions/list).
- "name": "A String", # Required.The name specified for the version when it was created.
- #
- # The version name must be unique within the model it is created in.
+ "description": "A String", # Optional. The description specified for the version when it was created.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
"manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
@@ -444,19 +442,21 @@
#
# You can change the default version by calling
# [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).
- "description": "A String", # Optional. The description specified for the version when it was created.
+ "name": "A String", # Required.The name specified for the version when it was created.
+ #
+ # The version name must be unique within the model it is created in.
},
- "description": "A String", # Optional. The description specified for the model when it was created.
- "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
- # Default is false.
"name": "A String", # Required. The name specified for the model when it was created.
#
# The model name must be unique within the project it is created in.
+ "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
+ # Default is false.
+ "description": "A String", # Optional. The description specified for the model when it was created.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageToken=None, x__xgafv=None, pageSize=None)</code>
+ <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the models in a project.
Each project can contain multiple models, and each model can have multiple
@@ -466,6 +466,11 @@
parent: string, Required. The name of the project whose models are to be listed.
Authorization: requires `Viewer` role on the specified project. (required)
+ pageSize: integer, Optional. The number of models to retrieve per "page" of results. If there
+are more remaining results than this number, the response message will
+contain a valid value in the `next_page_token` field.
+
+The default value is 20, and the maximum page size is 100.
pageToken: string, Optional. A page token to request the next page of results.
You get the token from the `next_page_token` field of the response from
@@ -474,16 +479,13 @@
Allowed values
1 - v1 error format
2 - v2 error format
- pageSize: integer, Optional. The number of models to retrieve per "page" of results. If there
-are more remaining results than this number, the response message will
-contain a valid value in the `next_page_token` field.
-
-The default value is 20, and the maximum page size is 100.
Returns:
An object of the form:
{ # Response message for the ListModels method.
+ "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
+ # subsequent call.
"models": [ # The list of models.
{ # Represents a machine learning solution.
#
@@ -511,9 +513,7 @@
# 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](/ml-engine/reference/rest/v1/projects.models.versions/list).
- "name": "A String", # Required.The name specified for the version when it was created.
- #
- # The version name must be unique within the model it is created in.
+ "description": "A String", # Optional. The description specified for the version when it was created.
"runtimeVersion": "A String", # Optional. The Google Cloud ML runtime version to use for this deployment.
# If not set, Google Cloud ML will choose a version.
"manualScaling": { # Options for manually scaling a model. # Optional. Manually select the number of nodes to use for serving the
@@ -544,18 +544,18 @@
#
# You can change the default version by calling
# [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).
- "description": "A String", # Optional. The description specified for the version when it was created.
+ "name": "A String", # Required.The name specified for the version when it was created.
+ #
+ # The version name must be unique within the model it is created in.
},
- "description": "A String", # Optional. The description specified for the model when it was created.
- "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
- # Default is false.
"name": "A String", # Required. The name specified for the model when it was created.
#
# The model name must be unique within the project it is created in.
+ "onlinePredictionLogging": True or False, # Optional. If true, enables StackDriver Logging for online prediction.
+ # Default is false.
+ "description": "A String", # Optional. The description specified for the model when it was created.
},
],
- "nextPageToken": "A String", # Optional. Pass this token as the `page_token` field of the request for a
- # subsequent call.
}</pre>
</div>