blob: cfb73694112ec86bc7d0c8d8bc58fb04cf30a720 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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="cloudidentity_v1.html">Cloud Identity API</a> . <a href="cloudidentity_v1.groups.html">groups</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="cloudidentity_v1.groups.memberships.html">memberships()</a></code>
79</p>
80<p class="firstline">Returns the memberships Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070083 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
86 <code><a href="#create">create(body=None, initialGroupConfig=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070087<p class="firstline">Creates a Group.</p>
88<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070090<p class="firstline">Deletes a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="toc_element">
92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070093<p class="firstline">Retrieves a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080095 <code><a href="#list">list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)</a></code></p>
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -070096<p class="firstline">Lists the `Group` resources under a customer or namespace.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070097<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800101 <code><a href="#lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700102<p class="firstline">Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700103<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700104 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700105<p class="firstline">Updates a `Group`.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700106<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800107 <code><a href="#search">search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)</a></code></p>
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700108<p class="firstline">Searches for `Group` resources matching a specified query.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700109<p class="toc_element">
110 <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p>
111<p class="firstline">Retrieves the next page of results.</p>
112<h3>Method Details</h3>
113<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700114 <code class="details" id="close">close()</code>
115 <pre>Close httplib2 connections.</pre>
116</div>
117
118<div class="method">
119 <code class="details" id="create">create(body=None, initialGroupConfig=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700120 <pre>Creates a Group.
121
122Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700123 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700124 The object takes the form of:
125
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700126{ # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800127 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800128 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
129 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800130 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
131 &quot;queries&quot;: [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
132 { # Defines a query on a resource.
133 &quot;query&quot;: &quot;A String&quot;, # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department==&#x27;engineering&#x27;)` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area==&#x27;foo&#x27; &amp;&amp; loc.building_id==&#x27;bar&#x27;)`
134 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
135 },
136 ],
137 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
138 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
139 &quot;statusTime&quot;: &quot;A String&quot;, # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created.
140 },
141 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800142 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the `Group`.
143 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700144 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800145 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700146 &quot;labels&quot;: { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800147 &quot;a_key&quot;: &quot;A String&quot;,
148 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800149 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700150 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800151 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800152}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700153
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700154 initialGroupConfig: string, Optional. The initial configuration option for the `Group`.
155 Allowed values
156 INITIAL_GROUP_CONFIG_UNSPECIFIED - Default. Should not be used.
157 WITH_INITIAL_OWNER - The end user making the request will be added as the initial owner of the `Group`.
158 EMPTY - An empty group is created without any initial owners. This can only be used by admins of the domain.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700159 x__xgafv: string, V1 error format.
160 Allowed values
161 1 - v1 error format
162 2 - v2 error format
163
164Returns:
165 An object of the form:
166
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700167 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800168 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
169 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
170 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
171 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
172 {
173 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
174 },
175 ],
176 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
177 },
178 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
179 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
180 },
181 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
182 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
183 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
184 },
185}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700186</div>
187
188<div class="method">
189 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700190 <pre>Deletes a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700191
192Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700193 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700194 x__xgafv: string, V1 error format.
195 Allowed values
196 1 - v1 error format
197 2 - v2 error format
198
199Returns:
200 An object of the form:
201
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700202 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800203 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
204 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
205 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
206 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
207 {
208 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
209 },
210 ],
211 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
212 },
213 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
214 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
215 },
216 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
217 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
218 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
219 },
220}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700221</div>
222
223<div class="method">
224 <code class="details" id="get">get(name, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700225 <pre>Retrieves a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700226
227Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700228 name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group` to retrieve. Must be of the form `groups/{group_id}`. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700229 x__xgafv: string, V1 error format.
230 Allowed values
231 1 - v1 error format
232 2 - v2 error format
233
234Returns:
235 An object of the form:
236
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700237 { # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800238 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
239 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
240 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800241 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
242 &quot;queries&quot;: [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
243 { # Defines a query on a resource.
244 &quot;query&quot;: &quot;A String&quot;, # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department==&#x27;engineering&#x27;)` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area==&#x27;foo&#x27; &amp;&amp; loc.building_id==&#x27;bar&#x27;)`
245 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
246 },
247 ],
248 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
249 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
250 &quot;statusTime&quot;: &quot;A String&quot;, # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created.
251 },
252 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800253 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the `Group`.
254 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700255 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800256 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700257 &quot;labels&quot;: { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800258 &quot;a_key&quot;: &quot;A String&quot;,
259 },
260 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700261 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800262 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
263}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700264</div>
265
266<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800267 <code class="details" id="list">list(pageSize=None, pageToken=None, parent=None, view=None, x__xgafv=None)</code>
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700268 <pre>Lists the `Group` resources under a customer or namespace.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700269
270Args:
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800271 pageSize: integer, The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `View.BASIC` and to 50 for `View.FULL`. Must not be greater than 1000 for `View.BASIC` or 500 for `View.FULL`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800272 pageToken: string, The `next_page_token` value returned from a previous list request, if any.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700273 parent: string, Required. The parent resource under which to list all `Group` resources. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700274 view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700275 Allowed values
276 VIEW_UNSPECIFIED - Default. Should not be used.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700277 BASIC - Only basic resource information is returned.
278 FULL - All resource information is returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700279 x__xgafv: string, V1 error format.
280 Allowed values
281 1 - v1 error format
282 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700283
284Returns:
285 An object of the form:
286
287 { # Response message for ListGroups operation.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800288 &quot;groups&quot;: [ # Groups returned in response to list request. The results are not sorted.
289 { # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.
290 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
291 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
292 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800293 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
294 &quot;queries&quot;: [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
295 { # Defines a query on a resource.
296 &quot;query&quot;: &quot;A String&quot;, # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department==&#x27;engineering&#x27;)` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area==&#x27;foo&#x27; &amp;&amp; loc.building_id==&#x27;bar&#x27;)`
297 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
298 },
299 ],
300 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
301 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
302 &quot;statusTime&quot;: &quot;A String&quot;, # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created.
303 },
304 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800305 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the `Group`.
306 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700307 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800308 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700309 &quot;labels&quot;: { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800310 &quot;a_key&quot;: &quot;A String&quot;,
311 },
312 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700313 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800314 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
315 },
316 ],
317 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results available for listing.
318}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700319</div>
320
321<div class="method">
322 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
323 <pre>Retrieves the next page of results.
324
325Args:
326 previous_request: The request for the previous page. (required)
327 previous_response: The response from the request for the previous page. (required)
328
329Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700330 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700331 page. Returns None if there are no more items in the collection.
332 </pre>
333</div>
334
335<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800336 <code class="details" id="lookup">lookup(groupKey_id=None, groupKey_namespace=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700337 <pre>Looks up the [resource name](https://cloud.google.com/apis/design/resource_names) of a `Group` by its `EntityKey`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700338
339Args:
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800340 groupKey_id: string, The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700341 groupKey_namespace: string, The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700342 x__xgafv: string, V1 error format.
343 Allowed values
344 1 - v1 error format
345 2 - v2 error format
346
347Returns:
348 An object of the form:
349
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700350 { # The response message for GroupsService.LookupGroupName.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800351 &quot;name&quot;: &quot;A String&quot;, # The [resource name](https://cloud.google.com/apis/design/resource_names) of the looked-up `Group`.
352}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700353</div>
354
355<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700356 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700357 <pre>Updates a `Group`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700358
359Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700360 name: string, Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700361 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700362 The object takes the form of:
363
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700364{ # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800365 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800366 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
367 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800368 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
369 &quot;queries&quot;: [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
370 { # Defines a query on a resource.
371 &quot;query&quot;: &quot;A String&quot;, # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department==&#x27;engineering&#x27;)` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area==&#x27;foo&#x27; &amp;&amp; loc.building_id==&#x27;bar&#x27;)`
372 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
373 },
374 ],
375 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
376 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
377 &quot;statusTime&quot;: &quot;A String&quot;, # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created.
378 },
379 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800380 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the `Group`.
381 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700382 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800383 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700384 &quot;labels&quot;: { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800385 &quot;a_key&quot;: &quot;A String&quot;,
386 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800387 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700388 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800389 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800390}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700391
yoshi-code-bota933dad2021-07-06 00:26:24 -0700392 updateMask: string, Required. The names of fields to update. May only contain the following fields: `display_name`, `description`, `labels`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700393 x__xgafv: string, V1 error format.
394 Allowed values
395 1 - v1 error format
396 2 - v2 error format
397
398Returns:
399 An object of the form:
400
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700401 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800402 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
403 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
404 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
405 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
406 {
407 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
408 },
409 ],
410 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
411 },
412 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
413 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
414 },
415 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
416 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
417 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
418 },
419}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700420</div>
421
422<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800423 <code class="details" id="search">search(pageSize=None, pageToken=None, query=None, view=None, x__xgafv=None)</code>
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700424 <pre>Searches for `Group` resources matching a specified query.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700425
426Args:
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800427 pageSize: integer, The maximum number of results to return. Note that the number of results returned may be less than this value even if there are more available results. To fetch all results, clients must continue calling this method repeatedly until the response no longer contains a `next_page_token`. If unspecified, defaults to 200 for `GroupView.BASIC` and 50 for `GroupView.FULL`. Must not be greater than 1000 for `GroupView.BASIC` or 500 for `GroupView.FULL`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800428 pageToken: string, The `next_page_token` value returned from a previous search request, if any.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700429 query: string, Required. The search query. Must be specified in [Common Expression Language](https://opensource.google/projects/cel). May only contain equality operators on the parent and inclusion operators on labels (e.g., `parent == &#x27;customers/{customer_id}&#x27; &amp;&amp; &#x27;cloudidentity.googleapis.com/groups.discussion_forum&#x27; in labels`). The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700430 view: string, The level of detail to be returned. If unspecified, defaults to `View.BASIC`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700431 Allowed values
432 VIEW_UNSPECIFIED - Default. Should not be used.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700433 BASIC - Only basic resource information is returned.
434 FULL - All resource information is returned.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700435 x__xgafv: string, V1 error format.
436 Allowed values
437 1 - v1 error format
438 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700439
440Returns:
441 An object of the form:
442
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700443 { # The response message for GroupsService.SearchGroups.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700444 &quot;groups&quot;: [ # The `Group` resources that match the search query.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800445 { # A group within the Cloud Identity Groups API. A `Group` is a collection of entities, where each entity is either a user, another group, or a service account.
446 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was created.
447 &quot;description&quot;: &quot;A String&quot;, # An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters.
448 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the `Group`.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800449 &quot;dynamicGroupMetadata&quot;: { # Dynamic group metadata like queries and status. # Optional. Dynamic group metadata like queries and status.
450 &quot;queries&quot;: [ # Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
451 { # Defines a query on a resource.
452 &quot;query&quot;: &quot;A String&quot;, # Query that determines the memberships of the dynamic group. Examples: All users with at least one `organizations.department` of engineering. `user.organizations.exists(org, org.department==&#x27;engineering&#x27;)` All users with at least one location that has `area` of `foo` and `building_id` of `bar`. `user.locations.exists(loc, loc.area==&#x27;foo&#x27; &amp;&amp; loc.building_id==&#x27;bar&#x27;)`
453 &quot;resourceType&quot;: &quot;A String&quot;, # Resource type for the Dynamic Group Query
454 },
455 ],
456 &quot;status&quot;: { # The current status of a dynamic group along with timestamp. # Output only. Status of the dynamic group.
457 &quot;status&quot;: &quot;A String&quot;, # Status of the dynamic group.
458 &quot;statusTime&quot;: &quot;A String&quot;, # The latest time at which the dynamic group is guaranteed to be in the given status. If status is `UP_TO_DATE`, the latest time at which the dynamic group was confirmed to be up-to-date. If status is `UPDATING_MEMBERSHIPS`, the time at which dynamic group was created.
459 },
460 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800461 &quot;groupKey&quot;: { # A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. # Required. Immutable. The `EntityKey` of the `Group`.
462 &quot;id&quot;: &quot;A String&quot;, # The ID of the entity. For Google-managed entities, the `id` should be the email address of an existing group or user. For external-identity-mapped entities, the `id` must be a string conforming to the Identity Source&#x27;s requirements. Must be unique within a `namespace`.
yoshi-code-bot04bafe12021-06-29 00:20:25 -0700463 &quot;namespace&quot;: &quot;A String&quot;, # The namespace in which the entity exists. If not specified, the `EntityKey` represents a Google-managed entity such as a Google user or a Google Group. If specified, the `EntityKey` represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of `identitysources/{identity_source_id}`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800464 },
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700465 &quot;labels&quot;: { # Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800466 &quot;a_key&quot;: &quot;A String&quot;,
467 },
468 &quot;name&quot;: &quot;A String&quot;, # Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group_id}`.
yoshi-code-botbfa2f1c2021-05-08 07:21:27 -0700469 &quot;parent&quot;: &quot;A String&quot;, # Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source_id}` for external- identity-mapped groups or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with &quot;C&quot; (for example, &#x27;C046psxkn&#x27;).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800470 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the `Group` was last updated.
471 },
472 ],
473 &quot;nextPageToken&quot;: &quot;A String&quot;, # A continuation token to retrieve the next page of results, or empty if there are no more results available.
474}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700475</div>
476
477<div class="method">
478 <code class="details" id="search_next">search_next(previous_request, previous_response)</code>
479 <pre>Retrieves the next page of results.
480
481Args:
482 previous_request: The request for the previous page. (required)
483 previous_response: The response from the request for the previous page. (required)
484
485Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700486 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700487 page. Returns None if there are no more items in the collection.
488 </pre>
489</div>
490
491</body></html>