Blame - docs/dyn/gameservices_v1.projects.locations.gameServerDeployments.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame]

83

<code><a href="#close">close()</a></code></p>

84

<p class="firstline">Close httplib2 connections.</p>

85

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

86

<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

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

92

<code><a href="#fetchDeploymentState">fetchDeploymentState(name, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

93

<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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

94

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

98

<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

99

<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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

100

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

104

<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

105

<p class="firstline">Lists game server deployments in a given project and location.</p>

106

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

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

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

113

<code><a href="#previewRollout">previewRollout(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

114

<p class="firstline">Previews the game server deployment rollout. This API does not mutate the rollout resource.</p>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

115

116

<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

117

<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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

118

119

<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

120

<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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

121

122

<code><a href="#updateRollout">updateRollout(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

123

<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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

124

<h3>Method Details</h3>

125

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

126

<code class="details" id="close">close()</code>

127

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

131

<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

134

Args:

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

135

parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

136

body: object, The request body.

137

The object takes the form of:

138

139

{ # A game server deployment resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

140

"createTime": "A String", # Output only. The creation time.

141

"description": "A String", # Human readable description of the game server delpoyment.

142

"etag": "A String", # ETag of the resource.

143

"labels": { # The labels associated with this game server deployment. Each label is a key-value pair.

144

"a_key": "A String",

145

},

146

"name": "A 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`.

147

"updateTime": "A String", # Output only. The last-modified time.

148

}

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

149

150

deploymentId: string, Required. The ID of the game server delpoyment resource to be created.

151

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

158

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

159

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

160

"done": 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

"error": { # 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

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

163

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

164

{

165

"a_key": "", # Properties of the object. Contains field @type with type URL.

166

},

167

],

168

"message": "A String", # 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

"metadata": { # 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

"a_key": "", # Properties of the object. Contains field @type with type URL.

172

},

173

"name": "A String", # 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

"response": { # 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

"a_key": "", # Properties of the object. Contains field @type with type URL.

176

},

177

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

182

<pre>Deletes a single game server deployment.

183

184

Args:

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

185

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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

186

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

193

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

194

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

195

"done": 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

"error": { # 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

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

198

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

199

{

200

"a_key": "", # Properties of the object. Contains field @type with type URL.

201

},

202

],

203

"message": "A String", # 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

"metadata": { # 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

"a_key": "", # Properties of the object. Contains field @type with type URL.

207

},

208

"name": "A String", # 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

"response": { # 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

"a_key": "", # Properties of the object. Contains field @type with type URL.

211

},

212

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="fetchDeploymentState">fetchDeploymentState(name, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

217

<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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

218

219

Args:

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

220

name: string, Required. The name of the game server delpoyment, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

221

body: object, The request body.

222

The object takes the form of:

223

224

{ # Request message for GameServerDeploymentsService.FetchDeploymentState.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

225

}

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

226

227

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

234

235

{ # Response message for GameServerDeploymentsService.FetchDeploymentState.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

236

"clusterState": [ # 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

"cluster": "A String", # The name of the cluster.

239

"fleetDetails": [ # The details about the Agones fleets and autoscalers created in the game server cluster.

240

{ # Details of the deployed Agones fleet.

241

"deployedAutoscaler": { # Details about the Agones autoscaler. # Information about the Agones autoscaler for that fleet.

242

"autoscaler": "A String", # The name of the Agones autoscaler.

243

"fleetAutoscalerSpec": "A String", # The autoscaler spec retrieved from Agones.

244

"specSource": { # 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

"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

246

"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

247

},

248

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

249

"deployedFleet": { # Agones fleet specification and details. # Information about the Agones fleet.

250

"fleet": "A String", # The name of the Agones fleet.

251

"fleetSpec": "A String", # The fleet spec retrieved from the Agones fleet.

252

"specSource": { # 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

"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

254

"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.

255

},

256

"status": { # 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

"allocatedReplicas": "A String", # The number of GameServer replicas in the ALLOCATED state in this fleet.

258

"readyReplicas": "A String", # The number of GameServer replicas in the READY state in this fleet.

259

"replicas": "A String", # The total number of current GameServer replicas in this fleet.

260

"reservedReplicas": "A String", # The number of GameServer replicas in the RESERVED state in this fleet. Reserved instances won't be deleted on scale down, but won't cause an autoscaler to scale up.

},

},

},

],

},

],

"unavailable": [ # List of locations that could not be reached.

268

"A String",

269

],

270

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

275

<pre>Gets details of a single game server deployment.

276

277

Args:

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

278

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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

279

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

286

287

{ # A game server deployment resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

288

"createTime": "A String", # Output only. The creation time.

289

"description": "A String", # Human readable description of the game server delpoyment.

290

"etag": "A String", # ETag of the resource.

291

"labels": { # The labels associated with this game server deployment. Each label is a key-value pair.

292

"a_key": "A String",

293

},

294

"name": "A 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`.

295

"updateTime": "A String", # Output only. The last-modified time.

296

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

301

<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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

302

303

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

304

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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

306

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

313

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

314

{ # 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` to a single `role`. Members 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:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 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 < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

315

"auditConfigs": [ # 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: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } 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

"auditLogConfigs": [ # The configuration for logging of each type of permission.

318

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

319

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

320

"A String",

321

],

322

"ignoreChildExemptions": True or False,

323

"logType": "A String", # The log type that this config enables.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

324

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

],

"exemptedMembers": [

"A String",

],

"service": "A String", # 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

],

332

"bindings": [ # Associates a list of `members` to 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 member.

333

{ # Associates `members` with a `role`.

334

"bindingId": "A String",

335

"condition": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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 members 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).

336

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

337

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

338

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

339

"title": "A String", # 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 Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

340

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

341

"members": [ # Specifies the identities 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`.

342

"A String",

343

],

344

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

345

},

346

],

347

"etag": "A String", # `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.

348

"iamOwned": True or False,

349

"rules": [ # 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.

350

{ # A rule to be applied in a Policy.

351

"action": "A String", # Required

352

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

353

{ # A condition to be met.

354

"iam": "A String", # Trusted attributes supplied by the IAM system.

355

"op": "A String", # An operator to apply the subject with.

356

"svc": "A String", # Trusted attributes discharged by the service.

357

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

358

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

364

"in": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

365

"A String",

366

],

367

"logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

368

{ # Specifies what kind of log the caller must write

369

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

370

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

371

"permissionType": "A String", # The type of the permission that was checked.

372

},

373

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

374

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

375

"counter": { # Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]} # Counter options.

376

"customFields": [ # Custom fields.

377

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

378

"name": "A String", # Name is the field name.

379

"value": "A String", # 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.

380

},

381

],

382

"field": "A String", # The field value to attribute.

383

"metric": "A String", # The metric to update.

384

},

385

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

386

"logMode": "A String",

},

},

],

"notIn": [ # If one or more 'not_in' 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).

391

"A String",

392

],

393

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 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).

399

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="getRollout">getRollout(name, x__xgafv=None)</code>

404

<pre>Gets details a single game server deployment rollout.

405

406

Args:

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

407

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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

408

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

415

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

416

{ # The game server deployment rollout which represents the desired rollout state.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

417

"createTime": "A String", # Output only. The creation time.

418

"defaultGameServerConfig": "A String", # 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`.

419

"etag": "A String", # ETag of the resource.

420

"gameServerConfigOverrides": [ # 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.

421

{ # A game server config override.

422

"configVersion": "A String", # The game server config for this override.

423

"realmsSelector": { # The realm selector, used to match realm resources. # Selector for choosing applicable realms.

424

"realms": [ # List of realms to match.

425

"A String",

426

],

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

427

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

428

},

429

],

430

"name": "A 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`.

431

"updateTime": "A String", # Output only. The last-modified time.

432

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

436

<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

437

<pre>Lists game server deployments in a given project and location.

438

439

Args:

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

440

parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{location}`. (required)

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

441

filter: string, Optional. The filter to apply to list results.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

442

orderBy: string, Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

443

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's next_page_token to determine if there are more GameServerDeployments left to be queried.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

444

pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

445

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

452

453

{ # Response message for GameServerDeploymentsService.ListGameServerDeployments.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

454

"gameServerDeployments": [ # The list of game server deployments.

455

{ # A game server deployment resource.

456

"createTime": "A String", # Output only. The creation time.

457

"description": "A String", # Human readable description of the game server delpoyment.

458

"etag": "A String", # ETag of the resource.

459

"labels": { # The labels associated with this game server deployment. Each label is a key-value pair.

460

"a_key": "A String",

461

},

462

"name": "A 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`.

463

"updateTime": "A String", # Output only. The last-modified time.

464

},

465

],

466

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.

467

"unreachable": [ # List of locations that could not be reached.

468

"A String",

469

],

470

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

475

<pre>Retrieves the next page of results.

476

477

Args:

478

previous_request: The request for the previous page. (required)

479

previous_response: The response from the request for the previous page. (required)

480

481

Returns:

482

A request object that you can call 'execute()' on to request the next

483

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

489

<pre>Patches a game server deployment.

490

491

Args:

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

492

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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

493

body: object, The request body.

494

The object takes the form of:

495

496

{ # A game server deployment resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

497

"createTime": "A String", # Output only. The creation time.

498

"description": "A String", # Human readable description of the game server delpoyment.

499

"etag": "A String", # ETag of the resource.

500

"labels": { # The labels associated with this game server deployment. Each label is a key-value pair.

501

"a_key": "A String",

502

},

503

"name": "A 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`.

504

"updateTime": "A String", # Output only. The last-modified time.

505

}

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

506

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

507

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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

508

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

515

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

516

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

517

"done": 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.

518

"error": { # 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.

519

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

520

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

521

{

522

"a_key": "", # Properties of the object. Contains field @type with type URL.

523

},

524

],

525

"message": "A String", # 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.

526

},

527

"metadata": { # 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.

528

"a_key": "", # Properties of the object. Contains field @type with type URL.

529

},

530

"name": "A String", # 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}`.

531

"response": { # 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`.

532

"a_key": "", # Properties of the object. Contains field @type with type URL.

533

},

534

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

538

<code class="details" id="previewRollout">previewRollout(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

539

<pre>Previews the game server deployment rollout. This API does not mutate the rollout resource.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

540

541

Args:

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

542

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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

543

body: object, The request body.

544

The object takes the form of:

545

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

546

{ # The game server deployment rollout which represents the desired rollout state.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

547

"createTime": "A String", # Output only. The creation time.

548

"defaultGameServerConfig": "A String", # 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`.

549

"etag": "A String", # ETag of the resource.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

550

"gameServerConfigOverrides": [ # 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.

551

{ # A game server config override.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

552

"configVersion": "A String", # The game server config for this override.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

553

"realmsSelector": { # The realm selector, used to match realm resources. # Selector for choosing applicable realms.

554

"realms": [ # List of realms to match.

555

"A String",

556

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

557

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

558

},

559

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

560

"name": "A 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`.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

561

"updateTime": "A String", # Output only. The last-modified time.

562

}

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

563

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

564

previewTime: string, Optional. The target timestamp to compute the preview. Defaults to the immediately after the proposed rollout completes.

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

565

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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

566

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

573

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

574

{ # Response message for PreviewGameServerDeploymentRollout. This has details about the Agones fleet and autoscaler to be actuated.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

575

"etag": "A String", # ETag of the game server deployment.

576

"targetState": { # Encapsulates the Target state. # The target state.

577

"details": [ # Details about Agones fleets.

578

{ # Details about the Agones resources.

579

"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.

580

{ # Details of the target Agones fleet.

581

"autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.

582

"name": "A String", # The name of the Agones autoscaler.

583

"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.

584

"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

585

"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

586

},

587

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

588

"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.

589

"name": "A String", # The name of the Agones fleet.

590

"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.

591

"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

592

"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.

},

},

},

],

"gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

598

"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.

},

],

},

"unavailable": [ # Locations that could not be reached on this request.

603

"A String",

604

],

605

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

610

<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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

611

612

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

613

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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

614

body: object, The request body.

615

The object takes the form of:

616

617

{ # Request message for `SetIamPolicy` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

618

"policy": { # 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` to a single `role`. Members 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:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 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 < timestamp('2020-10-01T00:00:00.000Z') - 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.

619

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

620

{ # 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: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } 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.

621

"auditLogConfigs": [ # The configuration for logging of each type of permission.

622

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

623

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

624

"A String",

625

],

626

"ignoreChildExemptions": True or False,

627

"logType": "A String", # The log type that this config enables.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

628

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

],

"exemptedMembers": [

"A String",

],

"service": "A String", # 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.

634

},

635

],

636

"bindings": [ # Associates a list of `members` to 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 member.

637

{ # Associates `members` with a `role`.

638

"bindingId": "A String",

639

"condition": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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 members 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).

640

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

641

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

642

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

643

"title": "A String", # 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 Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

644

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

645

"members": [ # Specifies the identities 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`.

646

"A String",

647

],

648

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

649

},

650

],

651

"etag": "A String", # `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.

652

"iamOwned": True or False,

653

"rules": [ # 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.

654

{ # A rule to be applied in a Policy.

655

"action": "A String", # Required

656

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

657

{ # A condition to be met.

658

"iam": "A String", # Trusted attributes supplied by the IAM system.

659

"op": "A String", # An operator to apply the subject with.

660

"svc": "A String", # Trusted attributes discharged by the service.

661

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

662

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

668

"in": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

669

"A String",

670

],

671

"logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

672

{ # Specifies what kind of log the caller must write

673

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

674

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

675

"permissionType": "A String", # The type of the permission that was checked.

676

},

677

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

678

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

679

"counter": { # Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]} # Counter options.

680

"customFields": [ # Custom fields.

681

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

682

"name": "A String", # Name is the field name.

683

"value": "A String", # 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.

684

},

685

],

686

"field": "A String", # The field value to attribute.

687

"metric": "A String", # The metric to update.

688

},

689

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

690

"logMode": "A String",

},

},

],

