docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/deploymentmanager_v2.resources.html b/docs/dyn/deploymentmanager_v2.resources.html
index 8cee044..a87981a 100644
--- a/docs/dyn/deploymentmanager_v2.resources.html
+++ b/docs/dyn/deploymentmanager_v2.resources.html
@@ -81,7 +81,7 @@
<code><a href="#get">get(project, deployment, resource, x__xgafv=None)</a></code></p>
<p class="firstline">Gets information about a single resource.</p>
<p class="toc_element">
- <code><a href="#list">list(project, deployment, maxResults=None, orderBy=None, returnPartialSuccess=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(project, deployment, returnPartialSuccess=None, filter=None, pageToken=None, maxResults=None, orderBy=None, x__xgafv=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>
@@ -109,44 +109,25 @@
An object of the form:
{
- "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
- "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
- {
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- "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).
- },
- ],
- },
- ],
- "name": "A String", # Output only. The name of the resource as it appears in the YAML config.
- "finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
- "manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource.
- "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
- "url": "A String", # Output only. The URL of the actual resource.
- "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.
- },
- "id": "A String",
"type": "A String", # Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.
- "properties": "A String", # Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.
+ "url": "A String", # Output only. The URL of the actual resource.
+ "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
+ "name": "A String", # Output only. The name of the resource as it appears in the YAML config.
"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
- "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.
"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.
{
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
- "intent": "A String", # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
"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.
"message": "A String", # [Output Only] A human-readable description of the warning code.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
@@ -154,31 +135,50 @@
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
- "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.
},
],
"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.
},
- "properties": "A String", # Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this resource.
- "finalProperties": "A String", # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
+ "state": "A String", # Output only. The state of the resource.
+ "intent": "A String", # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
},
+ "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "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.
+ },
+ ],
+ },
+ ],
+ "manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource.
+ "finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
+ "id": "A String",
+ "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.
+ },
+ "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
+ "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, maxResults=None, orderBy=None, returnPartialSuccess=None, filter=None, pageToken=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(project, deployment, returnPartialSuccess=None, filter=None, pageToken=None, maxResults=None, orderBy=None, x__xgafv=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)
- 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
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.
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) ```
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.
+ 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -188,47 +188,27 @@
An object of the form:
{ # A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.
- "nextPageToken": "A String", # A token used to continue a truncated list request.
"resources": [ # Resources contained in this list response.
{
- "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
- "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
- {
- "message": "A String", # [Output Only] A human-readable description of the warning code.
- "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).
- },
- ],
- },
- ],
- "name": "A String", # Output only. The name of the resource as it appears in the YAML config.
- "finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
- "manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource.
- "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
- "url": "A String", # Output only. The URL of the actual resource.
- "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.
- },
- "id": "A String",
"type": "A String", # Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.
- "properties": "A String", # Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.
+ "url": "A String", # Output only. The URL of the actual resource.
+ "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
+ "name": "A String", # Output only. The name of the resource as it appears in the YAML config.
"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
- "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.
"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.
{
- "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
- "message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
},
],
},
- "intent": "A String", # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
"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.
"message": "A String", # [Output Only] A human-readable description of the warning code.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
@@ -236,18 +216,38 @@
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
- "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.
},
],
"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.
},
- "properties": "A String", # Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this resource.
- "finalProperties": "A String", # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
+ "state": "A String", # Output only. The state of the resource.
+ "intent": "A String", # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
},
+ "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
+ {
+ "message": "A String", # [Output Only] A human-readable description of the warning code.
+ "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.
+ },
+ ],
+ },
+ ],
+ "manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource.
+ "finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
+ "id": "A String",
+ "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.
+ },
+ "insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.
+ "properties": "A String", # Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.
},
],
+ "nextPageToken": "A String", # A token used to continue a truncated list request.
}</pre>
</div>