Debian Codegraph @

docs/dyn/apphub_v1.projects.locations.discoveredServices.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <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.discoveredServices.html">discoveredServices</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82 <p class="firstline">Gets a Discovered Service in a host project and location.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Lists Discovered Services that can be added to an Application in a host project and location.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <p class="toc_element">
90 <code><a href="#lookup">lookup(parent, uri=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists a Discovered Service in a host project and location, with a given resource URI.</p>
92 <h3>Method Details</h3>
93 <div class="method">
94 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96 </div>
97
98 <div class="method">
99 <code class="details" id="get">get(name, x__xgafv=None)</code>
100 <pre>Gets a Discovered Service in a host project and location.
101
102 Args:
103 name: string, Required. Fully qualified name of the Discovered Service to fetch. Expected format: `projects/{project}/locations/{location}/discoveredServices/{discoveredService}`. (required)
104 x__xgafv: string, V1 error format.
105 Allowed values
106 1 - v1 error format
107 2 - v2 error format
108
109 Returns:
110 An object of the form:
111
112 { # DiscoveredService is a network or API interface that exposes some functionality to clients for consumption over the network. A discovered service can be registered to a App Hub service.
113 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the discovered service. Format: `&quot;projects/{host-project-id}/locations/{location}/discoveredServices/{uuid}&quot;`
114 &quot;serviceProperties&quot;: { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
115 &quot;extendedMetadata&quot;: { # Output only. Additional metadata specific to the resource type. The key is a string that identifies the type of metadata and the value is the metadata contents specific to that type. Key format: `apphub.googleapis.com/{metadataType}`
116 &quot;a_key&quot;: { # Additional metadata for a Service or Workload.
117 &quot;metadataStruct&quot;: { # Output only. The metadata contents.
118 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
119 },
120 },
121 },
122 &quot;functionalType&quot;: { # The functional type of a service or workload. # Output only. The type of the service.
123 &quot;type&quot;: &quot;A String&quot;, # Output only. The functional type of a service or workload.
124 },
125 &quot;gcpProject&quot;: &quot;A String&quot;, # Output only. The service project identifier that the underlying cloud resource resides in.
126 &quot;identity&quot;: { # The identity associated with a service or workload. # Output only. The identity associated with the service.
127 &quot;principal&quot;: &quot;A String&quot;, # Output only. The principal of the identity. Supported formats: * `sa://my-sa@PROJECT_ID.iam.gserviceaccount.com` for GCP Service Account * `principal://POOL_ID.global.PROJECT_NUMBER.workload.id.goog/ns/NAMESPACE_ID/sa/MANAGED_IDENTITY_ID` for Managed Workload Identity
128 },
129 &quot;location&quot;: &quot;A String&quot;, # Output only. The location that the underlying resource resides in, for example, us-west1.
130 &quot;registrationType&quot;: { # The registration type of a service. # Output only. The registration type of the service.
131 &quot;type&quot;: &quot;A String&quot;, # Output only. The registration type of a service.
132 },
133 &quot;zone&quot;: &quot;A String&quot;, # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
134 },
135 &quot;serviceReference&quot;: { # Reference to an underlying networking resource that can comprise a Service. # Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.
136 &quot;uri&quot;: &quot;A String&quot;, # Output only. The underlying resource URI. For example, URI of Forwarding Rule, URL Map, and Backend Service.
137 },
138 }</pre>
139 </div>
140
141 <div class="method">
142 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
143 <pre>Lists Discovered Services that can be added to an Application in a host project and location.
144
145 Args:
146 parent: string, Required. Project and location to list Discovered Services on. Expected format: `projects/{project}/locations/{location}`. (required)
147 filter: string, Optional. Filtering results.
148 orderBy: string, Optional. Hint for how to order the results.
149 pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
150 pageToken: string, Optional. A token identifying a page of results the server should return.
151 x__xgafv: string, V1 error format.
152 Allowed values
153 1 - v1 error format
154 2 - v2 error format
155
156 Returns:
157 An object of the form:
158
159 { # Response for ListDiscoveredServices.
160 &quot;discoveredServices&quot;: [ # List of Discovered Services.
161 { # DiscoveredService is a network or API interface that exposes some functionality to clients for consumption over the network. A discovered service can be registered to a App Hub service.
162 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the discovered service. Format: `&quot;projects/{host-project-id}/locations/{location}/discoveredServices/{uuid}&quot;`
163 &quot;serviceProperties&quot;: { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
164 &quot;extendedMetadata&quot;: { # Output only. Additional metadata specific to the resource type. The key is a string that identifies the type of metadata and the value is the metadata contents specific to that type. Key format: `apphub.googleapis.com/{metadataType}`
165 &quot;a_key&quot;: { # Additional metadata for a Service or Workload.
166 &quot;metadataStruct&quot;: { # Output only. The metadata contents.
167 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
168 },
169 },
170 },
171 &quot;functionalType&quot;: { # The functional type of a service or workload. # Output only. The type of the service.
172 &quot;type&quot;: &quot;A String&quot;, # Output only. The functional type of a service or workload.
173 },
174 &quot;gcpProject&quot;: &quot;A String&quot;, # Output only. The service project identifier that the underlying cloud resource resides in.
175 &quot;identity&quot;: { # The identity associated with a service or workload. # Output only. The identity associated with the service.
176 &quot;principal&quot;: &quot;A String&quot;, # Output only. The principal of the identity. Supported formats: * `sa://my-sa@PROJECT_ID.iam.gserviceaccount.com` for GCP Service Account * `principal://POOL_ID.global.PROJECT_NUMBER.workload.id.goog/ns/NAMESPACE_ID/sa/MANAGED_IDENTITY_ID` for Managed Workload Identity
177 },
178 &quot;location&quot;: &quot;A String&quot;, # Output only. The location that the underlying resource resides in, for example, us-west1.
179 &quot;registrationType&quot;: { # The registration type of a service. # Output only. The registration type of the service.
180 &quot;type&quot;: &quot;A String&quot;, # Output only. The registration type of a service.
181 },
182 &quot;zone&quot;: &quot;A String&quot;, # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
183 },
184 &quot;serviceReference&quot;: { # Reference to an underlying networking resource that can comprise a Service. # Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.
185 &quot;uri&quot;: &quot;A String&quot;, # Output only. The underlying resource URI. For example, URI of Forwarding Rule, URL Map, and Backend Service.
186 },
187 },
188 ],
189 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token identifying a page of results the server should return.
190 &quot;unreachable&quot;: [ # Locations that could not be reached.
191 &quot;A String&quot;,
192 ],
193 }</pre>
194 </div>
195
196 <div class="method">
197 <code class="details" id="list_next">list_next()</code>
198 <pre>Retrieves the next page of results.
199
200 Args:
201 previous_request: The request for the previous page. (required)
202 previous_response: The response from the request for the previous page. (required)
203
204 Returns:
205 A request object that you can call &#x27;execute()&#x27; on to request the next
206 page. Returns None if there are no more items in the collection.
207 </pre>
208 </div>
209
210 <div class="method">
211 <code class="details" id="lookup">lookup(parent, uri=None, x__xgafv=None)</code>
212 <pre>Lists a Discovered Service in a host project and location, with a given resource URI.
213
214 Args:
215 parent: string, Required. Host project ID and location to lookup Discovered Service in. Expected format: `projects/{project}/locations/{location}`. (required)
216 uri: string, Required. Resource URI to find DiscoveredService for. Accepts both project number and project ID and does translation when needed.
217 x__xgafv: string, V1 error format.
218 Allowed values
219 1 - v1 error format
220 2 - v2 error format
221
222 Returns:
223 An object of the form:
224
225 { # Response for LookupDiscoveredService.
226 &quot;discoveredService&quot;: { # DiscoveredService is a network or API interface that exposes some functionality to clients for consumption over the network. A discovered service can be registered to a App Hub service. # Discovered Service if exists, empty otherwise.
227 &quot;name&quot;: &quot;A String&quot;, # Identifier. The resource name of the discovered service. Format: `&quot;projects/{host-project-id}/locations/{location}/discoveredServices/{uuid}&quot;`
228 &quot;serviceProperties&quot;: { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
229 &quot;extendedMetadata&quot;: { # Output only. Additional metadata specific to the resource type. The key is a string that identifies the type of metadata and the value is the metadata contents specific to that type. Key format: `apphub.googleapis.com/{metadataType}`
230 &quot;a_key&quot;: { # Additional metadata for a Service or Workload.
231 &quot;metadataStruct&quot;: { # Output only. The metadata contents.
232 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
233 },
234 },
235 },
236 &quot;functionalType&quot;: { # The functional type of a service or workload. # Output only. The type of the service.
237 &quot;type&quot;: &quot;A String&quot;, # Output only. The functional type of a service or workload.
238 },
239 &quot;gcpProject&quot;: &quot;A String&quot;, # Output only. The service project identifier that the underlying cloud resource resides in.
240 &quot;identity&quot;: { # The identity associated with a service or workload. # Output only. The identity associated with the service.
241 &quot;principal&quot;: &quot;A String&quot;, # Output only. The principal of the identity. Supported formats: * `sa://my-sa@PROJECT_ID.iam.gserviceaccount.com` for GCP Service Account * `principal://POOL_ID.global.PROJECT_NUMBER.workload.id.goog/ns/NAMESPACE_ID/sa/MANAGED_IDENTITY_ID` for Managed Workload Identity
242 },
243 &quot;location&quot;: &quot;A String&quot;, # Output only. The location that the underlying resource resides in, for example, us-west1.
244 &quot;registrationType&quot;: { # The registration type of a service. # Output only. The registration type of the service.
245 &quot;type&quot;: &quot;A String&quot;, # Output only. The registration type of a service.
246 },
247 &quot;zone&quot;: &quot;A String&quot;, # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
248 },
249 &quot;serviceReference&quot;: { # Reference to an underlying networking resource that can comprise a Service. # Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.
250 &quot;uri&quot;: &quot;A String&quot;, # Output only. The underlying resource URI. For example, URI of Forwarding Rule, URL Map, and Backend Service.
251 },
252 },
253 }</pre>
254 </div>
255
256 </body></html>