docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/deploymentmanager_v2beta.resources.html b/docs/dyn/deploymentmanager_v2beta.resources.html
index 314f8e1..808ddc4 100644
--- a/docs/dyn/deploymentmanager_v2beta.resources.html
+++ b/docs/dyn/deploymentmanager_v2beta.resources.html
@@ -75,16 +75,24 @@
<h1><a href="deploymentmanager_v2beta.html">Google Cloud Deployment Manager API V2Beta Methods</a> . <a href="deploymentmanager_v2beta.resources.html">resources</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
+ <code><a href="#close">close()</a></code></p>
+<p class="firstline">Close httplib2 connections.</p>
+<p class="toc_element">
<code><a href="#get">get(project, deployment, resource)</a></code></p>
<p class="firstline">Gets information about a single resource.</p>
<p class="toc_element">
- <code><a href="#list">list(project, deployment, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p>
+ <code><a href="#list">list(project, deployment, maxResults=None, orderBy=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Lists all resources in a given deployment.</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="close">close()</code>
+ <pre>Close httplib2 connections.</pre>
+</div>
+
+<div class="method">
<code class="details" id="get">get(project, deployment, resource)</code>
<pre>Gets information about a single resource.
@@ -97,20 +105,27 @@
An object of the form:
{
- "accessControl": { # The access controls set on the resource. # The Access Control Policy set on this resource.
- "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
- },
- "finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
- "id": "A String",
- "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
- "manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource.
- "name": "A String", # Output only. The name of the resource as it appears in the YAML config.
- "properties": "A String", # Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.
- "type": "A String", # Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.
"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
+ "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
"accessControl": { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself.
"gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
},
+ "state": "A String", # Output only. The state of the resource.
+ "finalProperties": "A String", # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
+ "properties": "A String", # Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
+ "intent": "A String", # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
"error": { # Output only. If errors are generated during update of the resource, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
@@ -120,57 +135,43 @@
},
],
},
- "finalProperties": "A String", # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
- "intent": "A String", # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this resource.
- "properties": "A String", # Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
- "state": "A String", # Output only. The state of the resource.
- "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
},
- "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
- "url": "A String", # Output only. The URL of the actual resource.
+ "id": "A String",
+ "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
+ "accessControl": { # The access controls set on the resource. # The Access Control Policy set on this resource.
+ "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
+ },
+ "manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource.
"warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
+ "url": "A String", # Output only. The URL of the actual resource.
+ "finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
+ "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
+ "type": "A String", # Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.
+ "name": "A String", # Output only. The name of the resource as it appears in the YAML config.
+ "properties": "A String", # Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, deployment, filter=None, maxResults=None, orderBy=None, pageToken=None)</code>
+ <code class="details" id="list">list(project, deployment, maxResults=None, orderBy=None, pageToken=None, filter=None)</code>
<pre>Lists all resources in a given deployment.
Args:
project: string, The project ID for this request. (required)
deployment: string, The name of the deployment for this request. (required)
- filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
-
-For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
-
-You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
-
-To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
@@ -178,6 +179,13 @@
Currently, only sorting by `name` or `creationTimestamp desc` is supported.
pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+ filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.
+
+For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
+
+You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
+
+To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
Returns:
An object of the form:
@@ -186,20 +194,27 @@
"nextPageToken": "A String", # A token used to continue a truncated list request.
"resources": [ # Resources contained in this list response.
{
- "accessControl": { # The access controls set on the resource. # The Access Control Policy set on this resource.
- "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
- },
- "finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
- "id": "A String",
- "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
- "manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource.
- "name": "A String", # Output only. The name of the resource as it appears in the YAML config.
- "properties": "A String", # Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.
- "type": "A String", # Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.
"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
+ "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
+ {
+ "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+ "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
+ # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+ {
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+ },
+ ],
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ },
+ ],
"accessControl": { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself.
"gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
},
+ "state": "A String", # Output only. The state of the resource.
+ "finalProperties": "A String", # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
+ "properties": "A String", # Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
+ "intent": "A String", # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
"error": { # Output only. If errors are generated during update of the resource, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
@@ -209,40 +224,33 @@
},
],
},
- "finalProperties": "A String", # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
- "intent": "A String", # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this resource.
- "properties": "A String", # Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
- "state": "A String", # Output only. The state of the resource.
- "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
- {
- "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
- "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
- # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
- {
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
- "value": "A String", # [Output Only] A warning data value corresponding to the key.
- },
- ],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- },
- ],
},
- "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
- "url": "A String", # Output only. The URL of the actual resource.
+ "id": "A String",
+ "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
+ "accessControl": { # The access controls set on the resource. # The Access Control Policy set on this resource.
+ "gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.
+ },
+ "manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource.
"warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
{
"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example:
# "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
- "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
+ "url": "A String", # Output only. The URL of the actual resource.
+ "finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
+ "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
+ "type": "A String", # Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.
+ "name": "A String", # Output only. The name of the resource as it appears in the YAML config.
+ "properties": "A String", # Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.
},
],
}</pre>