docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/deploymentmanager_alpha.resources.html b/docs/dyn/deploymentmanager_alpha.resources.html
index 2019855..0f6ee9c 100644
--- a/docs/dyn/deploymentmanager_alpha.resources.html
+++ b/docs/dyn/deploymentmanager_alpha.resources.html
@@ -78,7 +78,7 @@
<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, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=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>
@@ -119,7 +119,7 @@
"runtimePolicies": [ # Output only. In case this is an action, it will show the runtimePolicies on which this action will run in the deployment
"A String",
],
- "type": "A String", # Output only. The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function.
+ "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.
"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.
@@ -144,7 +144,7 @@
],
},
"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.
+ "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.
"runtimePolicies": [ # Output only. In case this is an action, it will show the runtimePolicies that this action will have after updating the deployment.
@@ -184,26 +184,27 @@
</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, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=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 <.
+ 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.
+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.
+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)
+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.
-You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
+You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
-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.
+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.
+ returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
Returns:
An object of the form:
@@ -234,7 +235,7 @@
"runtimePolicies": [ # Output only. In case this is an action, it will show the runtimePolicies on which this action will run in the deployment
"A String",
],
- "type": "A String", # Output only. The type of the resource, for example compute.v1.instance, or cloudfunctions.v1beta1.function.
+ "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.
"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.
@@ -259,7 +260,7 @@
],
},
"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.
+ "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.
"runtimePolicies": [ # Output only. In case this is an action, it will show the runtimePolicies that this action will have after updating the deployment.