blob: e98adf252139bb47540246bd7317dac0f5dfb953 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="deploymentmanager_v2beta2.html">Google Cloud Deployment Manager API V2</a> . <a href="deploymentmanager_v2beta2.resources.html">resources</a></h1>
<h2>Instance Methods</h2>
<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, maxResults=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="get">get(project, deployment, resource)</code>
<pre>Gets information about a single resource.
Args:
project: string, The project ID for this request. (required)
deployment: string, The name of the deployment for this request. (required)
resource: string, The name of the resource for this request. (required)
Returns:
An object of the form:
{
"finalProperties": "A String", # [Output Only] The evaluated properties of the resource with references expanded. Returned as serialized YAML.
"updateTime": "A String", # [Output Only] Timestamp when the resource was updated, in RFC3339 text format .
"name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
"url": "A String", # [Output Only] The URL of the actual resource.
"update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
"finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
"errors": [ # [Output Only] List of all errors encountered while trying to enact update.intent.
"A String",
],
"manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this resource.
"state": "A String", # [Output Only] The state of the resource.
"intent": "A String", # [Output Only] The intent of the resource, PREVIEW, UPDATE, or CANCEL.
"properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
},
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
"manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
"type": "A String", # [Output Only] The type of the resource, for example ?compute.v1.instance?, or ?replicaPools.v1beta2.instanceGroupManager?
"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, 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)
maxResults: integer, Maximum count of results to be returned.
pageToken: string, Tag returned by a previous list request when that list was truncated to maxResults. Used to continue a previous list request.
filter: string, Filter expression for filtering listed resources.
Returns:
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.
{
"finalProperties": "A String", # [Output Only] The evaluated properties of the resource with references expanded. Returned as serialized YAML.
"updateTime": "A String", # [Output Only] Timestamp when the resource was updated, in RFC3339 text format .
"name": "A String", # [Output Only] The name of the resource as it appears in the YAML config.
"url": "A String", # [Output Only] The URL of the actual resource.
"update": { # [Output Only] If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
"finalProperties": "A String", # [Output Only] The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
"errors": [ # [Output Only] List of all errors encountered while trying to enact update.intent.
"A String",
],
"manifest": "A String", # [Output Only] URL of the manifest representing the update configuration of this resource.
"state": "A String", # [Output Only] The state of the resource.
"intent": "A String", # [Output Only] The intent of the resource, PREVIEW, UPDATE, or CANCEL.
"properties": "A String", # [Output Only] The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
},
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"insertTime": "A String", # [Output Only] Timestamp when the resource was created or acquired, in RFC3339 text format .
"manifest": "A String", # [Output Only] URL of the manifest representing the current configuration of this resource.
"type": "A String", # [Output Only] The type of the resource, for example ?compute.v1.instance?, or ?replicaPools.v1beta2.instanceGroupManager?
"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_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>