Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / serviceconsumermanagement_v1.services.html
blob: aaa35bf932239ed84bf08ac9dc6fd2ba05d35eef [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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="serviceconsumermanagement_v1.html">Service Consumer Management API</a> . <a href="serviceconsumermanagement_v1.services.html">services</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="serviceconsumermanagement_v1.services.tenancyUnits.html">tenancyUnits()</a></code>
79</p>
80<p class="firstline">Returns the tenancyUnits Resource.</p>
81
82<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]83 <code><a href="#search">search(parent, query=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84<p class="firstline">Search tenancy units for a managed service.</p>
85<p class="toc_element">
86 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
87<p class="firstline">Retrieves the next page of results.</p>
88<h3>Method Details</h3>
89<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90 <code class="details" id="search">search(parent, query=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91 <pre>Search tenancy units for a managed service.
92
93Args:
94 parent: string, Service for which search is performed.
95services/{service}
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]96{service} the name of a service, for example &#x27;service.googleapis.com&#x27;. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]97 query: string, Optional. Set a query `{expression}` for querying tenancy units. Your `{expression}`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98must be in the format: `field_name=literal_string`. The `field_name` is the
99name of the field you want to compare. Supported fields are
100`tenant_resources.tag` and `tenant_resources.resource`.
101
102For example, to search tenancy units that contain at least one tenant
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]103resource with a given tag &#x27;xyz&#x27;, use the query `tenant_resources.tag=xyz`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104To search tenancy units that contain at least one tenant resource with
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105a given resource name &#x27;projects/123456&#x27;, use the query
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106`tenant_resources.resource=projects/123456`.
107
108Multiple expressions can be joined with `AND`s. Tenancy units must match
109all expressions to be included in the result set. For example,
110`tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456`
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]111 pageToken: string, Optional. The continuation token, which is used to page through large result sets.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]112To get the next page of results, set this parameter to the value of
113`nextPageToken` from the previous response.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]114 pageSize: integer, Optional. The maximum number of results returned by this request. Currently, the
115default maximum is set to 1000. If `page_size` isn&#x27;t provided or the size
116provided is a number larger than 1000, it&#x27;s automatically set to 1000.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121
122Returns:
123 An object of the form:
124
125 { # Response for the search query.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]126 &quot;tenancyUnits&quot;: [ # Tenancy Units matching the request.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 { # Representation of a tenancy unit.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]128 &quot;consumer&quot;: &quot;A String&quot;, # @OutputOnly Cloud resource name of the consumer of this service.
129 # For example &#x27;projects/123456&#x27;.
130 &quot;createTime&quot;: &quot;A String&quot;, # @OutputOnly The time this tenancy unit was created.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]131 &quot;tenantResources&quot;: [ # Resources constituting the tenancy unit.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 # There can be at most 512 tenant resources in a tenancy unit.
133 { # Resource constituting the TenancyUnit.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]134 &quot;status&quot;: &quot;A String&quot;, # Status of tenant resource.
135 &quot;tag&quot;: &quot;A String&quot;, # Unique per single tenancy unit.
136 &quot;resource&quot;: &quot;A String&quot;, # @OutputOnly Identifier of the tenant resource.
137 # For cloud projects, it is in the form &#x27;projects/{number}&#x27;.
138 # For example &#x27;projects/123456&#x27;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139 },
140 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]141 &quot;service&quot;: &quot;A String&quot;, # Output only. Google Cloud API name of the managed service owning this
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]142 # tenancy unit.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 # For example &#x27;serviceconsumermanagement.googleapis.com&#x27;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]144 &quot;name&quot;: &quot;A String&quot;, # Globally unique identifier of this tenancy unit
145 # &quot;services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 },
147 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]148 &quot;nextPageToken&quot;: &quot;A String&quot;, # Pagination token for large results.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
154 <pre>Retrieves the next page of results.
155
156Args:
157 previous_request: The request for the previous page. (required)
158 previous_response: The response from the request for the previous page. (required)
159
160Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 page. Returns None if there are no more items in the collection.
163 </pre>
164</div>
165
166</body></html>