blob: 0aa52dbdc14c60da02ec081032b533fdec8e3dce [file] [log] [blame]
Bu Sun Kimd059ad82020-07-22 17:02:09 -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="gameservices_v1.html">Game Services API</a> . <a href="gameservices_v1.projects.html">projects</a> . <a href="gameservices_v1.projects.locations.html">locations</a> . <a href="gameservices_v1.projects.locations.gameServerDeployments.html">gameServerDeployments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="gameservices_v1.projects.locations.gameServerDeployments.configs.html">configs()</a></code>
79</p>
80<p class="firstline">Returns the configs 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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070086 <code><a href="#create">create(parent, body=None, deploymentId=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Creates a new game server deployment in a given project and location.</p>
88<p class="toc_element">
89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Deletes a single game server deployment.</p>
91<p class="toc_element">
92 <code><a href="#fetchDeploymentState">fetchDeploymentState(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070093<p class="firstline">Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070094<p class="toc_element">
95 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
96<p class="firstline">Gets details of a single game server deployment.</p>
97<p class="toc_element">
98 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070099<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700100<p class="toc_element">
101 <code><a href="#getRollout">getRollout(name, x__xgafv=None)</a></code></p>
102<p class="firstline">Gets details a single game server deployment rollout.</p>
103<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800104 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700105<p class="firstline">Lists game server deployments in a given project and location.</p>
106<p class="toc_element">
107 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
108<p class="firstline">Retrieves the next page of results.</p>
109<p class="toc_element">
110 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
111<p class="firstline">Patches a game server deployment.</p>
112<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800113 <code><a href="#previewRollout">previewRollout(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700114<p class="firstline">Previews the game server deployment rollout. This API does not mutate the rollout resource.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700115<p class="toc_element">
116 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700117<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700118<p class="toc_element">
119 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700120<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700121<p class="toc_element">
122 <code><a href="#updateRollout">updateRollout(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700123<p class="firstline">Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700124<h3>Method Details</h3>
125<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700126 <code class="details" id="close">close()</code>
127 <pre>Close httplib2 connections.</pre>
128</div>
129
130<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700131 <code class="details" id="create">create(parent, body=None, deploymentId=None, x__xgafv=None)</code>
132 <pre>Creates a new game server deployment in a given project and location.
133
134Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700135 parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700136 body: object, The request body.
137 The object takes the form of:
138
139{ # A game server deployment resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800140 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
141 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the game server delpoyment.
142 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
143 &quot;labels&quot;: { # The labels associated with this game server deployment. Each label is a key-value pair.
144 &quot;a_key&quot;: &quot;A String&quot;,
145 },
146 &quot;name&quot;: &quot;A String&quot;, # The resource name of the game server deployment, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment`.
147 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
148}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700149
150 deploymentId: string, Required. The ID of the game server delpoyment resource to be created.
151 x__xgafv: string, V1 error format.
152 Allowed values
153 1 - v1 error format
154 2 - v2 error format
155
156Returns:
157 An object of the form:
158
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700159 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800160 &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.
161 &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.
162 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
163 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
164 {
165 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
166 },
167 ],
168 &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.
169 },
170 &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.
171 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
172 },
173 &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}`.
174 &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`.
175 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
176 },
177}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700178</div>
179
180<div class="method">
181 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
182 <pre>Deletes a single game server deployment.
183
184Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700185 name: string, Required. The name of the game server delpoyment to delete, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700186 x__xgafv: string, V1 error format.
187 Allowed values
188 1 - v1 error format
189 2 - v2 error format
190
191Returns:
192 An object of the form:
193
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700194 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800195 &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.
196 &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.
197 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
198 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
199 {
200 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
201 },
202 ],
203 &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.
204 },
205 &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.
206 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
207 },
208 &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}`.
209 &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`.
210 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
211 },
212}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700213</div>
214
215<div class="method">
216 <code class="details" id="fetchDeploymentState">fetchDeploymentState(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700217 <pre>Retrieves information about the current state of the game server deployment. Gathers all the Agones fleets and Agones autoscalers, including fleets running an older version of the game server deployment.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700218
219Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700220 name: string, Required. The name of the game server delpoyment, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700221 body: object, The request body.
222 The object takes the form of:
223
224{ # Request message for GameServerDeploymentsService.FetchDeploymentState.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800225}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700226
227 x__xgafv: string, V1 error format.
228 Allowed values
229 1 - v1 error format
230 2 - v2 error format
231
232Returns:
233 An object of the form:
234
235 { # Response message for GameServerDeploymentsService.FetchDeploymentState.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800236 &quot;clusterState&quot;: [ # The state of the game server deployment in each game server cluster.
237 { # The game server cluster changes made by the game server deployment.
238 &quot;cluster&quot;: &quot;A String&quot;, # The name of the cluster.
239 &quot;fleetDetails&quot;: [ # The details about the Agones fleets and autoscalers created in the game server cluster.
240 { # Details of the deployed Agones fleet.
241 &quot;deployedAutoscaler&quot;: { # Details about the Agones autoscaler. # Information about the Agones autoscaler for that fleet.
242 &quot;autoscaler&quot;: &quot;A String&quot;, # The name of the Agones autoscaler.
243 &quot;fleetAutoscalerSpec&quot;: &quot;A String&quot;, # The autoscaler spec retrieved from Agones.
244 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # The source spec that is used to create the autoscaler. The GameServerConfig resource may no longer exist in the system.
245 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
246 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700247 },
248 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800249 &quot;deployedFleet&quot;: { # Agones fleet specification and details. # Information about the Agones fleet.
250 &quot;fleet&quot;: &quot;A String&quot;, # The name of the Agones fleet.
251 &quot;fleetSpec&quot;: &quot;A String&quot;, # The fleet spec retrieved from the Agones fleet.
252 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # The source spec that is used to create the Agones fleet. The GameServerConfig resource may no longer exist in the system.
253 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
254 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
255 },
256 &quot;status&quot;: { # DeployedFleetStatus has details about the Agones fleets such as how many are running, how many allocated, and so on. # The current status of the Agones fleet. Includes count of game servers in various states.
257 &quot;allocatedReplicas&quot;: &quot;A String&quot;, # The number of GameServer replicas in the ALLOCATED state in this fleet.
258 &quot;readyReplicas&quot;: &quot;A String&quot;, # The number of GameServer replicas in the READY state in this fleet.
259 &quot;replicas&quot;: &quot;A String&quot;, # The total number of current GameServer replicas in this fleet.
260 &quot;reservedReplicas&quot;: &quot;A String&quot;, # The number of GameServer replicas in the RESERVED state in this fleet. Reserved instances won&#x27;t be deleted on scale down, but won&#x27;t cause an autoscaler to scale up.
261 },
262 },
263 },
264 ],
265 },
266 ],
267 &quot;unavailable&quot;: [ # List of locations that could not be reached.
268 &quot;A String&quot;,
269 ],
270}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700271</div>
272
273<div class="method">
274 <code class="details" id="get">get(name, x__xgafv=None)</code>
275 <pre>Gets details of a single game server deployment.
276
277Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700278 name: string, Required. The name of the game server delpoyment to retrieve, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700279 x__xgafv: string, V1 error format.
280 Allowed values
281 1 - v1 error format
282 2 - v2 error format
283
284Returns:
285 An object of the form:
286
287 { # A game server deployment resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800288 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
289 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the game server delpoyment.
290 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
291 &quot;labels&quot;: { # The labels associated with this game server deployment. Each label is a key-value pair.
292 &quot;a_key&quot;: &quot;A String&quot;,
293 },
294 &quot;name&quot;: &quot;A String&quot;, # The resource name of the game server deployment, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment`.
295 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
296}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700297</div>
298
299<div class="method">
300 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700301 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700302
303Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700304 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
305 options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700306 x__xgafv: string, V1 error format.
307 Allowed values
308 1 - v1 error format
309 2 - v2 error format
310
311Returns:
312 An object of the form:
313
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700314 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800315 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
316 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
317 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
318 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
319 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
320 &quot;A String&quot;,
321 ],
322 &quot;ignoreChildExemptions&quot;: True or False,
323 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800324 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800325 ],
326 &quot;exemptedMembers&quot;: [
327 &quot;A String&quot;,
328 ],
329 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
330 },
331 ],
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700332 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
333 { # Associates `members`, or principals, with a `role`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800334 &quot;bindingId&quot;: &quot;A String&quot;,
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700335 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800336 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
337 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
338 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
339 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800340 },
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700341 &quot;members&quot;: [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800342 &quot;A String&quot;,
343 ],
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700344 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800345 },
346 ],
347 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800348 &quot;rules&quot;: [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
349 { # A rule to be applied in a Policy.
350 &quot;action&quot;: &quot;A String&quot;, # Required
351 &quot;conditions&quot;: [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
352 { # A condition to be met.
353 &quot;iam&quot;: &quot;A String&quot;, # Trusted attributes supplied by the IAM system.
354 &quot;op&quot;: &quot;A String&quot;, # An operator to apply the subject with.
355 &quot;svc&quot;: &quot;A String&quot;, # Trusted attributes discharged by the service.
356 &quot;sys&quot;: &quot;A String&quot;, # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
357 &quot;values&quot;: [ # The objects of the condition.
358 &quot;A String&quot;,
359 ],
360 },
361 ],
362 &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the rule.
363 &quot;in&quot;: [ # If one or more &#x27;in&#x27; clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
364 &quot;A String&quot;,
365 ],
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700366 &quot;logConfig&quot;: [ # The config returned to callers of CheckPolicy for any entries that match the LOG action.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800367 { # Specifies what kind of log the caller must write
368 &quot;cloudAudit&quot;: { # Write a Cloud Audit log # Cloud audit options.
369 &quot;authorizationLoggingOptions&quot;: { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
370 &quot;permissionType&quot;: &quot;A String&quot;, # The type of the permission that was checked.
371 },
372 &quot;logName&quot;: &quot;A String&quot;, # The log_name to populate in the Cloud Audit Record.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800373 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800374 &quot;counter&quot;: { # Increment a streamz counter with the specified metric and field names. Metric names should start with a &#x27;/&#x27;, generally be lowercase-only, and end in &quot;_count&quot;. Field names should not contain an initial slash. The actual exported metric names will have &quot;/iam/policy&quot; prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - &quot;authority&quot;, which is &quot;[token]&quot; if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - &quot;iam_principal&quot;, a representation of IAMContext.principal even if a token or authority selector is present; or - &quot;&quot; (empty string), resulting in a counter with no fields. Examples: counter { metric: &quot;/debug_access_count&quot; field: &quot;iam_principal&quot; } ==&gt; increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]} # Counter options.
375 &quot;customFields&quot;: [ # Custom fields.
376 { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
377 &quot;name&quot;: &quot;A String&quot;, # Name is the field name.
378 &quot;value&quot;: &quot;A String&quot;, # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
379 },
380 ],
381 &quot;field&quot;: &quot;A String&quot;, # The field value to attribute.
382 &quot;metric&quot;: &quot;A String&quot;, # The metric to update.
383 },
384 &quot;dataAccess&quot;: { # Write a Data Access (Gin) log # Data access options.
385 &quot;logMode&quot;: &quot;A String&quot;,
386 },
387 },
388 ],
389 &quot;notIn&quot;: [ # If one or more &#x27;not_in&#x27; clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. The format for in and not_in entries can be found at in the Local IAM documentation (see go/local-iam#features).
390 &quot;A String&quot;,
391 ],
392 &quot;permissions&quot;: [ # A permission is a string of form &#x27;..&#x27; (e.g., &#x27;storage.buckets.list&#x27;). A value of &#x27;*&#x27; matches all permissions, and a verb part of &#x27;*&#x27; (e.g., &#x27;storage.buckets.*&#x27;) matches all verbs.
393 &quot;A String&quot;,
394 ],
395 },
396 ],
397 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
398}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700399</div>
400
401<div class="method">
402 <code class="details" id="getRollout">getRollout(name, x__xgafv=None)</code>
403 <pre>Gets details a single game server deployment rollout.
404
405Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700406 name: string, Required. The name of the game server delpoyment to retrieve, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700407 x__xgafv: string, V1 error format.
408 Allowed values
409 1 - v1 error format
410 2 - v2 error format
411
412Returns:
413 An object of the form:
414
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700415 { # The game server deployment rollout which represents the desired rollout state.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800416 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
417 &quot;defaultGameServerConfig&quot;: &quot;A String&quot;, # The default game server config is applied to all realms unless overridden in the rollout. For example, `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`.
418 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
419 &quot;gameServerConfigOverrides&quot;: [ # Contains the game server config rollout overrides. Overrides are processed in the order they are listed. Once a match is found for a realm, the rest of the list is not processed.
420 { # A game server config override.
421 &quot;configVersion&quot;: &quot;A String&quot;, # The game server config for this override.
422 &quot;realmsSelector&quot;: { # The realm selector, used to match realm resources. # Selector for choosing applicable realms.
423 &quot;realms&quot;: [ # List of realms to match.
424 &quot;A String&quot;,
425 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800426 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800427 },
428 ],
429 &quot;name&quot;: &quot;A String&quot;, # The resource name of the game server deployment rollout, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`.
430 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
431}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700432</div>
433
434<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800435 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700436 <pre>Lists game server deployments in a given project and location.
437
438Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700439 parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`. (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800440 filter: string, Optional. The filter to apply to list results.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800441 orderBy: string, Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800442 pageSize: integer, Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response&#x27;s next_page_token to determine if there are more GameServerDeployments left to be queried.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800443 pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700444 x__xgafv: string, V1 error format.
445 Allowed values
446 1 - v1 error format
447 2 - v2 error format
448
449Returns:
450 An object of the form:
451
452 { # Response message for GameServerDeploymentsService.ListGameServerDeployments.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800453 &quot;gameServerDeployments&quot;: [ # The list of game server deployments.
454 { # A game server deployment resource.
455 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
456 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the game server delpoyment.
457 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
458 &quot;labels&quot;: { # The labels associated with this game server deployment. Each label is a key-value pair.
459 &quot;a_key&quot;: &quot;A String&quot;,
460 },
461 &quot;name&quot;: &quot;A String&quot;, # The resource name of the game server deployment, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment`.
462 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
463 },
464 ],
465 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
466 &quot;unreachable&quot;: [ # List of locations that could not be reached.
467 &quot;A String&quot;,
468 ],
469}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700470</div>
471
472<div class="method">
473 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
474 <pre>Retrieves the next page of results.
475
476Args:
477 previous_request: The request for the previous page. (required)
478 previous_response: The response from the request for the previous page. (required)
479
480Returns:
481 A request object that you can call &#x27;execute()&#x27; on to request the next
482 page. Returns None if there are no more items in the collection.
483 </pre>
484</div>
485
486<div class="method">
487 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
488 <pre>Patches a game server deployment.
489
490Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700491 name: string, The resource name of the game server deployment, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700492 body: object, The request body.
493 The object takes the form of:
494
495{ # A game server deployment resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800496 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
497 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the game server delpoyment.
498 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
499 &quot;labels&quot;: { # The labels associated with this game server deployment. Each label is a key-value pair.
500 &quot;a_key&quot;: &quot;A String&quot;,
501 },
502 &quot;name&quot;: &quot;A String&quot;, # The resource name of the game server deployment, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment`.
503 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
504}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700505
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800506 updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700507 x__xgafv: string, V1 error format.
508 Allowed values
509 1 - v1 error format
510 2 - v2 error format
511
512Returns:
513 An object of the form:
514
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700515 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800516 &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.
517 &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.
518 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
519 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
520 {
521 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
522 },
523 ],
524 &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.
525 },
526 &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.
527 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
528 },
529 &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}`.
530 &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`.
531 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
532 },
533}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700534</div>
535
536<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800537 <code class="details" id="previewRollout">previewRollout(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700538 <pre>Previews the game server deployment rollout. This API does not mutate the rollout resource.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700539
540Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700541 name: string, The resource name of the game server deployment rollout, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700542 body: object, The request body.
543 The object takes the form of:
544
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700545{ # The game server deployment rollout which represents the desired rollout state.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800546 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
547 &quot;defaultGameServerConfig&quot;: &quot;A String&quot;, # The default game server config is applied to all realms unless overridden in the rollout. For example, `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`.
548 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800549 &quot;gameServerConfigOverrides&quot;: [ # Contains the game server config rollout overrides. Overrides are processed in the order they are listed. Once a match is found for a realm, the rest of the list is not processed.
550 { # A game server config override.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800551 &quot;configVersion&quot;: &quot;A String&quot;, # The game server config for this override.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800552 &quot;realmsSelector&quot;: { # The realm selector, used to match realm resources. # Selector for choosing applicable realms.
553 &quot;realms&quot;: [ # List of realms to match.
554 &quot;A String&quot;,
555 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700556 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800557 },
558 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800559 &quot;name&quot;: &quot;A String&quot;, # The resource name of the game server deployment rollout, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800560 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
561}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700562
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700563 previewTime: string, Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed rollout completes.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800564 updateMask: string, Optional. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700565 x__xgafv: string, V1 error format.
566 Allowed values
567 1 - v1 error format
568 2 - v2 error format
569
570Returns:
571 An object of the form:
572
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700573 { # Response message for PreviewGameServerDeploymentRollout. This has details about the Agones fleet and autoscaler to be actuated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800574 &quot;etag&quot;: &quot;A String&quot;, # ETag of the game server deployment.
575 &quot;targetState&quot;: { # Encapsulates the Target state. # The target state.
576 &quot;details&quot;: [ # Details about Agones fleets.
577 { # Details about the Agones resources.
578 &quot;fleetDetails&quot;: [ # Agones fleet details for game server clusters and game server deployments.
579 { # Details of the target Agones fleet.
580 &quot;autoscaler&quot;: { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
581 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones autoscaler.
582 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
583 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
584 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800585 },
586 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800587 &quot;fleet&quot;: { # Target Agones fleet specification. # Reference to target Agones fleet.
588 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones fleet.
589 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
590 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
591 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
592 },
593 },
594 },
595 ],
596 &quot;gameServerClusterName&quot;: &quot;A String&quot;, # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
597 &quot;gameServerDeploymentName&quot;: &quot;A String&quot;, # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
598 },
599 ],
600 },
601 &quot;unavailable&quot;: [ # Locations that could not be reached on this request.
602 &quot;A String&quot;,
603 ],
604}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700605</div>
606
607<div class="method">
608 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700609 <pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700610
611Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700612 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700613 body: object, The request body.
614 The object takes the form of:
615
616{ # Request message for `SetIamPolicy` method.
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700617 &quot;policy&quot;: { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800618 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
619 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
620 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
621 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
622 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
623 &quot;A String&quot;,
624 ],
625 &quot;ignoreChildExemptions&quot;: True or False,
626 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800627 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800628 ],
629 &quot;exemptedMembers&quot;: [
630 &quot;A String&quot;,
631 ],
632 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
633 },
634 ],
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700635 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
636 { # Associates `members`, or principals, with a `role`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800637 &quot;bindingId&quot;: &quot;A String&quot;,
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700638 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800639 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
640 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
641 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
642 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800643 },
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700644 &quot;members&quot;: [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800645 &quot;A String&quot;,
646 ],
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700647 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800648 },
649 ],
650 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800651 &quot;rules&quot;: [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
652 { # A rule to be applied in a Policy.
653 &quot;action&quot;: &quot;A String&quot;, # Required
654 &quot;conditions&quot;: [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
655 { # A condition to be met.
656 &quot;iam&quot;: &quot;A String&quot;, # Trusted attributes supplied by the IAM system.
657 &quot;op&quot;: &quot;A String&quot;, # An operator to apply the subject with.
658 &quot;svc&quot;: &quot;A String&quot;, # Trusted attributes discharged by the service.
659 &quot;sys&quot;: &quot;A String&quot;, # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
660 &quot;values&quot;: [ # The objects of the condition.
661 &quot;A String&quot;,
662 ],
663 },
664 ],
665 &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the rule.
666 &quot;in&quot;: [ # If one or more &#x27;in&#x27; clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
667 &quot;A String&quot;,
668 ],
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700669 &quot;logConfig&quot;: [ # The config returned to callers of CheckPolicy for any entries that match the LOG action.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800670 { # Specifies what kind of log the caller must write
671 &quot;cloudAudit&quot;: { # Write a Cloud Audit log # Cloud audit options.
672 &quot;authorizationLoggingOptions&quot;: { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
673 &quot;permissionType&quot;: &quot;A String&quot;, # The type of the permission that was checked.
674 },
675 &quot;logName&quot;: &quot;A String&quot;, # The log_name to populate in the Cloud Audit Record.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800676 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800677 &quot;counter&quot;: { # Increment a streamz counter with the specified metric and field names. Metric names should start with a &#x27;/&#x27;, generally be lowercase-only, and end in &quot;_count&quot;. Field names should not contain an initial slash. The actual exported metric names will have &quot;/iam/policy&quot; prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - &quot;authority&quot;, which is &quot;[token]&quot; if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - &quot;iam_principal&quot;, a representation of IAMContext.principal even if a token or authority selector is present; or - &quot;&quot; (empty string), resulting in a counter with no fields. Examples: counter { metric: &quot;/debug_access_count&quot; field: &quot;iam_principal&quot; } ==&gt; increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]} # Counter options.
678 &quot;customFields&quot;: [ # Custom fields.
679 { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
680 &quot;name&quot;: &quot;A String&quot;, # Name is the field name.
681 &quot;value&quot;: &quot;A String&quot;, # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
682 },
683 ],
684 &quot;field&quot;: &quot;A String&quot;, # The field value to attribute.
685 &quot;metric&quot;: &quot;A String&quot;, # The metric to update.
686 },
687 &quot;dataAccess&quot;: { # Write a Data Access (Gin) log # Data access options.
688 &quot;logMode&quot;: &quot;A String&quot;,
689 },
690 },
691 ],
692 &quot;notIn&quot;: [ # If one or more &#x27;not_in&#x27; clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. The format for in and not_in entries can be found at in the Local IAM documentation (see go/local-iam#features).
693 &quot;A String&quot;,
694 ],
695 &quot;permissions&quot;: [ # A permission is a string of form &#x27;..&#x27; (e.g., &#x27;storage.buckets.list&#x27;). A value of &#x27;*&#x27; matches all permissions, and a verb part of &#x27;*&#x27; (e.g., &#x27;storage.buckets.*&#x27;) matches all verbs.
696 &quot;A String&quot;,
697 ],
698 },
699 ],
700 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
701 },
702 &quot;updateMask&quot;: &quot;A String&quot;, # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: &quot;bindings, etag&quot;`
703}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700704
705 x__xgafv: string, V1 error format.
706 Allowed values
707 1 - v1 error format
708 2 - v2 error format
709
710Returns:
711 An object of the form:
712
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700713 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { &quot;bindings&quot;: [ { &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;, &quot;members&quot;: [ &quot;user:mike@example.com&quot;, &quot;group:admins@example.com&quot;, &quot;domain:google.com&quot;, &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot; ] }, { &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;, &quot;members&quot;: [ &quot;user:eve@example.com&quot; ], &quot;condition&quot;: { &quot;title&quot;: &quot;expirable access&quot;, &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;, &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;, } } ], &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;, &quot;version&quot;: 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;) etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800714 &quot;auditConfigs&quot;: [ # Specifies cloud audit logging configuration for this policy.
715 { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { &quot;audit_configs&quot;: [ { &quot;service&quot;: &quot;allServices&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; }, { &quot;log_type&quot;: &quot;ADMIN_READ&quot; } ] }, { &quot;service&quot;: &quot;sampleservice.googleapis.com&quot;, &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot; }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot;, &quot;exempted_members&quot;: [ &quot;user:aliya@example.com&quot; ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
716 &quot;auditLogConfigs&quot;: [ # The configuration for logging of each type of permission.
717 { # Provides the configuration for logging a type of permissions. Example: { &quot;audit_log_configs&quot;: [ { &quot;log_type&quot;: &quot;DATA_READ&quot;, &quot;exempted_members&quot;: [ &quot;user:jose@example.com&quot; ] }, { &quot;log_type&quot;: &quot;DATA_WRITE&quot; } ] } This enables &#x27;DATA_READ&#x27; and &#x27;DATA_WRITE&#x27; logging, while exempting jose@example.com from DATA_READ logging.
718 &quot;exemptedMembers&quot;: [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
719 &quot;A String&quot;,
720 ],
721 &quot;ignoreChildExemptions&quot;: True or False,
722 &quot;logType&quot;: &quot;A String&quot;, # The log type that this config enables.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800723 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800724 ],
725 &quot;exemptedMembers&quot;: [
726 &quot;A String&quot;,
727 ],
728 &quot;service&quot;: &quot;A String&quot;, # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.
729 },
730 ],
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700731 &quot;bindings&quot;: [ # Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.
732 { # Associates `members`, or principals, with a `role`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800733 &quot;bindingId&quot;: &quot;A String&quot;,
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700734 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800735 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
736 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
737 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
738 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800739 },
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700740 &quot;members&quot;: [ # Specifies the principals requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800741 &quot;A String&quot;,
742 ],
yoshi-code-bota41c7b92021-11-02 00:26:17 -0700743 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800744 },
745 ],
746 &quot;etag&quot;: &quot;A String&quot;, # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800747 &quot;rules&quot;: [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.
748 { # A rule to be applied in a Policy.
749 &quot;action&quot;: &quot;A String&quot;, # Required
750 &quot;conditions&quot;: [ # Additional restrictions that must be met. All conditions must pass for the rule to match.
751 { # A condition to be met.
752 &quot;iam&quot;: &quot;A String&quot;, # Trusted attributes supplied by the IAM system.
753 &quot;op&quot;: &quot;A String&quot;, # An operator to apply the subject with.
754 &quot;svc&quot;: &quot;A String&quot;, # Trusted attributes discharged by the service.
755 &quot;sys&quot;: &quot;A String&quot;, # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
756 &quot;values&quot;: [ # The objects of the condition.
757 &quot;A String&quot;,
758 ],
759 },
760 ],
761 &quot;description&quot;: &quot;A String&quot;, # Human-readable description of the rule.
762 &quot;in&quot;: [ # If one or more &#x27;in&#x27; clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.
763 &quot;A String&quot;,
764 ],
yoshi-code-botad81f3d2021-09-28 00:22:30 -0700765 &quot;logConfig&quot;: [ # The config returned to callers of CheckPolicy for any entries that match the LOG action.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800766 { # Specifies what kind of log the caller must write
767 &quot;cloudAudit&quot;: { # Write a Cloud Audit log # Cloud audit options.
768 &quot;authorizationLoggingOptions&quot;: { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.
769 &quot;permissionType&quot;: &quot;A String&quot;, # The type of the permission that was checked.
770 },
771 &quot;logName&quot;: &quot;A String&quot;, # The log_name to populate in the Cloud Audit Record.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800772 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800773 &quot;counter&quot;: { # Increment a streamz counter with the specified metric and field names. Metric names should start with a &#x27;/&#x27;, generally be lowercase-only, and end in &quot;_count&quot;. Field names should not contain an initial slash. The actual exported metric names will have &quot;/iam/policy&quot; prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - &quot;authority&quot;, which is &quot;[token]&quot; if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - &quot;iam_principal&quot;, a representation of IAMContext.principal even if a token or authority selector is present; or - &quot;&quot; (empty string), resulting in a counter with no fields. Examples: counter { metric: &quot;/debug_access_count&quot; field: &quot;iam_principal&quot; } ==&gt; increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]} # Counter options.
774 &quot;customFields&quot;: [ # Custom fields.
775 { # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.
776 &quot;name&quot;: &quot;A String&quot;, # Name is the field name.
777 &quot;value&quot;: &quot;A String&quot;, # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.
778 },
779 ],
780 &quot;field&quot;: &quot;A String&quot;, # The field value to attribute.
781 &quot;metric&quot;: &quot;A String&quot;, # The metric to update.
782 },
783 &quot;dataAccess&quot;: { # Write a Data Access (Gin) log # Data access options.
784 &quot;logMode&quot;: &quot;A String&quot;,
785 },
786 },
787 ],
788 &quot;notIn&quot;: [ # If one or more &#x27;not_in&#x27; clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries. The format for in and not_in entries can be found at in the Local IAM documentation (see go/local-iam#features).
789 &quot;A String&quot;,
790 ],
791 &quot;permissions&quot;: [ # A permission is a string of form &#x27;..&#x27; (e.g., &#x27;storage.buckets.list&#x27;). A value of &#x27;*&#x27; matches all permissions, and a verb part of &#x27;*&#x27; (e.g., &#x27;storage.buckets.*&#x27;) matches all verbs.
792 &quot;A String&quot;,
793 ],
794 },
795 ],
796 &quot;version&quot;: 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
797}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700798</div>
799
800<div class="method">
801 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700802 <pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may &quot;fail open&quot; without warning.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700803
804Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700805 resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700806 body: object, The request body.
807 The object takes the form of:
808
809{ # Request message for `TestIamPermissions` method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800810 &quot;permissions&quot;: [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
811 &quot;A String&quot;,
812 ],
813}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700814
815 x__xgafv: string, V1 error format.
816 Allowed values
817 1 - v1 error format
818 2 - v2 error format
819
820Returns:
821 An object of the form:
822
823 { # Response message for `TestIamPermissions` method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800824 &quot;permissions&quot;: [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
825 &quot;A String&quot;,
826 ],
827}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700828</div>
829
830<div class="method">
831 <code class="details" id="updateRollout">updateRollout(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700832 <pre>Patches a single game server deployment rollout. The method will not return an error if the update does not affect any existing realms. For example - if the default_game_server_config is changed but all existing realms use the override, that is valid. Similarly, if a non existing realm is explicitly called out in game_server_config_overrides field, that will also not result in an error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700833
834Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700835 name: string, The resource name of the game server deployment rollout, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700836 body: object, The request body.
837 The object takes the form of:
838
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700839{ # The game server deployment rollout which represents the desired rollout state.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800840 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
841 &quot;defaultGameServerConfig&quot;: &quot;A String&quot;, # The default game server config is applied to all realms unless overridden in the rollout. For example, `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`.
842 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800843 &quot;gameServerConfigOverrides&quot;: [ # Contains the game server config rollout overrides. Overrides are processed in the order they are listed. Once a match is found for a realm, the rest of the list is not processed.
844 { # A game server config override.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800845 &quot;configVersion&quot;: &quot;A String&quot;, # The game server config for this override.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800846 &quot;realmsSelector&quot;: { # The realm selector, used to match realm resources. # Selector for choosing applicable realms.
847 &quot;realms&quot;: [ # List of realms to match.
848 &quot;A String&quot;,
849 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700850 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800851 },
852 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800853 &quot;name&quot;: &quot;A String&quot;, # The resource name of the game server deployment rollout, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`. For example, `projects/my-project/locations/global/gameServerDeployments/my-deployment/rollout`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800854 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
855}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700856
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800857 updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700858 x__xgafv: string, V1 error format.
859 Allowed values
860 1 - v1 error format
861 2 - v2 error format
862
863Returns:
864 An object of the form:
865
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700866 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800867 &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.
868 &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.
869 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
870 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
871 {
872 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
873 },
874 ],
875 &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.
876 },
877 &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.
878 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
879 },
880 &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}`.
881 &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`.
882 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
883 },
884}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700885</div>
886
887</body></html>