"notIn": [ # If one or more 'not_in' 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).

695

"A String",

696

],

697

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 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).

703

},

704

"updateMask": "A String", # 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: "bindings, etag"`

705

}

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

706

707

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

714

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

715

{ # 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` to a single `role`. Members 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:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 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 < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

716

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

717

{ # 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: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } 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.

718

"auditLogConfigs": [ # The configuration for logging of each type of permission.

719

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

720

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

721

"A String",

722

],

723

"ignoreChildExemptions": True or False,

724

"logType": "A String", # The log type that this config enables.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

725

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

],

"exemptedMembers": [

"A String",

],

"service": "A String", # 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.

731

},

732

],

733

"bindings": [ # Associates a list of `members` to 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 member.

734

{ # Associates `members` with a `role`.

735

"bindingId": "A String",

736

"condition": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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 members 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).

737

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

738

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

739

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

740

"title": "A String", # 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 Bot

2020-11-24 15:48:03 -0800

[diff] [blame]

741

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

742

"members": [ # Specifies the identities 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`.

743

"A String",

744

],

745

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

746

},

747

],

748

"etag": "A String", # `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.

749

"iamOwned": True or False,

750

"rules": [ # 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.

751

{ # A rule to be applied in a Policy.

752

"action": "A String", # Required

753

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

754

{ # A condition to be met.

755

"iam": "A String", # Trusted attributes supplied by the IAM system.

756

"op": "A String", # An operator to apply the subject with.

757

"svc": "A String", # Trusted attributes discharged by the service.

758

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

759

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

765

"in": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

766

"A String",

767

],

768

"logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

769

{ # Specifies what kind of log the caller must write

770

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

771

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

772

"permissionType": "A String", # The type of the permission that was checked.

773

},

774

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

775

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

776

"counter": { # Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]} # Counter options.

777

"customFields": [ # Custom fields.

778

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

779

"name": "A String", # Name is the field name.

780

"value": "A String", # 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.

781

},

782

],

783

"field": "A String", # The field value to attribute.

784

"metric": "A String", # The metric to update.

785

},

786

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

787

"logMode": "A String",

},

},

],

