docs: update generated docs (#1053)
Updates for both discovery docs and epydoc API Documentation
Fixes: #1049
diff --git a/docs/dyn/deploymentmanager_alpha.resources.html b/docs/dyn/deploymentmanager_alpha.resources.html
index 0f6ee9c..ec08b1c 100644
--- a/docs/dyn/deploymentmanager_alpha.resources.html
+++ b/docs/dyn/deploymentmanager_alpha.resources.html
@@ -75,16 +75,24 @@
<h1><a href="deploymentmanager_alpha.html">Google Cloud Deployment Manager Alpha API</a> . <a href="deploymentmanager_alpha.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, returnPartialSuccess=None)</a></code></p>
+ <code><a href="#list">list(project, deployment, filter=None, maxResults=None, orderBy=None, returnPartialSuccess=None, pageToken=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,34 +105,42 @@
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.
- "lastUsedCredential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The last used credential that successfully created/updated the resource.
- "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.
- "password": "A String",
- "user": "A String",
+ "url": "A String", # Output only. The URL of the actual resource.
+ "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
+ {
+ "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).
+ },
+ ],
+ "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.
},
- "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.
- "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com
- },
- "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
- },
- "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.
+ ],
"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`.
+ "id": "A String",
+ "manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource.
+ "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
+ "insertTime": "A String", # Output only. Creation 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.
+ "runtimePolicies": [ # Output only. In case this is an action, it will show the runtimePolicies that this action will have after updating the deployment.
+ "A String",
+ ],
+ "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.
+ "intent": "A String", # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
+ "finalProperties": "A String", # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
"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.
},
"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The credential that will be used creating/updating this resource.
+ "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.
"password": "A String",
"user": "A String",
@@ -132,28 +148,10 @@
"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.
"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com
},
- "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
- "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.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "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.
- },
- ],
- },
- "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.
- "runtimePolicies": [ # Output only. In case this is an action, it will show the runtimePolicies that this action will have after updating the deployment.
- "A String",
- ],
- "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.
+ "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" }
{
@@ -161,30 +159,40 @@
"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.
+ "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.
},
],
- },
- "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
- "url": "A String", # Output only. The URL of the actual 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" }
+ "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.
{
- "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.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
},
],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
},
- ],
+ },
+ "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`.
+ "finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
+ "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.
+ },
+ "lastUsedCredential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The last used credential that successfully created/updated the resource.
+ "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
+ "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.
+ "password": "A String",
+ "user": "A String",
+ },
+ "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.
+ "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com
+ },
+ },
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(project, deployment, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>
+ <code class="details" id="list">list(project, deployment, filter=None, maxResults=None, orderBy=None, returnPartialSuccess=None, pageToken=None)</code>
<pre>Lists all resources in a given deployment.
Args:
@@ -203,8 +211,8 @@
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.
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.
+ 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.
Returns:
An object of the form:
@@ -213,34 +221,42 @@
"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.
- "lastUsedCredential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The last used credential that successfully created/updated the resource.
- "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.
- "password": "A String",
- "user": "A String",
+ "url": "A String", # Output only. The URL of the actual resource.
+ "warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.
+ {
+ "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).
+ },
+ ],
+ "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.
},
- "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.
- "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com
- },
- "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
- },
- "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.
+ ],
"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`.
+ "id": "A String",
+ "manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource.
+ "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
+ "insertTime": "A String", # Output only. Creation 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.
+ "runtimePolicies": [ # Output only. In case this is an action, it will show the runtimePolicies that this action will have after updating the deployment.
+ "A String",
+ ],
+ "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.
+ "intent": "A String", # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.
+ "finalProperties": "A String", # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
"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.
},
"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The credential that will be used creating/updating this resource.
+ "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.
"password": "A String",
"user": "A String",
@@ -248,28 +264,10 @@
"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.
"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com
},
- "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
},
- "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.
- {
- "code": "A String", # [Output Only] The error type identifier for this error.
- "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.
- },
- ],
- },
- "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.
- "runtimePolicies": [ # Output only. In case this is an action, it will show the runtimePolicies that this action will have after updating the deployment.
- "A String",
- ],
- "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.
+ "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" }
{
@@ -277,25 +275,35 @@
"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.
+ "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.
},
],
- },
- "updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.
- "url": "A String", # Output only. The URL of the actual 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" }
+ "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.
{
- "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.
+ "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+ "code": "A String", # [Output Only] The error type identifier for this error.
+ "message": "A String", # [Output Only] An optional, human-readable error message.
},
],
- "message": "A String", # [Output Only] A human-readable description of the warning code.
},
- ],
+ },
+ "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`.
+ "finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
+ "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.
+ },
+ "lastUsedCredential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The last used credential that successfully created/updated the resource.
+ "useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.
+ "basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.
+ "password": "A String",
+ "user": "A String",
+ },
+ "serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.
+ "email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com
+ },
+ },
},
],
}</pre>