blob: 789f447b43991a364cfba4ecb9e8fa744f2e2c20 [file] [log] [blame] [edit]
<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="config_v1.html">Infrastructure Manager API</a> . <a href="config_v1.projects.html">projects</a> . <a href="config_v1.projects.locations.html">locations</a> . <a href="config_v1.projects.locations.deployments.html">deployments</a> . <a href="config_v1.projects.locations.deployments.revisions.html">revisions</a> . <a href="config_v1.projects.locations.deployments.revisions.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(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details about a Resource deployed by Infra Manager.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Resources in a given revision.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</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(name, x__xgafv=None)</code>
<pre>Gets details about a Resource deployed by Infra Manager.
Args:
name: string, Required. The name of the Resource in the format: &#x27;projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}/resource/{resource}&#x27;. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Resource represents a Google Cloud Platform resource actuated by IM. Resources are child resources of Revisions.
&quot;caiAssets&quot;: { # Output only. Map of Cloud Asset Inventory (CAI) type to CAI info (e.g. CAI ID). CAI type format follows https://cloud.google.com/asset-inventory/docs/supported-asset-types
&quot;a_key&quot;: { # CAI info of a Resource.
&quot;fullResourceName&quot;: &quot;A String&quot;, # CAI resource name in the format following https://cloud.google.com/apis/design/resource_names#full_resource_name
},
},
&quot;intent&quot;: &quot;A String&quot;, # Output only. Intent of the resource.
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name. Format: `projects/{project}/locations/{location}/deployments/{deployment}/revisions/{revision}/resources/{resource}`
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the resource.
&quot;terraformInfo&quot;: { # Terraform info of a Resource. # Output only. Terraform-specific info if this resource was created using Terraform.
&quot;address&quot;: &quot;A String&quot;, # TF resource address that uniquely identifies this resource within this deployment.
&quot;id&quot;: &quot;A String&quot;, # ID attribute of the TF resource
&quot;type&quot;: &quot;A String&quot;, # TF resource type
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Resources in a given revision.
Args:
parent: string, Required. The parent in whose context the Resources are listed. The parent value is in the format: &#x27;projects/{project_id}/locations/{location}/deployments/{deployment}/revisions/{revision}&#x27;. (required)
filter: string, Lists the Resources that match the filter expression. A filter expression filters the resources listed in the response. The expression must be of the form &#x27;{field} {operator} {value}&#x27; where operators: &#x27;&lt;&#x27;, &#x27;&gt;&#x27;, &#x27;&lt;=&#x27;, &#x27;&gt;=&#x27;, &#x27;!=&#x27;, &#x27;=&#x27;, &#x27;:&#x27; are supported (colon &#x27;:&#x27; represents a HAS operator which is roughly synonymous with equality). {field} can refer to a proto or JSON field, or a synthetic field. Field names can be camelCase or snake_case. Examples: - Filter by name: name = &quot;projects/foo/locations/us-central1/deployments/dep/revisions/bar/resources/baz
orderBy: string, Field to use to sort the list.
pageSize: integer, When requesting a page of resources, &#x27;page_size&#x27; specifies number of resources to return. If unspecified, at most 500 will be returned. The maximum value is 1000.
pageToken: string, Token returned by previous call to &#x27;ListResources&#x27; which specifies the position in the list from where to continue listing the resources.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A response to a &#x27;ListResources&#x27; call. Contains a list of Resources.
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token to request the next page of resources from the &#x27;ListResources&#x27; method. The value of an empty string means that there are no more resources to return.
&quot;resources&quot;: [ # List of Resources.
{ # Resource represents a Google Cloud Platform resource actuated by IM. Resources are child resources of Revisions.
&quot;caiAssets&quot;: { # Output only. Map of Cloud Asset Inventory (CAI) type to CAI info (e.g. CAI ID). CAI type format follows https://cloud.google.com/asset-inventory/docs/supported-asset-types
&quot;a_key&quot;: { # CAI info of a Resource.
&quot;fullResourceName&quot;: &quot;A String&quot;, # CAI resource name in the format following https://cloud.google.com/apis/design/resource_names#full_resource_name
},
},
&quot;intent&quot;: &quot;A String&quot;, # Output only. Intent of the resource.
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name. Format: `projects/{project}/locations/{location}/deployments/{deployment}/revisions/{revision}/resources/{resource}`
&quot;state&quot;: &quot;A String&quot;, # Output only. Current state of the resource.
&quot;terraformInfo&quot;: { # Terraform info of a Resource. # Output only. Terraform-specific info if this resource was created using Terraform.
&quot;address&quot;: &quot;A String&quot;, # TF resource address that uniquely identifies this resource within this deployment.
&quot;id&quot;: &quot;A String&quot;, # ID attribute of the TF resource
&quot;type&quot;: &quot;A String&quot;, # TF resource type
},
},
],
&quot;unreachable&quot;: [ # Locations that could not be reached.
&quot;A String&quot;,
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>