"notIn": [ # If one or more 'not_in' 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).

792

"A String",

793

],

794

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 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).

800

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

805

<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 "fail open" without warning.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

806

807

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

808

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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

809

body: object, The request body.

810

The object takes the form of:

811

812

{ # Request message for `TestIamPermissions` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

813

"permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

814

"A String",

815

],

816

}

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

817

818

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

825

826

{ # Response message for `TestIamPermissions` method.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

827

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

828

"A String",

829

],

830

}</pre>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

</div>

<code class="details" id="updateRollout">updateRollout(name, body=None, updateMask=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

835

<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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

836

837

Args:

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

838

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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

839

body: object, The request body.

840

The object takes the form of:

841

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

842

{ # The game server deployment rollout which represents the desired rollout state.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

843

"createTime": "A String", # Output only. The creation time.

844

"defaultGameServerConfig": "A String", # 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`.

845

"etag": "A String", # ETag of the resource.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

846

"gameServerConfigOverrides": [ # 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.

847

{ # A game server config override.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

848

"configVersion": "A String", # The game server config for this override.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

849

"realmsSelector": { # The realm selector, used to match realm resources. # Selector for choosing applicable realms.

850

"realms": [ # List of realms to match.

851

"A String",

852

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

853

},

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

854

},

855

],

Yoshi Automation Bot

2020-12-09 08:56:03 -0800

[diff] [blame]

856

"name": "A 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`.

Yoshi Automation Bot

2020-11-26 17:16:03 -0800

[diff] [blame]

857

"updateTime": "A String", # Output only. The last-modified time.

858

}

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

859

yoshi-code-bot

b6dc1b9

2021-03-02 11:49:08 -0800

[diff] [blame]

860

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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

861

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

868

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

869

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

870

"done": 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.

871

"error": { # 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.

872

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

873

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

874

{

875

"a_key": "", # Properties of the object. Contains field @type with type URL.

876

},

877

],

878

"message": "A String", # 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.

879

},

880

"metadata": { # 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.

881

"a_key": "", # Properties of the object. Contains field @type with type URL.

882

},

883

"name": "A String", # 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}`.

884

"response": { # 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`.

885

"a_key": "", # Properties of the object. Contains field @type with type URL.

886

},

887

}</pre>

Bu Sun Kim