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.models.versions.html b/docs/dyn/ml_v1beta1.projects.models.versions.html
index 340d4e9..9356a13 100644
--- a/docs/dyn/ml_v1beta1.projects.models.versions.html
+++ b/docs/dyn/ml_v1beta1.projects.models.versions.html
@@ -75,26 +75,26 @@
<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.models.html">models</a> . <a href="ml_v1beta1.projects.models.versions.html">versions</a></h1>
<h2>Instance Methods</h2>
<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 new version of a model from a trained TensorFlow model.</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 version.</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 version.</p>
<p class="toc_element">
- <code><a href="#list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">Gets basic information about all the versions of a model.</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>
<p class="toc_element">
- <code><a href="#setDefault">setDefault(name=None, body, x__xgafv=None)</a></code></p>
+ <code><a href="#setDefault">setDefault(name, body, x__xgafv=None)</a></code></p>
<p class="firstline">Designates a version to be the default for the model.</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 new version of a model from a trained TensorFlow model.
If the version created in the cloud by this call is the first deployed
@@ -117,7 +117,9 @@
# 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/v1beta1/projects.models.versions/list).
- "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.
"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
@@ -148,9 +150,7 @@
#
# You can change the default version by calling
# [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1beta1/projects.models.versions/setDefault).
- "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.
}
x__xgafv: string, V1 error format.
@@ -163,6 +163,28 @@
{ # 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
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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`.
"error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
@@ -226,33 +248,11 @@
},
],
},
- "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
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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`.
- "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.
- },
}</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 version.
Each model can have multiple versions deployed and in use at any given
@@ -277,6 +277,28 @@
{ # 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
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
+ # is the original method name. For example, if the original method name
+ # is `TakeSnapshot()`, the inferred response type is
+ # `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "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`.
"error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation.
# programming environments, including REST APIs and RPC APIs. It is used by
# [gRPC](https://github.com/grpc). The error model is designed to be:
@@ -340,33 +362,11 @@
},
],
},
- "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
- # `Get`/`Create`/`Update`, the response should be the resource. For other
- # methods, the response should have the type `XxxResponse`, where `Xxx`
- # is the original method name. For example, if the original method name
- # is `TakeSnapshot()`, the inferred response type is
- # `TakeSnapshotResponse`.
- "a_key": "", # Properties of the object. Contains field @type with type URL.
- },
- "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`.
- "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.
- },
}</pre>
</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 version.
Models can have multiple versions. You can call
@@ -392,7 +392,9 @@
# 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/v1beta1/projects.models.versions/list).
- "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.
"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
@@ -423,14 +425,12 @@
#
# You can change the default version by calling
# [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1beta1/projects.models.versions/setDefault).
- "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.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(parent=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>Gets basic information about all the versions of a model.
If you expect that a model has a lot of versions, or if you need to handle
@@ -441,11 +441,6 @@
parent: string, Required. The name of the model for which to list the version.
Authorization: requires `Viewer` role on the parent project. (required)
- pageSize: integer, Optional. The number of versions 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
@@ -454,6 +449,11 @@
Allowed values
1 - v1 error format
2 - v2 error format
+ pageSize: integer, Optional. The number of versions 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:
@@ -468,7 +468,9 @@
# 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/v1beta1/projects.models.versions/list).
- "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.
"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
@@ -499,9 +501,7 @@
#
# You can change the default version by calling
# [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1beta1/projects.models.versions/setDefault).
- "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.
},
],
}</pre>
@@ -522,7 +522,7 @@
</div>
<div class="method">
- <code class="details" id="setDefault">setDefault(name=None, body, x__xgafv=None)</code>
+ <code class="details" id="setDefault">setDefault(name, body, x__xgafv=None)</code>
<pre>Designates a version to be the default for the model.
The default version is used for prediction requests made against the model
@@ -558,7 +558,9 @@
# 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/v1beta1/projects.models.versions/list).
- "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.
"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
@@ -589,9 +591,7 @@
#
# You can change the default version by calling
# [projects.methods.versions.setDefault](/ml-engine/reference/rest/v1beta1/projects.models.versions/setDefault).
- "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.
}</pre>
</div>