blob: fc827811d55d2ebc7877b71aff5cfdd92c865298 [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_v2.html">Google Cloud Deployment Manager API</a> . <a href="deploymentmanager_v2.manifests.html">manifests</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(project, deployment, manifest)</a></code></p>
<p class="firstline">Gets information about a specific manifest.</p>
<p class="toc_element">
<code><a href="#list">list(project, deployment, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Lists all manifests for 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, manifest)</code>
<pre>Gets information about a specific manifest.
Args:
project: string, The project ID for this request. (required)
deployment: string, The name of the deployment for this request. (required)
manifest: string, The name of the manifest for this request. (required)
Returns:
An object of the form:
{
"layout": "A String", # [Output Only] The YAML layout for this manifest.
"name": "A String", # [Output Only] The name of the manifest.
"expandedConfig": "A String", # [Output Only] The fully-expanded configuration file, including any templates and references.
"imports": [ # [Output Only] The imported files for this manifest.
{
"content": "A String", # The contents of the file.
"name": "A String", # The name of the file.
},
],
"insertTime": "A String", # [Output Only] Timestamp when the manifest was created, in RFC3339 text format.
"config": { # [Output Only] The YAML configuration for this manifest.
"content": "A String", # The contents of the file.
},
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] Self link for the manifest.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, deployment, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
<pre>Lists all manifests for a given deployment.
Args:
project: string, The project ID for this request. (required)
deployment: string, The name of the deployment for this request. (required)
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.
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.
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, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string.
The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field.
For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance.
You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values.
To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters.
Returns:
An object of the form:
{ # A response containing a partial list of manifests and a page token used to build the next request if the request has been truncated.
"nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
"manifests": [ # [Output Only] Manifests contained in this list response.
{
"layout": "A String", # [Output Only] The YAML layout for this manifest.
"name": "A String", # [Output Only] The name of the manifest.
"expandedConfig": "A String", # [Output Only] The fully-expanded configuration file, including any templates and references.
"imports": [ # [Output Only] The imported files for this manifest.
{
"content": "A String", # The contents of the file.
"name": "A String", # The name of the file.
},
],
"insertTime": "A String", # [Output Only] Timestamp when the manifest was created, in RFC3339 text format.
"config": { # [Output Only] The YAML configuration for this manifest.
"content": "A String", # The contents of the file.
},
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] Self link for the manifest.
},
],
}</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>