blob: 6e766236a936211f1befec627641bf1654bdf52a [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="apphub_v1.html">App Hub API</a> . <a href="apphub_v1.projects.html">projects</a> . <a href="apphub_v1.projects.locations.html">locations</a> . <a href="apphub_v1.projects.locations.discoveredWorkloads.html">discoveredWorkloads</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 a Discovered Workload in a host project and location.</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 Discovered Workloads that can be added to an Application in a host project and location.</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>
<p class="toc_element">
<code><a href="#lookup">lookup(parent, uri=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists a Discovered Workload in a host project and location, with a given resource URI.</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 a Discovered Workload in a host project and location.
Args:
name: string, Required. Fully qualified name of the Discovered Workload to fetch. Expected format: `projects/{project}/locations/{location}/discoveredWorkloads/{discoveredWorkload}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the discovered workload. Format: `&quot;projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}&quot;`
&quot;workloadProperties&quot;: { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
&quot;functionalType&quot;: { # The functional type of a service or workload. # Output only. The type of the workload.
&quot;type&quot;: &quot;A String&quot;, # Output only. The functional type of a service or workload.
},
&quot;gcpProject&quot;: &quot;A String&quot;, # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
&quot;location&quot;: &quot;A String&quot;, # Output only. The location that the underlying compute resource resides in (for example, us-west1).
&quot;zone&quot;: &quot;A String&quot;, # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
},
&quot;workloadReference&quot;: { # Reference of an underlying compute resource represented by the Workload. # Output only. Reference of an underlying compute resource represented by the Workload. These are immutable.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The underlying compute resource uri.
},
}</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 Discovered Workloads that can be added to an Application in a host project and location.
Args:
parent: string, Required. Project and location to list Discovered Workloads on. Expected format: `projects/{project}/locations/{location}`. (required)
filter: string, Optional. Filtering results.
orderBy: string, Optional. Hint for how to order the results.
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListDiscoveredWorkloads.
&quot;discoveredWorkloads&quot;: [ # List of Discovered Workloads.
{ # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the discovered workload. Format: `&quot;projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}&quot;`
&quot;workloadProperties&quot;: { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
&quot;functionalType&quot;: { # The functional type of a service or workload. # Output only. The type of the workload.
&quot;type&quot;: &quot;A String&quot;, # Output only. The functional type of a service or workload.
},
&quot;gcpProject&quot;: &quot;A String&quot;, # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
&quot;location&quot;: &quot;A String&quot;, # Output only. The location that the underlying compute resource resides in (for example, us-west1).
&quot;zone&quot;: &quot;A String&quot;, # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
},
&quot;workloadReference&quot;: { # Reference of an underlying compute resource represented by the Workload. # Output only. Reference of an underlying compute resource represented by the Workload. These are immutable.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The underlying compute resource uri.
},
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
&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>
<div class="method">
<code class="details" id="lookup">lookup(parent, uri=None, x__xgafv=None)</code>
<pre>Lists a Discovered Workload in a host project and location, with a given resource URI.
Args:
parent: string, Required. Host project ID and location to lookup Discovered Workload in. Expected format: `projects/{project}/locations/{location}`. (required)
uri: string, Required. Resource URI to find Discovered Workload for. Accepts both project number and project ID and does translation when needed.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for LookupDiscoveredWorkload.
&quot;discoveredWorkload&quot;: { # DiscoveredWorkload is a binary deployment (such as managed instance groups (MIGs) and GKE deployments) that performs the smallest logical subset of business functionality. A discovered workload can be registered to an App Hub Workload. # Discovered Workload if exists, empty otherwise.
&quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the discovered workload. Format: `&quot;projects/{host-project-id}/locations/{location}/discoveredWorkloads/{uuid}&quot;`
&quot;workloadProperties&quot;: { # Properties of an underlying compute resource represented by the Workload. # Output only. Properties of an underlying compute resource represented by the Workload. These are immutable.
&quot;functionalType&quot;: { # The functional type of a service or workload. # Output only. The type of the workload.
&quot;type&quot;: &quot;A String&quot;, # Output only. The functional type of a service or workload.
},
&quot;gcpProject&quot;: &quot;A String&quot;, # Output only. The service project identifier that the underlying cloud resource resides in. Empty for non-cloud resources.
&quot;location&quot;: &quot;A String&quot;, # Output only. The location that the underlying compute resource resides in (for example, us-west1).
&quot;zone&quot;: &quot;A String&quot;, # Output only. The location that the underlying compute resource resides in if it is zonal (for example, us-west1-a).
},
&quot;workloadReference&quot;: { # Reference of an underlying compute resource represented by the Workload. # Output only. Reference of an underlying compute resource represented by the Workload. These are immutable.
&quot;uri&quot;: &quot;A String&quot;, # Output only. The underlying compute resource uri.
},
},
}</pre>
</div>
</body></html>